Package MATLAB Functions

Package MATLAB® functions for use in applications coded in other languages

Before you can integrate MATLAB functions into external applications, you need to package them for the target language. MATLAB Compiler SDK™ includes two apps and a command-line compiler for this purpose. The apps guide you in specifying functions to package and in creating an installer. Target-language developers install the compiled code on the development system, along with the MATLAB Runtime, which is necessary to run the code. At the command-line, you can package the MATLAB functions into a binary package the target language developer uses in developing their applications.

Apps

Library CompilerPackage MATLAB programs for deployment as shared libraries and components

Functions

libraryCompilerOpen the Library Compiler app
productionServerCompilerTest, build and package functions for use with MATLAB Production Server
mccCompile MATLAB functions for deployment
mbuildCompile and link source files against MATLAB generated shared libraries
deploytoolOpen a list of application deployment apps
componentinfoQuery system registry about COM component created with MATLAB Compiler SDK
isdeployedDetermine whether code is running in deployed or MATLAB mode
ismccTest if code is running during compilation process (using mcc)
ctfrootLocation of files related to deployed application
figToImStreamStream figure as byte array encoded in specified format
getmcruserdataRetrieve MATLAB array value associated with a given key
setmcruserdataAssociate MATLAB data value with a key
%#functionPragma to help MATLAB Compiler locate functions called through feval, eval, Handle Graphics callback, or objects loaded from MAT-files

Examples and How To

C/C++

Install an ANSI C or C++ Compiler

Installing a supported C/C++ compiler

Create a C Shared Library with MATLAB Code

Learn how to create a C shared library.

Generate a C++ mwArray API Shared Library and Build a C++ Application

Create a C++ mwArray API shared library from MATLAB code using the Library Compiler and implement it with sample C++ driver code.

Generate a C++ MATLAB Data API Shared Library and Build a C++ Application

Create a C++ MATLAB Data API shared library from MATLAB code using the Library Compiler and implement it with sample C++ driver code.

Create C/C++ Shared Libraries from Command Line

Use the command-line compiler to create C/C++ shared libraries.

Distribute C/C++ Shared Libraries to Application Developers

Distribute the following to the application developer integrating the shared library:

.NET

Generate a .NET Assembly and Build a .NET Application

Create a .NET assembly from MATLAB code using the Library Compiler and implement it with sample .NET driver code.

Package .NET Assemblies from Command Line

Using the mcc command line to build your assembly

Distribute .NET Assemblies to Application Developers

Distribute the following to the application developer integrating the .NET assembly:

Java

Configure Your Java Environment

Configuring the Java® environment for compilation of MATLAB code and development of Java applications

Generate a Java Package and Build a Java Application

Create a Java package from MATLAB code using the Library Compiler and implement it with sample Java driver code.

Package Java Applications from Command Line

Using the command-line compiler to create Java applications.

Map Functions to Java Class Methods

Mapping MATLAB functions to Java classes

Distribute Java Applications to Application Developers

Distribute the following to the application developer integrating the application:

Python

Generate a Python Package and Build a Python Application

Create a Python® package from MATLAB code using the Library Compiler and implement it with sample Python driver code.

Package Python Applications from Command Line

MATLAB Compiler SDK cannot package MATLAB code that uses the MATLAB Python interface.

Distribute Python Applications to Application Developers

Distribute the following to the application developer integrating the application:

MATLAB Production Server

Create a Deployable Archive for MATLAB Production Server

Learn how to create a deployable archive for MATLAB Production Server™ using a MATLAB function.

Package Deployable Archives from Command Line

Package MATLAB applications into deployable archives from the command line using the mcc command.

Build Excel Add-In and Deployable Archive

The Excel integration with MATLAB Production Server builds two artifacts. One is for the server and one is for the client.

COM

Create a Generic COM Component with MATLAB Code

Learn how to create a generic COM component.

Package COM Components from Command Line

Using the mcc command line to build COM components

Distribute COM Components to Application Developers

Distribute the following to the application developer integrating the component:The Library Compiler app generates an installer that packages all of the binary artifacts required for distributing a COM component.

Customization

Customize an Application

How to customize the look and feel of the installer generated by the compiler app.

Manage Support Packages

Including support packages when packaging MATLAB applications.

Simplify Compilation Using Macros

Information on macros and how they can simplify your work

Invoke MATLAB Build Options

Using path name, bundles, and wrapper files to build your MATLAB code

Concepts

Files Generated After Packaging MATLAB Functions

Descriptions for files generated after packaging MATLAB functions.

How Does MATLAB Deploy Functions?

To deploy MATLAB functions, the compiler performs these tasks:

Write Deployable MATLAB Code

Writing MATLAB code that can be packaged and deployed.

State-Dependent Functions

Dealing with MATLAB functions that carry state.

MATLAB Runtime Component Cache and Deployable Archive Embedding

How to override the default deployable archive embedding behavior and how to use MATLAB Runtime Component Cache

Using the MATLAB Runtime User Data Interface

Information on how to access MATLAB Runtime data

Display the MATLAB Runtime Initialization Messages

Procedure to create console messages for end users

Functions Not Supported for Compilation by MATLAB Compiler and MATLAB Compiler SDK

Functions not able to be compiled with MATLAB Compiler™ or MATLAB Compiler SDK

Limitations

Limitations and restrictions regarding what can be compiled