[#llvm-createFunctionToLoopPassAdaptor-0c]
= xref:llvm.adoc[llvm]::createFunctionToLoopPassAdaptor
:relfileprefix: ../
:mrdocs:

A function to deduce a loop pass type and wrap it in the templated adaptor.

== Synopsis

Declared in `<llvm/Transforms/Scalar/LoopPassManager.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename LoopPassT>
xref:llvm/FunctionToLoopPassAdaptor.adoc[FunctionToLoopPassAdaptor]
createFunctionToLoopPassAdaptor(
    LoopPassT&& Pass,
    bool UseMemorySSA = false);
----

== Description

If `Pass` is a loop pass, the returned adaptor will be in loop mode.

If `Pass` is a loop‐nest pass, `Pass` will first be wrapped into a `LoopPassManager` and the returned adaptor will be in loop‐nest mode.

== Specializations

[cols="1,4"]
|===
| Name| Description
| xref:llvm/createFunctionToLoopPassAdaptor-01f.adoc[`createFunctionToLoopPassAdaptor<PassManager<LoopStandardAnalysisResults&, LPMUpdater&>>`] 
| If `Pass` is an instance of `LoopPassManager,` the returned adaptor will be in loop‐nest mode if the pass manager contains only loop‐nest passes.
|===


== Return Value

A function‐to‐loop adaptor wrapping `Pass.`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *Pass*
| Loop or loop‐nest pass to wrap in the adaptor.
| *UseMemorySSA*
| Whether the adaptor should enable MemorySSA.
|===


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