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

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

This example shows how to create a C++ shared library from MATLAB^® functions. 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 to run the application.

Create Functions in MATLAB

In MATLAB, examine the MATLAB code that you want to package.
Copy the matrix folder that ships with MATLAB to your work folder.
```
copyfile(fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix'),'matrix')
```
Navigate to the new matrix subfolder in your work folder.
Examine and test the functions addmatrix.m, multiplymatrix.m, and eigmatrix.m.

Create a C++ Shared Library Using Library Compiler App

Compile the functions into a C++ shared library using the Library Compiler app. Alternatively, if you want to create a shared library from the MATLAB command window using a programmatic approach, see Create C++ Shared Library Using compiler.build.cppSharedLibrary.

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
```
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.
Add addmatrix.m, multiplymatrix.m, and eigmatrix.m 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 file name of the installer.
- Runtime included in package — Generate an application that includes the MATLAB Runtime installer. You can specify the file name of the installer.
  Note
  The first time you select this option, you are prompted to download the MATLAB Runtime installer.

Specify Shared Library Settings

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.
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 MATLAB Data API. You may also leave it on the default option to create both interfaces. For more information, see API Selection for C++ Shared Library.

Create Sample Driver File

Create MATLAB sample files that call the functions. Sample files are used to generate a sample application in the target language. You can use any MATLAB file in the project to generate sample code. Although sample files are not necessary to create shared libraries, you can use them as a guide to implement your own application.

You may instead choose to not include a sample driver file at all during the packaging step. If you create your own C++ application code, you can move it to the appropriate directory and compile it using mbuild after the MATLAB functions are packaged.

Create sample files for each MATLAB function in the project.

For instance, to create a sample file for eigmatrix, in the Samples section, select Create New Sample and choose eigmatrix.m. A MATLAB file opens for you to edit.

% Sample script to demonstrate execution of function e = eigmatrix(a1)
a1 = 0; % Initialize a1 here
e = eigmatrix(a1);

Change a1 = 0 to a1 = [1 4 7; 2 5 8; 3 6 9], save the file, and return to the Library Compiler app.

Caution

You must edit the MATLAB sample files to output your desired result. Generated target language sample files use the same inputs and outputs as the sample MATLAB file.

The compiler converts this MATLAB code to C++ code during packaging. For more information and limitations, see Sample Driver File Creation.

Customize the Application and Its Appearance

In the Library Compiler app, you can customize the installer, customize your application, and add more information about the application.

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

When you are finished selecting your packaging options, save your Library Compiler project and 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 in the target folder.
- Three folders are generated: 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.
- The log file PackagingLog.html contains packaging results.

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

As an alternative to the Library Compiler app, you can create a C++ shared library using a programmatic approach. If you have already created a library using the Library Compiler, see Implement C++ MATLAB Data API Shared Library with Sample Application.

Save the list of function files in a cell array.

functionfiles = {'addmatrix.m', 'multiplymatrix.m', 'eigmatrix.m'}

Create MATLAB sample code that calls the functions. Sample files are used to generate a sample application in the target language. For more information and limitations, see Sample Driver File Creation.
Save the following code in a sample file named libmatrixSample.m:
```
% Sample script to demonstrate execution of functions
% addmatrix, eigmatrix, and multiplymatrix
a1 = [1 4 7; 2 5 8; 3 6 9]; % Initialize a1 here
a2 = a1; % Initialize a2 here
a = addmatrix(a1, a2);
e = eigmatrix(a1);
m = multiplymatrix(a1, a2);
```
You may instead choose to not include a sample driver file at all during the packaging step. If you create your own C++ application code, you can move it to the appropriate directory and compile it using mbuild after the MATLAB functions are packaged.
Build the C++ shared library using the compiler.build.cppSharedLibrary function. Use name-value arguments to specify the library name and add the sample file.
```
buildResults = compiler.build.cppSharedLibrary(functionfiles,...
'LibraryName','libmatrix',...
'SampleGenerationFiles','libmatrixSample.m');
```
You can specify additional options in the compiler.build command by using name-value arguments. For details, see compiler.build.cppSharedLibrary.
The compiler.build.Results object buildResults contains information on the build type, generated files, included support packages, and build options.
This syntax generates the following files within a folder named libmatrixcppSharedLibrary in your current working directory:
- samples\libmatrixSample1_mda.cpp — C++ sample application that calls the addmatrix function.
- samples\libmatrixSample2_mda.cpp — C++ sample application that calls the eigmatrix function.
- samples\libmatrixSample3_mda.cpp — C++ sample application that calls the multiplymatrix function.
- v2\generic_interface\libmatrix.ctf — Component technology file that contains the deployable archive.
- v2\generic_interface\readme.txt — Text file that contains packaging information.
- GettingStarted.html — HTML file that contains information on integrating your shared library.
- includedSupportPackages.txt — Text file that lists all support files included in the library.
- 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 and interface 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. To create an installer using the buildResults object, see compiler.package.installer.

Implement C++ MATLAB Data API Shared Library with Sample Application

Note

To call the library using a more advanced application that calls all three functions and handles errors, use the C++ application matrix_mda.cpp located in the folder

matlabroot\extern\examples\compilersdk\c_cpp\matrix

For more details, see Integrate C++ Shared Libraries with MATLAB Data API.

Before starting, make sure that you Download and Install MATLAB Runtime and that you have a C++ compiler installed.

After packaging C++ shared libraries, you can call them from a C++ application. The C++ code generated in the samples folder is based on the sample MATLAB file you created.

Copy and paste the generated file libmatrix.ctf from the v2\generic_interface folder into the samples folder that contains libmatrixSample1_mda.cpp.

The program listing for libmatrixSample1_mda.cpp is shown below.

/*=================================================================
 *
 * ADDMATRIXSAMPLE1
 * Sample driver code that uses the generic interface and
 * MATLAB Data API to call a C++ shared library created using 
 * MATLAB Compiler SDK.
 * Refer to the MATLAB Compiler SDK documentation for more
 * information.
 *
 *=================================================================*/

// Include the header file required to use the generic
// interface for the C++ shared library generated by the
// MATLAB Compiler SDK.
#include "MatlabCppSharedLib.hpp"
#include <iostream>

namespace mc = matlab::cpplib;
namespace md = matlab::data;

std::shared_ptr<mc::MATLABApplication> setup()
{
	auto mode = mc::MATLABApplicationMode::IN_PROCESS;
	// Specify MATLAB startup options
	std::vector<std::u16string> options = {};
	std::shared_ptr<mc::MATLABApplication> matlabApplication = mc::initMATLABApplication(mode, options);
	return matlabApplication;
}

int mainFunc(std::shared_ptr<mc::MATLABApplication> app, const int argc, const char * argv[])
{		
	md::ArrayFactory factory;
	md::TypedArray<double> a1In = factory.createArray<double>({3, 3}, {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0});
	md::TypedArray<double> a2In = factory.createArray<double>({3, 3}, {1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0});
	try {
		// The path to the CTF (library archive file) passed to 
		// initMATLABLibrary or initMATLABLibraryAsync may be either absolute
		// or relative. If it is relative, the following will be prepended
		// to it, in turn, in order to find the CTF:
		// - the directory named by the environment variable 
		// CPPSHARED_BASE_CTF_PATH, if defined
		// - the working directory
		// - the directory where the executable is located
		// - on Mac, the directory three levels above the directory
		// where the executable is located
		
		// If the CTF is not in one of these locations, do one of the following:
		// - copy the CTF
		// - move the CTF
		// - change the working directory ("cd") to the location of the CTF
		// - set the environment variable to the location of the CTF
		// - edit the code to change the path
		auto lib = mc::initMATLABLibrary(app, u"libmatrix.ctf");
		std::vector<md::Array> inputs{a1In, a2In};
		auto result = lib->feval(u"addmatrix", 1, inputs);
	} catch (const std::exception & exc) {
		std::cerr << exc.what() << std::endl;
		return -1;
	}
	return 0;
}

// The main routine. On the Mac, the main thread runs the system code, and
// user code must be processed by a secondary thread. On other platforms, 
// the main thread runs both the system code and the user code.
int main(const int argc, const char * argv[]) 
{
	int ret = 0;
	try {
		auto matlabApplication = setup();
		ret = mc::runMain(mainFunc, std::move(matlabApplication), argc, argv);
		// Calling reset() on matlabApplication allows the user to control
		// when it is destroyed, which automatically cleans up its resources.
		// Here, the object would go out of scope and be destroyed at the end 
		// of the block anyway, even if reset() were not called.
		// Whether the matlabApplication object is explicitly or implicitly
		// destroyed, initMATLABApplication() cannot be called again within
		// the same process.
		matlabApplication.reset();
	} catch(const std::exception & exc) {
		std::cerr << exc.what() << std::endl;
		return -1;
	}
	return ret;
}

At the MATLAB command prompt or your system command prompt, navigate to the samples folder where you copied libmatrix.ctf.
Compile and link the application using mbuild at the system command prompt.
```
mbuild libmatrixSample1_mda.cpp
```
Run the application from the system command prompt.
```
addmatrixSample1_mda.exe
```
By default, the generated C++ code does not display any output.
(Optional) Compile and link the other sample C++ applications using mbuild. You can also use the generated C++ code as a guide to create your own application.
For further details, see Integrate C++ Shared Libraries with MATLAB Data API.

Note

For an example on how to retrieve and display a struct array, a cell array, or a character vector from an feval call, see the files subtractmatrix.m and subtractmatrix_mda.cpp located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.