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

Add runtime checks that compare pointer differences against a distance.

== Synopsis

Declared in `<llvm/Transforms/Utils/LoopUtils.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:llvm/Value.adoc[Value]*
addDiffRuntimeChecks(
    xref:llvm/Instruction.adoc[Instruction]* Loc,
    xref:llvm/ArrayRef-08.adoc[ArrayRef<PointerDiffInfo>] Checks,
    xref:llvm/SCEVExpander.adoc[SCEVExpander]& Expander,
    xref:llvm/ElementCount.adoc[ElementCount] VF,
    unsigned int IC);
----

== Return Value

The final comparator value, or nullptr if no check is needed.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *Loc*
| Insertion point for the runtime checks.
| *Checks*
| Pointer‐difference descriptors to validate.
| *Expander*
| SCEV expander used to materialize addresses.
| *VF*
| Vectorization factor used when scaling the distance.
| *IC*
| Interleave count used when scaling the distance.
|===


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