Library Compiler

Package MATLAB programs for deployment as shared libraries and components

Description

The Library Compiler app packages MATLAB^® functions to include MATLAB functionality in applications written in other languages.

×

Open the Library Compiler App

• MATLAB Toolstrip: On the Apps tab, under Application Deployment, click the Library Compiler app icon.

• MATLAB command prompt: Enter libraryCompiler.

Examples

• Create Excel Add-In from MATLAB
• Create a C Shared Library with MATLAB Code
• Generate a C++ mwArray API Shared Library and Build a C++ Application
• Generate a C++ MATLAB Data API Shared Library and Build a C++ Application
• Generate .NET Assembly and Build .NET Application
• Create a Generic COM Component with MATLAB Code
• Generate Java Package and Build Java Application
• Generate Python Package and Build Python Application

Parameters

type — type of library generated

C Shared Library | C++ Shared Library | Excel^® Add-in | Generic COM Component | Java^® Package | .NET Assembly | Python^® Package

Type of library to generate.

If you have MATLAB Compiler™, you can create Excel Add-ins.

If you have a MATLAB Compiler SDK™ license, you can create C/C++ shared libraries, .NET assemblies, COM components, Java packages, and Python packages.

exported functions — functions to package

list of character vectors

Functions to package as a list of character vectors.

packaging options — method for installing the MATLAB Runtime with the compiled library

MATLAB Runtime downloaded from web (default) | MATLAB Runtime included in package

You can decide whether or not to include the MATLAB Runtime fallback for MATLAB Runtime installer in the generated application by selecting one of the two options in the Packaging Options section. Including the MATLAB Runtime installer in the package significantly increases the size of the package.

Runtime downloaded from web — Generates an installer that downloads the MATLAB Runtime and installs it along with the deployed MATLAB application.

Runtime included in package — Generates an installer that includes the MATLAB Runtime installer.

The first time you select this option, you are prompted to download the MATLAB Runtime installer or obtain a CD if you do not have internet access.

files required for your library to run — files that must be included with library

list of files

Files that must be included with library as a list of files.

files installed for your end user — optional files installed with library

list of files

Optional files installed with library as a list of files.

Settings

Additional parameters passed to MCC — flags controlling the behavior of the compiler

character vector

Flags controlling the behavior of the compiler as a character vector.

testing files — folder where files for testing are stored

character vector

Folder where files for testing are stored as a character vector.

end user files — folder where files for building a custom installer are stored

character vector

Folder where files for building a custom installer are stored as a character vector.

packaged installers — folder where generated installers are stored

character vector

Folder where generated installers are stored as a character vector.

Library Information

library name — name of the installed library

character vector

Name of the installed library as a character vector.

The default value is the name of the first function listed in the Exported Functions field of the app.

version — version of the generated library

character vector

Version of the generated library as a character vector.

splash screen — image displayed on installer

image

Image displayed on installer as an image.

author name — name of the library author

character vector

Name of the library author as a character vector.

e-mail — e-mail address used to contact library support

character vector

E-mail address used to contact library support as a character vector.

summary — brief description of library

character vector

Brief description of library as a character vector.

description — detailed description of library

character vector

Detailed description of library as a character vector.

Samples — Sample files to include during packaging

list of files

You can decide whether or not to include sample files when packaging. Sample code demonstrates how to call a MATLAB exported function in the target language. Sample generation is supported for C++ shared libraries, Java packages, .NET assemblies, and Python packages.

To generate a new MATLAB sample file, click Create New Sample and select your MATLAB function. This opens up a MATLAB script for you to modify as necessary based on the intended behavior of your function.

Caution

Sample file code should not require user interaction. If the MATLAB function requires input arguments, you must provide specific values for the arguments in the function call.

To upload a MATLAB script you have already written, click Add Existing Sample.

For more information on sample code, see Create Sample Code to Call Exported Function.

Additional Installer Options

default installation folder — folder where artifacts are installed

character vector

Folder where artifacts are installed as a character vector.

installation notes — notes about additional requirements for using artifacts

character vector

Notes about additional requirements for using artifacts as a character vector.

Programmatic Use

Enter libraryCompiler.

Alternatively, enter deploytool and click Library Compiler.