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

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

This example shows how to create a C++ shared library from a MATLAB^® function. You can integrate the generated library into a C++ application. This example also shows how to call the C++ shared library from a C++ 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 located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

 addmatrix.m

function a = addmatrix(a1, a2)

a = a1 + a2;

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

Create a C++ Shared Library Using the Library Compiler App

1. On the MATLAB Apps tab, on the far right of the Apps section, click the arrow. In Application Deployment, click Library Compiler.

   Alternatively, you can open the Library Compiler app from the MATLAB command prompt by entering:

   libraryCompiler

2. In the Type section of the toolstrip, click C++ Shared Library.

   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.

   For this example, navigate to matlabroot\extern\examples\compilersdk\c_cpp\matrix and select addmatrix.m.

3. 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.

Specify Shared Library Settings

1. The Library Name field is automatically populated with addmatrix as the name of the packaged shared library. Rename it as libmatrix. The same name is followed through in the implementation of the shared library.

2. Add MATLAB files to generate the sample C++ driver files. Although C++ driver files are not necessary to create shared libraries, they are used to demonstrate how to Implement the C++ mwArray API Shared Library with a Driver Application.

   In the Samples section, select Create New Sample, and click addmatrix.m. A MATLAB file opens for you to edit. Define the input variables as necessary for your application, save the file, and return to the Library Compiler app. For more information and limitations, see Sample Driver File Creation.

3. Select the type of API for the generated C++ shared libraries. In the API selection section at the bottom, select Create interface that uses the mwArray API. For more information, see API Selection for C++ 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.

  See Specify Files to Install with Application

Package the Application

1. To generate the packaged application, click Package.

   In the Save Project dialog box, specify the location to save the project.

2. 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™.

Create a C++ Shared Library Using compiler.build.cppSharedLibrary

Note

If you have already created a standalone application using the Library Compiler app, you can skip this section. However, if you want to know how to create a C++ shared library from the MATLAB command window using a programmatic approach, follow these instructions.

1. Save the path to the addmatrix.m file located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

   appFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');

2. Save the following code in a sample file named addmatrixSample1.m:

   a1 = [1 4 7; 2 5 8; 3 6 9];
   a2 = a1;
   a = addmatrix(a1, a2);

3. Build the C++ shared library using the compiler.build.cppSharedLibrary function. Use name-value arguments to add a sample file and specify the library name and interface API.

   buildResults = compiler.build.cppSharedLibrary(appFile,...
   'LibraryName','libmatrix',...
   'Interface','mwarray',...
   'SampleGenerationFiles','addmatrixSample1.m');

   The compiler.build.Results object buildResults contains information on the build type, generated files, and build options.

4. This syntax generates the following within a folder named libmatrixcppSharedLibrary in your current working directory:

   • samples\addmatrixSample1_mwarray.cpp — C++ sample driver file.

   • GettingStarted.html — HTML file that contains information on integrating your shared library.

   • libmatrix.cpp — C++ source code file.

   • libmatrix.def — Module-definition file that provides the linker with module information.

   • libmatrix.dll — Dynamic-link library file.

   • libmatrix.exports — Exports file that contains all nonstatic function names.

   • libmatrix.h — C++ header file.

   • libmatrix.lib — Import library file.

   • mccExcludedFiles.log — Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see MATLAB Compiler Limitations.

   • readme.txt — Text file that contains packaging information.

   • requiredMCRProducts.txt — Text file that contains product IDs of products required by MATLAB Runtime to run the application.

   • unresolvedSymbols.txt — Text file that contains information on unresolved symbols.

   Note

   The generated library does not include MATLAB Runtime or an installer.

5. Additional options can be specified in the compiler.build command by using one or more of the following name-value arguments.

   • 'AdditionalFiles' — Path to additional files to include in the shared library.

   • 'AutoDetectDataFiles' — Flag to automatically include data files.

   • 'DebugBuild' — Flag to enable debug symbols.

   • 'Interface'— Interface API, specified as 'matlab-data' (default) or 'mwarray'. For more information, see API Selection for C++ Shared Library.

   • 'LibraryName'— Name of the generated library.

   • 'OutputDir' — Path to the output directory that contains generated files.

   • 'SampleGenerationFiles'— MATLAB sample files used to generate sample C++ library files. For more information, see Sample Driver File Creation.

   • 'Verbose'— Flag to display progress information indicating compiler output during the build process.

Implement the C++ mwArray API Shared Library with a Driver Application

After packaging your C++ shared libraries, you can call them from a C++ application. The C++ application that you create uses the sample C++ driver code generated during packaging. The C++ driver code calls the C++ shared libraries, and it is based on the sample MATLAB file you selected in previous setup steps.

These steps are also explained in the GettingStarted.html file in for_redistribution_files_only folder. Before starting, make sure that you Install and Configure MATLAB Runtime, and that you have a C++ compiler installed.

1. Copy and paste the generated C++ driver code file from the for_redistribution_files_only\samples folder into the for_redistribution_files_only folder created when you created the shared library.

2. Use the system command line to navigate to the for_redistribution_files_only folder, where you copied the generated sample C++ driver code file.

3. Compile and link the application using mbuild at the system command prompt.

   mbuild addmatrix_sample.cpp libmatrix.lib

4. From the system command prompt, run the application. If you used sample MATLAB code in the packaging steps, this application should return the same output as the MATLAB code.

   addmatrix_sample.exe

   2 8 14
   4 10 16
   6 12 18