Create a C Shared Library with MATLAB Code

Supported platform: Windows^®, Linux^®, Mac

This example shows how to create a C shared library using a MATLAB^® function. You can then pass the generated package to the developer who is responsible for integrating it into an application. The target system does not require a licensed copy of MATLAB.

Create Functions in MATLAB

In MATLAB, examine the MATLAB code that you want packaged. For this example, open addmatrix.m, multiplymatrix.m, and eigmatrix.m located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

addmatrix.m

At the MATLAB command prompt, enter addmatrix([1 4 7; 2 5 8; 3 6 9], [1 4 7; 2 5 8; 3 6 9]).

The output is:

 ans =
     2     8    14
     4    10    16
     6    12    18

multiplymatrix.m

At the MATLAB command prompt, enter multiplymatrix([1 4 7; 2 5 8; 3 6 9], [1 4 7; 2 5 8; 3 6 9]).

The output is:

 ans =
    30    66   102
    36    81   126
    42    96   150

eigmatrix.m

At the MATLAB command prompt, enter eigmatrix([1 4 7; 2 5 8; 3 6 9]).

The output is:

 ans =
   16.1168
   -1.1168
   -0.0000

Create a C Shared Library Using the Library Compiler App

On the MATLAB Apps tab, on the far right of the Apps section, click the arrow. In Application Deployment, click Library Compiler. In the MATLAB Compiler project window, click C Shared Library.
Alternately, you can open the Library Compiler app by entering libraryCompiler at the MATLAB prompt.
In the Library Compiler app project window, specify the files of the MATLAB application that you want to deploy.
1. In the Exported Functions section of the toolstrip, click .
2. In the Add Files window, browse to the example folder, and select the function you want to package. Click Open.
The function is added to the list of exported function files. Repeat this step to package multiple files in the same application.
Add all three functions to the list of main files.
In the Packaging Options section of the toolstrip, decide whether to include the MATLAB Runtime installer in the generated application by selecting one of the options:
- Runtime downloaded from web — Generate an installer that downloads the MATLAB Runtime and installs it along with the deployed MATLAB application. You can specify the filename of the installer.
- Runtime included in package — Generate an application that includes the MATLAB Runtime installer. You can specify the filename of the installer.
  Note
  The first time you select this option, you are prompted to download the MATLAB Runtime installer.
In the Library Name field, rename the packaged shared library as libmatrix. The same name is followed through in the implementation of the shared library.

Customize the Application and Its Appearance

You can customize the installer, customize your application, and add more information about the application as follows:

Library information — Information about the deployed application. You can also customize the appearance of the application by changing the application icon and splash screen. The generated installer uses this information to populate the installed application metadata. See Customize the Installer.
Additional installer options — Default installation path for the generated installer and custom logo selection. See Change the Installation Path.
Files required for your library to run — Additional files required by the generated application to run. These files are included in the generated application installer. See Manage Required Files in Compiler Project.
Files installed for your end user — Files that are installed with your application. These files include:
- Generated readme.txt
- Generated executable for the target platform
See Specify Files to Install with Application

Package the Application

To generate the packaged application, click Package.
In the Save Project dialog box, specify the location to save the project.
In the Package dialog box, verify that Open output folder when process completes is selected.
When the packaging process is complete, examine the generated output.
- Three folders are generated in the target folder location: for_redistribution, for_redistribution_files_only, and for_testing.
  For more information about the files generated in these folders, see Files Generated After Packaging MATLAB Functions.
- PackagingLog.txt — Log file generated by MATLAB Compiler™.

Documentation