Call MATLAB from C++

Run MATLAB^® code from C++ programs, with object-oriented programming support and asynchronous execution

The MATLAB Engine API for C++ provides an interface between the C++ programming language and MATLAB. This API enables C++ programs to launch MATLAB, evaluate MATLAB functions with arguments, and exchange data between MATLAB and C++ programs. Supported operations include:

Start MATLAB.
Connect to a MATLAB shared session on the local machine.
Call MATLAB functions with input arguments passed from C++ and output variables returned from MATLAB.
Evaluate MATLAB statements in the MATLAB base workspace.
Pass variables from C++ to MATLAB and from MATLAB to C++.

To get started, see Set Up C++ Development Environment.

The MATLAB Engine API for C++ uses the MATLAB Data API for C++, which provides a way for applications running outside of MATLAB to work with MATLAB data through a language-neutral interface. The engine API also provides a strongly typed interface that enforces a strict data type mapping between MATLAB and C++. You can use this strongly typed interface to call MATLAB functions and classes by their MATLAB names in C++ as if they were native C++ functions and classes. For an example, see Integrate Strongly Typed MATLAB Data in C++ Application.

Classes

expand all

C++ Classes

`matlab::engine::MATLABEngine`	Evaluate MATLAB functions from C++ program
`matlab::engine::FutureResult`	Retrieve result from asynchronous operation
`matlab::engine::SharedFutureResult`	Retrieve result from asynchronous operation as shared future

C++ Type Definitions

`matlab::engine::StreamBuffer`	Define stream buffer
`matlab::engine::String`	Define UTF-16 string
`matlab::engine::WorkspaceType`	Type of MATLAB workspace

Functions

expand all

C++ Start and Connect Functions

`matlab::engine::startMATLAB`	Start MATLAB synchronously
`matlab::engine::startMATLABAsync`	Start MATLAB asynchronously
`matlab::engine::connectMATLAB`	Connect to shared MATLAB session synchronously
`matlab::engine::connectMATLABAsync`	Connect to shared MATLAB session asynchronously
`matlab::engine::findMATLAB`	Find shared MATLAB sessions synchronously
`matlab::engine::findMATLABAsync`	Find shared MATLAB sessions asynchronously
`matlab::engine::terminateEngineClient`	Free engine resources during run time

C++ Type Conversion Functions

`matlab::engine::convertUTF8StringToUTF16String`	Convert UTF-8 string to UTF-16 string
`matlab::engine::convertUTF16StringToUTF8String`	Convert UTF-16 string to UTF-8 string

MATLAB Functions

`matlab.engine.shareEngine`	Convert running MATLAB session to shared session
`matlab.engine.engineName`	Return name of shared MATLAB session
`matlab.engine.isEngineShared`	Determine if MATLAB session is shared
`matlab.engine.typedinterface.generateCPP`	Generate C++ code interface for MATLAB namespaces, classes, and functions (Since R2022a)
`mex`	Build MEX functions and engine or MAT file applications

Topics

Requirements

Requirements to Build C++ Engine Applications
Install and configure a compiler and run-time environment so you can build C++ applications to call MATLAB.
Set Up C++ Development Environment
Set up a development environment to write C++ applications that call MATLAB functions.

Integrate MATLAB Code in C++

Structure of C++ Engine Applications
Get started with the MATLAB Engine API for C++.
Integrate MATLAB Function in C++ Application
Create a C++ engine application using the MATLAB Engine and Data APIs.
Integrate Strongly Typed MATLAB Data in C++ Application
Use strongly typed data with the MATLAB Engine API for C++.

Start and Connect to MATLAB

Start MATLAB Sessions from C++
How to start and connect to a MATLAB session synchronously or asynchronously from C++.
Connect C++ to Running MATLAB Session
How to connect a C++ application to a MATLAB session that was started as or converted to a shared session.

Call MATLAB Functions

Call MATLAB Functions from C++
How to call MATLAB functions from C++, passing variables to MATLAB and returning variables to C++.
Evaluate MATLAB Statements from C++
How to evaluate MATLAB statements in your C++ program, and write variables to the MATLAB base workspace.
Pass Variables from C++ to MATLAB
How to pass variables from C++ to MATLAB as function arguments or by placing those variables directly into the MATLAB base workspace.
Pass Variables from MATLAB to C++
How to get variables from the MATLAB base or global workspace.
Redirect MATLAB Command Window Output to C++
How to redirect MATLAB Command Window output, including error messages, to your C++ program.
Convert C++ Engine Application to MATLAB Compiler SDK Application
Convert an engine application to a deployed application using MATLAB Compiler SDK™.

Use MATLAB Data Types in C++

Data Type Mappings Between C++ and Strongly Typed MATLAB Code
Refer to data type mappings between C++ and MATLAB when using strongly typed MATLAB code.
Create Structure Arrays from C++
How to create structure arrays in C++ and pass them to MATLAB, or retrieve structure arrays from MATLAB.
Create Cell Arrays from C++
How to create heterogeneous arrays in C++ to use as MATLAB cell arrays.
Pass Enumerations to MATLAB from C++
How to pass members of a MATLAB enumeration class to MATLAB from C++.
Pass Sparse Arrays to MATLAB from C++
How to pass arrays from C++ to MATLAB as MATLAB sparse arrays.
Use MATLAB Handle Classes in C++
Integrate MATLAB handle classes with C++ applications.
Limitations of Strongly Typed Interface for C++
Strongly typed interface for C++ features not supported in MATLAB.

Related Information

MATLAB Data API for C++

Featured Examples

Unrated 1 star 2 stars 3 stars 4 stars 5 stars