FunctionCompileExport

✖
`FunctionCompileExport`

[Experimental]

✖

FunctionCompileExport["file.ext",fspec]

exports a compiled version of functions fspec in the format specified by the file extension ext.

✖

FunctionCompileExport[path,defs,fspec]

exports a compiled version of fspec using local auxiliary definitions defs.

✖

FunctionCompileExport[path,fspec,"format"]

exports in the specified format.

✖

FunctionCompileExport[path,defs,fspec,"format"]

exports a compiled version using local auxiliary definitions.

Details and Options

By default, FunctionCompileExport exports object or assembler code suitable for the machine architecture on which it is being run.
Functions can be given as a Function pure function, a list of pure functions or an association of pure functions.
Auxiliary definitions can be given with FunctionDeclaration or by giving a CompilerEnvironment option.
The following file extensions and export formats are supported:

".asm", ".s"	"Assembler"	textual assembler code
".o", ".obj"	"Binary"	binary machine code
".ll"	"LLVM"	LLVM textual intermediate code
".bc"	"LLVMBinary"	LLVM binary code

The following options can be given:

CompilerEnvironment	Automatic	an environment of definitions for compilation
CompilerOptions	Automatic	detailed options for the compilation pipeline
ProgressReporting	Automatic	how to report progress during the compilation
TargetSystem	Automatic	$SystemID for the target architecture

FunctionCompileExport returns the name of the file that it created.
In FunctionCompileExport[path,func,…], func can be a CompiledCodeFunction object.

Examples

open allclose all

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

Export a compiled version of a function into a file:

In[1]:=1

✖

https://wolfram.com/xid/0mk7v9cbuks6-ywyh2j

Out[1]=1

The export format can be determined from the file name:

In[2]:=2

✖

https://wolfram.com/xid/0mk7v9cbuks6-jyht1m

The export format can be given explicitly:

In[3]:=3

✖

https://wolfram.com/xid/0mk7v9cbuks6-umtsu2

LLVM IR can be generated:

In[4]:=4

✖

https://wolfram.com/xid/0mk7v9cbuks6-crmbiq

Several functions can be compiled with FunctionCompileExport:

In[1]:=1

✖

https://wolfram.com/xid/0mk7v9cbuks6-xps8uh

It can be useful to use an association to hold the functions:

In[2]:=2

✖

https://wolfram.com/xid/0mk7v9cbuks6-3lkyv9

Auxiliary definitions can be given with FunctionDeclaration:

In[1]:=1

✖

https://wolfram.com/xid/0mk7v9cbuks6-19znon

Options (3)Common values & functionality for each option

CompilerEnvironment (1)

Create a compiler environment and add a function definition:

In[1]:=1

✖

https://wolfram.com/xid/0mk7v9cbuks6-frh

Use a compiler environment in a compilation:

In[2]:=2

✖

https://wolfram.com/xid/0mk7v9cbuks6-x1j2b1

ProgressReporting (1)

Progress during a compilation is reported:

In[4]:=4

✖

https://wolfram.com/xid/0mk7v9cbuks6-6cy6wj

✖

https://wolfram.com/xid/0mk7v9cbuks6-nmjw2s

This can be suppressed by setting the option ProgressReporting to 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.

TargetSystem (1)

The default setting of Automatic generates code for the machine architecture on which it is being run:

In[1]:=1

✖

https://wolfram.com/xid/0mk7v9cbuks6-gy1c0o

TargetSystem can be set to the $SystemID of the desired platform:

In[2]:=2

✖

https://wolfram.com/xid/0mk7v9cbuks6-rxsu02

TargetSystem can be set for architectures for which the Wolfram Engine does not exist:

In[3]:=3

✖

https://wolfram.com/xid/0mk7v9cbuks6-ewo1vu

Top

More Learning

Tech Support

Wolfram Solutions

Wolfram Solutions For Education

Get Started

Grow Your Skills

Work with Us

Educational Programs for Adults

Educational Programs for Youth

Read

FunctionCompileExport

✖
`FunctionCompileExport`

Details and Options

Examples

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