CompiledCodeFunction
is a function created by FunctionCompile that contains compiled code that is run when the CompiledCodeFunction is applied to suitable arguments.
Details
- CompiledCodeFunction objects typically accept only arguments that conform to specified types.
- If nonconforming arguments are provided, CompiledCodeFunction returns a Failure object.
- FunctionCompileExport and related functions can be used to generate code suitable for external use from CompiledCodeFunction[…].
- CompiledCodeFunction objects can include embedded libraries or byte code to optimize loading.
- Information for a CompiledCodeFunction may include the following properties:
-
"ArgumentTypes" types of arguments "LLVMBinary" LLVM binary code "ReturnType" return type "Type" full type
Examples
open all close allBasic Examples (1)
FunctionCompile creates a CompiledCodeFunction:
cf = FunctionCompile[Function[Typed[arg, "MachineInteger"], arg + 1]]The CompiledCodeFunction evaluates with an argument of the correct type:
cf[20]Information returns information about a CompiledCodeFunction:
Information[cf]Extract just the type signature for the function:
Information[cf, "Type"]Scope (3)
A CompiledCodeFunction contains information about how it was created, which can enable loading from a file. By default, platform-dependent byte code is included:
cf = FunctionCompile[Function[Typed[arg, "Integer64"], arg + 1]];cf//InputFormIf a CompiledCodeFunction is written to a file and loaded, a new functioning CompiledCodeFunction is created. If byte code is found that matches the current platform, that will be used:
cf>>comp.wl;
cf1 = <<comp.wlThe restored CompiledCodeFunction works as expected:
cf1[10]Platform-dependent byte code can be created for a range of platforms. This can be used if the CompiledCodeFunction was loaded into a different system:
cf = FunctionCompile[Function[Typed[arg, "Integer64"], arg + 1], TargetSystem -> All];
Information[cf, "LLVMBinary"]A shared library can be embedded in the output:
cf = FunctionCompile[Function[Typed[arg, "Integer64"], arg + 1], UseEmbeddedLibrary -> True];
cf[[1]]["EmbeddedLibraries"]The library will be used when the code function is loaded from a file. This makes loading faster:
cf>>comp.wl;
cf1 = <<comp.wlThe restored CompiledCodeFunction works as expected:
cf1[10]Text
Wolfram Research (2019), CompiledCodeFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/CompiledCodeFunction.html.
CMS
Wolfram Language. 2019. "CompiledCodeFunction." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/CompiledCodeFunction.html.
APA
Wolfram Language. (2019). CompiledCodeFunction. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/CompiledCodeFunction.html