Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

MATLAB API for Java

Write Java® programs that work with MATLAB®

Call MATLAB functions and evaluate MATLAB statements from Java programs synchronously or asynchronously. Java programs can pass data to and get data from the MATLAB base workspace. The engine supports Java applications built with JDK™ 7 or later versions.

To call Java functions from MATLAB, see Call Java Libraries.

Functions

matlab.engine.shareEngineConvert running MATLAB session to shared session
matlab.engine.engineNameReturn name of shared MATLAB session
matlab.engine.isEngineSharedDetermine if MATLAB session is shared

Classes

com.mathworks.engine.MatlabEngineJava class using MATLAB as a computational engine
com.mathworks.matlab.types.ComplexJava class to pass complex data to and from MATLAB
com.mathworks.matlab.types.StructJava class to pass MATLAB struct to and from MATLAB
com.mathworks.matlab.types.CellStrJava class to represent MATLAB cell array of char vectors
com.mathworks.matlab.types.HandleObjectJava class to represent MATLAB handle objects

Topics

Getting Started

MATLAB Engine API for Java

This API enables Java programs to use MATLAB as a computational engine.

Build Java Engine Programs

Set environment variables, Java classpath, and compile and run your Java code.

Java Example Source Code

These examples show how to use the MATLAB Engine API for Java.

Java Engine API Overview

Java Engine API Summary

Here is a summary of the classes and methods available to use the MATLAB Engine API for Java.

Java Data Type Conversions

The MATLAB engine API provides mappings to pass Java data types to MATLAB and pass MATLAB data types to Java, including Java classes to accommodate MATLAB handle objects, cellstrs, structures, and complex arrays.

Using the MATLAB Engine API for Java

Start and Close MATLAB Session from Java

Start the Java engine session synchronously or asynchronously and you can pass startup options to MATLAB.

Connect Java to Running MATLAB Session

Connect the Java engine to a running MATLAB session that has been started as or converted to a shared session.

Execute MATLAB Functions from Java

Pass Java variables to MATLAB function calls and return values to Java.

Evaluate MATLAB Statements from Java

Evaluate MATLAB expressions from Java and write variables into the MATLAB base workspace.

Pass Variables from Java to MATLAB

Pass variables from Java to MATLAB as function arguments or by placing those variables in the MATLAB base workspace.

Pass Variables from MATLAB to Java

Get variables from the MATLAB workspace and map them to the appropriate Java type.

Redirect MATLAB Command Window Output to Java

Redirect standard output from the MATLAB command window to Java.

Specialized MATLAB Types for Java

Using Complex Variables in Java

Define complex numbers in Java using the Complex class.

Using MATLAB Structures in Java

Define MATLAB structure data types in Java using the Struct class.

Pass Java CellStr to MATLAB

Define a MATLAB cell array of character vectors using the Java CellStr class.

Using MATLAB Handle Objects in Java

Return MATLAB handle objects to Java using the Java HandleObject class.

Using MATLAB Features from Java

Run Simulink Simulation from Java

You can run Simulink® simulations and return results to Java.

Troubleshooting

MATLAB Engine API Exceptions

The MATLAB Engine API for Java defines specific exception classes for MATLAB.

Pass Java Array Arguments to MATLAB

MATLAB and Java display multidimensional arrays differently, but indexed references to array elements produce the same results.

Incorrect Number of Output Arguments

If you are calling a MATLAB function with no or more than one output argument, you must provide that number in calls to the engine feval method.

Incorrect Java Data Types

In certain cases, you must convert to specific MATLAB types to support the requirements of the MATLAB function you are calling.

Related Information

Was this topic helpful?