Main Content

compiler.build.cppSharedLibrary

Create C++ shared library

Description

example

compiler.build.cppSharedLibrary(FunctionFiles) creates a C++ shared library using the MATLAB® files specified by FunctionFiles. Install a supported C++ compiler before using this function.

example

compiler.build.cppSharedLibrary(FunctionFiles,Name,Value) creates a C++ shared library with options specified using one or more name-value arguments. Options include the interface API, library name, and output directory.

example

compiler.build.cppSharedLibrary(opts) creates a C++ shared library with options specified using a compiler.build.CppSharedLibraryOptions object opts. You cannot specify any other options using name-value arguments.

example

results = compiler.build.cppSharedLibrary(___) returns build information as a compiler.build.Results object using any of the input argument combinations in previous syntaxes. The build information consists of the build type, paths to the compiled files, and build options.

Examples

collapse all

Create a C++ shared library using a function file that adds two matrices.

In MATLAB, locate the MATLAB function that you want to deploy as a C++ library. For this example, use the file addmatrix.m located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

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

Build a C++ library using the compiler.build.cppSharedLibrary command.

compiler.build.cppSharedLibrary(appFile);

The build function generates the following files within a folder named addmatrixcppSharedLibrary in your current working directory:

  • 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 — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

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

  • v2\generic_interface\readme.txt — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

  • v2\generic_interface\magicsquare.ctf — Component technology file that contains the deployable archive.

To implement your shared library, see Implement the C++ MATLAB Data API Shared Library with a Driver Application.

Create a C++ library and customize it using name-value arguments.

For this example, use the file addmatrix.m located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

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

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);

Build a C++ library using the compiler.build.cppSharedLibrary command. Use name-value arguments to specify the library name, add a sample file, and use the mwArray interface.

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

The build function creates the following files within a folder named mwa_addmatrixcppSharedLibrary in your current working directory:

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

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

  • includedSupportPackages.txt — Text file that lists all support files included in the library.

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

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

  • mwa_addmatrix.dll — Dynamic-link library file.

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

  • mwa_addmatrix.h — C++ header file.

  • mwa_addmatrix.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 — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

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

To implement your shared library, see Implement the C++ mwArray API Shared Library with a Driver Application.

Create multiple C++ libraries using a compiler.build.CppSharedLibraryOptions object.

For this example, use the file addmatrix.m located in matlabroot\extern\examples\compilersdk\c_cpp\matrix.

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

Create a CppSharedLibraryOptions object using appFile. Use name-value arguments to specify a common output directory, enable debug symbols, and enable verbose output.

opts = compiler.build.CppSharedLibraryOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\CppLibraryBatch',...
    'DebugBuild,'on',...
    'Verbose','on')
opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
           LibraryVersion: '1.0.0.0'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2021b\extern\examples\compilersdk\c_cpp\addmatrix.m'}
               DebugBuild: on
              LibraryName: 'addmatrix'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\CppLibraryBatch'

Build the C++ shared library using the CppSharedLibraryOptions object.

compiler.build.cppSharedLibrary(opts);

To create a new library using the function file subtractmatrix.m with the same options, use dot notation to modify the FunctionFiles argument of the existing CppSharedLibrary object before running the build function again.

opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m');
compiler.build.cppSharedLibrary(opts);

By modifying the FunctionFiles argument and recompiling, you can compile multiple libraries using the same options object.

Create a C++ library and save information about the build type, compiled files, support packages, and build options to a compiler.build.Results object.

Compile using the file magicsquare.m located in matlabroot\extern\examples\compiler.

results = compiler.build.cppSharedLibrary('magicsquare.m')
results = 

  Results with properties:

              BuildType: 'cppSharedLibrary'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.CppSharedLibraryOptions]

The Files property contains the paths to the v2 folder and GettingStarted.html.

Input Arguments

collapse all

Files implementing MATLAB functions, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute. Files must have a .m extension.

Example: ["myfunc1.m","myfunc2.m"]

Data Types: char | string | cell

C++ library build options, specified as a compiler.build.CppSharedLibraryOptions object.

Name-Value Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Verbose','on'

Additional files to include in the C++ shared library, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","data.txt"]

Data Types: char | string | cell

Flag to automatically include data files, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then data files that you provide as inputs to certain functions (such as load and fopen) are automatically included in the shared library.

  • If you set this property to 'off', then you must add data files to the shared library using the AdditionalFiles property.

Example: 'AutoDetectDataFiles','off'

Data Types: logical

Flag to enable debug symbols, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then the compiled library contains debug symbols.

  • If you set this property to 'off', then the compiled library does not contain debug symbols.

Example: 'DebugBuild','on'

Data Types: logical

Interface API, specified as one of the following options:

  • 'matlab-data' — Generate shared libraries using the MATLAB Data API.

  • 'mwarray' — Generate shared libraries using the mwArray API.

For more information, see API Selection for C++ Shared Library.

Example: 'Interface','mwarray'

Name of the C++ shared library, specified as a character vector or a string scalar. The default name of the generated library is the first entry of the FunctionFiles argument.

Example: 'LibraryName','mymagic'

Data Types: char | string

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the library name appended with cppSharedLibrary.

Example: 'OutputDir','D:\Documents\MATLAB\work\mymagiccppSharedLibrary'

Data Types: char | string

MATLAB sample files used to generate sample C++ library files for functions included within the library, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute. Files must have a .m extension. For more information and limitations, see Sample Driver File Creation.

Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Data Types: char | string | cell

Support packages to include, specified as one of the following options:

  • 'autodetect' (default) — The dependency analysis process detects and includes the required support packages automatically.

  • 'none' — No support packages are included. Using this option can cause runtime errors.

  • A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

.

Example: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Data Types: char | string | cell

Flag to control build verbosity, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

  • If you set this property to 'on', then the MATLAB command window displays progress information indicating compiler output during the build process.

  • If you set this property to 'off', then the command window does not display progress information.

Example: 'Verbose','on'

Data Types: logical

Output Arguments

collapse all

Build results, returned as a compiler.build.Results object. The Results object contains:

  • Build type, which is 'cppSharedLibrary'

  • Paths to the following:

    • GettingStarted.html

    • v2 folder (matlab-data interface only)

    • LibraryName.dll (mwArray interface only)

    • LibraryName.lib (mwArray interface only)

    • LibraryName.h (mwArray interface only)

  • A list of included support packages

  • Build options, specified as a CppSharedLibraryOptions object

Introduced in R2021a