[#llvm-getIntDivCycle]
= xref:llvm.adoc[llvm]::getIntDivCycle
:relfileprefix: ../
:mrdocs:

Return the outermost cycle made divergent by branch inside it.

== Synopsis

Declared in `<llvm/ADT/GenericUniformityImpl.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename ContextT,
    typename CycleInfoT,
    typename BlockT,
    typename DominatorTreeT>
xref:llvm/CycleRef.adoc[CycleRef]
getIntDivCycle(
    CycleInfoT const& CI,
    xref:llvm/CycleRef.adoc[CycleRef] Cycle,
    BlockT const* DivTermBlock,
    BlockT const* JoinBlock,
    DominatorTreeT const& DT,
    ContextT& Context);
----

== Description

This checks the "diverged entry" criterion defined in the docs/ConvergenceAnalysis.html.

== Return Value

Outermost cycle made divergent by an internal branch, or null if none.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *CI*
| Cycle information for the function.
| *Cycle*
| Cycle containing `JoinBlock` to expand from.
| *DivTermBlock*
| Block of the divergent terminator inside the cycle nest.
| *JoinBlock*
| Block where diverged paths join.
| *DT*
| Dominator tree used to test header domination.
| *Context*
| SSA context used for debug printing.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#