WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

DeclareCompiledComponent
✖
DeclareCompiledComponent

[Experimental]

✖
DeclareCompiledComponent["name",decls]

adds declarations decls to compiled component "name".

✖
DeclareCompiledComponent["name",fieldspec]

adds the specification spec to the specified field in the compiled component "name".

Details

  • 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.
  • DeclareCompiledComponent["name",...] creates the compiled component "name" if it does not already exist.
  • Declarations from compiled components can be added to a compiler environment with CreateCompilerEnvironment and with CompilerEnvironmentAppendTo.
  • Declarations from compiled components are used when building installed and library functions.
  • A library that contains installed and library functions can be built with BuildCompiledComponent.
  • A library that contains installed and library functions can be loaded with LoadCompiledComponent.
  • The following values for field can be given:
  • "Declarations"declarations to use with the component
    "InstalledFunctions"functions to compile and symbols into which to install the results
    "LibraryFunctions"functions to compile, to be recovered by LoadCompiledComponent
    "RawLibraryFunctions"functions to compile that are available as library exports
    "LoadingEpilogs"functions to be executed after the component is loaded by LoadCompiledComponent
    "ExternalLibraries"libraries to be loaded before the component is loaded by LoadCompiledComponent
  • "Declarations" can be given as a single declaration or a list of declarations.
  • "InstalledFunctions" can be given as a rule symfunc that specifies that a compiled version of func will be installed in the symbol sym when the component built is loaded. "InstalledFunctions" can also accept an association of rules.
  • "InstalledFunctions" can be given a symbol sym, which will effectively declare the installed function symsym. If sym is the name of a compilable function (including one defined in the component), then it will be compiled and installed into the symbol sym for use outside compiled code. A list of symbols can also be given. »
  • "LibraryFunctions" can be given as a rule "name"func that specifies that a compiled version of func will be made available in the result of LoadCompiledComponent under the name "name". "LibraryFunctions" can also be given as an association.
  • "RawLibraryFunctions" entries are given as a rule "name"Typed[funcName,ty]. This specifies that a compiled version of funcName with type ty will be exported by the library built for the component. If compilations use the component with CompiledComponentRawInterface, they can refer directly to funcName.
  • "LoadingEpilogs" can be given as a single function or a list of functions.
  • "ExternalLibraries" can be given as a single library specification or a list of library specifications. Library specifications must be resolvable by FindLibrary.
  • The "InstalledFunctions" and "LibraryFunctions" fields contain the source to be compiled. BuildCompiledComponent builds that source and saves the result to a dynamic library. The dynamic library can be loaded with LoadCompiledComponent to recover the results of the compilation.
  • The names of "RawLibraryFunctions" are limited by the format of dynamic libraries.

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

Create a compiled component "demo" containing a declaration:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-2hv20e

View the resulting component:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-ca2kh9
Out[2]=2

Use "demo" in a call to FunctionCompile:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-8scmf7
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-2pl802
Out[4]=4

Clear the component:

In[5]:=5
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-1t3xn9

Give a declaration for a compiled component:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-8ki5g6

The compiled component object returns information about the component:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-8x3ldp
Out[2]=2

The compiled component object has the following properties:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-gbiirm
Out[3]=3

See the declarations added to a component:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-9i8w7t
Out[4]=4

Scope  (5)Survey of the scope of standard use cases

Declare a list of declarations in a component:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-k3gext

Declare a library function:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-mqj885

Declare an installed function:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-jzuty8

Extract all properties of the component:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-yvob35
Out[4]=4

Properties of a component:

In[5]:=5
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-mevctm
Out[5]=5

The declarations of a component:

In[6]:=6
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-nxx0ps
Out[6]=6

Clear the component:

In[7]:=7
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-2gm560

DeclareCompiledComponent can give functions to compile into a library:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-f4pmzx

Build the library:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-sgtatn
Out[2]=2

Load the library:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-vem10v
Out[3]=3

Call the code function from the library:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-yzn798
Out[4]=4

DeclareCompiledComponent can define symbols to get installed code:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-3yvd2t

Declare a function to exist in the component:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-4eqtno

Add an installed function given only its name, looking up the definition in the compiler:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-4fhen8

Build the component library:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-psclpz
Out[4]=4

Automatically load the component library by calling its installed functions:

In[5]:=5
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-mr8iqu
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-crud07
Out[6]=6

DeclareCompiledComponent can define symbols to get installed code:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-6hmh6l

Declare a function to exist in the component:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-84v2fj

Add an installed function given only its name, looking up the definition in the compiler:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-s1w1qf

Build the component library:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-7ytgm5
Out[4]=4

Automatically load the component library by calling its installed functions:

In[5]:=5
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-pgr2k3
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-pxalr4
Out[6]=6

DeclareCompiledComponent can create a raw library interface to be used by other compiled code:

In[1]:=1
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-jg6847

Build the component library:

In[2]:=2
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-wg74wg
Out[2]=2

Load and initialize the component library:

In[3]:=3
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-mlcfkb
Out[3]=3

A declaration of the function in the library:

In[4]:=4
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-wlwpt4

Compile a function that uses the library:

In[5]:=5
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-nxfwqv
Out[5]=5

Run the computation that calls the library:

In[6]:=6
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-01askk
Out[6]=6

Instead of using the LibraryFunctionDeclaration, the component raw interface can be used directly:

In[7]:=7
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-d6v8q
Out[7]=7
In[8]:=8
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-3ll0v8
Out[8]=8

This is useful because declarations from the component use the library without having to recompile them.

A component library built with "RawLibraryFunctions" can be used with ForeignFunctionLoad:

In[9]:=9
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-cu1tj9
Out[9]=9
In[10]:=10
✖
https://wolfram.com/xid/0cpsqn29eiu0b2-y85ou
Out[10]=10
Wolfram Research (2022), DeclareCompiledComponent, Wolfram Language function, https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.
✖
Wolfram Research (2022), DeclareCompiledComponent, Wolfram Language function, https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.

Text

Wolfram Research (2022), DeclareCompiledComponent, Wolfram Language function, https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.

✖
Wolfram Research (2022), DeclareCompiledComponent, Wolfram Language function, https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.

CMS

Wolfram Language. 2022. "DeclareCompiledComponent." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.

✖
Wolfram Language. 2022. "DeclareCompiledComponent." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html.

APA

Wolfram Language. (2022). DeclareCompiledComponent. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html

✖
Wolfram Language. (2022). DeclareCompiledComponent. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html

BibTeX

@misc{reference.wolfram_2025_declarecompiledcomponent, author="Wolfram Research", title="{DeclareCompiledComponent}", year="2022", howpublished="\url{https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html}", note=[Accessed: 08-July-2025 ]}

✖
@misc{reference.wolfram_2025_declarecompiledcomponent, author="Wolfram Research", title="{DeclareCompiledComponent}", year="2022", howpublished="\url{https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html}", note=[Accessed: 08-July-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_declarecompiledcomponent, organization={Wolfram Research}, title={DeclareCompiledComponent}, year={2022}, url={https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html}, note=[Accessed: 08-July-2025 ]}

✖
@online{reference.wolfram_2025_declarecompiledcomponent, organization={Wolfram Research}, title={DeclareCompiledComponent}, year={2022}, url={https://reference.wolfram.com/language/ref/DeclareCompiledComponent.html}, note=[Accessed: 08-July-2025 ]}