BuildCompiledComponent
BuildCompiledComponent[comp]
builds the compiled component comp.
BuildCompiledComponent[comp,dest]
builds the compiled component comp, placing the result in dest.
Details and Options
- Compiled components can be used to represent a named group of compiler declarations.
- Compiled components can be used to represent compiled functionality that can be built into a shared library.
- Compiled components can be embedded in paclets.
- comp can be given as a CompiledComponent object or a string with the name of a compiled component.
- A compiled component is created by DeclareCompiledComponent.
- Typically, building a component with BuildCompiledComponent involves creating a shared library including compiled versions of the library functions and installed functions from the target component.
- A library built by BuildCompiledComponent can be loaded with LoadCompiledComponent.
- If no destination is set for BuildCompiledComponent, the library goes into "$UserBaseDirectory/SystemFiles/LibraryResources/$SystemID".
- The destination for BuildCompiledComponent can be a file path given as a string or using a File object.
- The destination for BuildCompiledComponent can be PacletObject, which places the library into "LibraryResources/$SystemID" inside the paclet.
- The following options can be given:
-
CompilerEnvironment Automatic a compiler environment that by default includes the declarations in the component CompilerOptions Automatic options to control the compilation CreateIntermediateDirectories Automatic whether to create intermediate directories in the destination path ProgressReporting Automatic how to report progress during the compilation
Examples
open all close allBasic Examples (1)
DeclareCompiledComponent["demoComp", "LibraryFunctions" -> <|
"square" -> Function[{Typed[arg, "Real64"]}, arg ^ 2]
|>];BuildCompiledComponent["demoComp"]res = LoadCompiledComponent["demoComp"]Call the function included in the built component:
res["LibraryFunctions"]["square"][10.5]Scope (1)
Declare a list of declarations in a component:
DeclareCompiledComponent["fullComponent", {
FunctionDeclaration[return12, Typed[{} -> "MachineInteger"]@Function[{}, 12]],
FunctionDeclaration[addtwo, Typed[{"MachineInteger"} -> "MachineInteger"]@Function[x, x + 2]]
}];DeclareCompiledComponent["fullComponent", "LibraryFunctions" -> <|
"libFunc" -> Function[Typed[arg, "Real64"], Sqrt[arg]]
|>];Declare an installed function:
DeclareCompiledComponent["fullComponent", "InstalledFunctions" -> addtwo];BuildCompiledComponent["fullComponent"]Use an installed function to automatically load the build:
addtwo[3]Explicitly load the component to access the built library function:
LoadCompiledComponent["fullComponent"]Options (4)
CompilerOptions (1)
DeclareCompiledComponent["optComponent", "LibraryFunctions" -> <|"square" -> Function[{Typed[x, "Real64"]}, x * x]|>]Build the component with additional compiler options:
BuildCompiledComponent["optComponent", CompilerOptions -> {"TraceFunction" -> Echo}]CompilerEnvironment (1)
Create a new compiler environment and append definitions to it:
compEnv = CreateCompilerEnvironment[];
CompilerEnvironmentAppendTo[
compEnv,
FunctionDeclaration[add42, Typed[{"MachineInteger"} -> "MachineInteger"]@Function[x, x + 42]]
]Declare a function inside a compiled component that refers to this compiler environment:
DeclareCompiledComponent["environmentComponent", "LibraryFunctions" -> <|
"add42" -> Function[{Typed[x, "MachineInteger"]}, add42[x]]
|>]BuildCompiledComponent["environmentComponent", CompilerEnvironment -> compEnv]Load the component and run the library function:
loadedComp = LoadCompiledComponent["environmentComponent"];
loadedComp["LibraryFunctions", "add42"][10]CreateIntermediateDirectories (1)
Declare a simple compiled component:
DeclareCompiledComponent["demoCreateDirs", "LibraryFunctions" -> <|"cube" -> Function[{Typed[x, "Real64"]}, x ^ 3]|>
]Define a nested build directory that does not exist:
buildDir = FileNameJoin[{$TemporaryDirectory, "compiled", "components", "nested"}]Building without creating intermediate directories fails:
BuildCompiledComponent["demoCreateDirs", buildDir, CreateIntermediateDirectories -> False]
Allow automatic creation of missing parent directories:
BuildCompiledComponent["demoCreateDirs", buildDir, CreateIntermediateDirectories -> True]ProgressReporting (1)
Progress during a compilation is reported:
DeclareCompiledComponent["progressComponent", "LibraryFunctions" -> <|
"libFunc" -> Function[{Typed[s, "String"]}, ToCharacterCode[s]]
|>];
BuildCompiledComponent["progressComponent"][image]This can be suppressed by setting the option ProgressReporting to False:
BuildCompiledComponent["progressComponent", ProgressReporting -> False]The default value of ProgressReporting is Automatic, which means that the global setting $ProgressReporting is used. If this is set to False, then no progress reporting takes place.
Text
Wolfram Research (2022), BuildCompiledComponent, Wolfram Language function, https://reference.wolfram.com/language/ref/BuildCompiledComponent.html.
CMS
Wolfram Language. 2022. "BuildCompiledComponent." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/BuildCompiledComponent.html.
APA
Wolfram Language. (2022). BuildCompiledComponent. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/BuildCompiledComponent.html