MATLAB C/C++, Fortran, and Python API Reference

372 Pages·2016·1.29 MB·English

®
MATLAB
C/C++, Fortran, Java, and Python API Reference
R2017a
How to Contact MathWorks
Latest news: www.mathworks.com
Sales and services: www.mathworks.com/sales_and_services
User community: www.mathworks.com/matlabcentral
Technical support: www.mathworks.com/support/contact_us
Phone: [phone]
The MathWorks, Inc.
3 Apple Hill Drive
Natick, MA 01760-2098
® ® ®
MATLAB C/C++, Fortran, Java , and Python API Reference
© COPYRIGHT 1984–2017 by The MathWorks, Inc.
The software described in this document is furnished under a license agreement. The software may be used
or copied only under the terms of the license agreement. No part of this manual may be photocopied or
reproduced in any form without prior written consent from The MathWorks, Inc.
FEDERAL ACQUISITION: This provision applies to all acquisitions of the Program and Documentation
by, for, or through the federal government of the United States. By accepting delivery of the Program
or Documentation, the government hereby agrees that this software or documentation qualifies as
commercial computer software or commercial computer software documentation as such terms are used
or defined in FAR 12.212, DFARS Part 227.72, and DFARS 252.227-7014. Accordingly, the terms and
conditions of this Agreement and only those rights specified in this Agreement, shall pertain to and
govern the use, modification, reproduction, release, performance, display, and disclosure of the Program
and Documentation by the federal government (or other entity acquiring for or through the federal
government) and shall supersede any conflicting contractual terms or conditions. If this License fails
to meet the government's needs or is inconsistent in any respect with federal procurement law, the
government agrees to return the Program and Documentation, unused, to The MathWorks, Inc.
Trademarks
MATLAB and Simulink are registered trademarks of The MathWorks, Inc. See
www.mathworks.com/trademarks for a list of additional trademarks. Other product or brand
names may be trademarks or registered trademarks of their respective holders.
Patents
MathWorks products are protected by one or more U.S. patents. Please see
www.mathworks.com/patents for more information.
Revision History
December 1996 First Printing New for MATLAB 5 (Release 8)
May 1997 Online only Revised for MATLAB 5.1 (Release 9)
January 1998 Online Only Revised for MATLAB 5.2 (Release 10)
January 1999 Online Only Revised for MATLAB 5.3 (Release 11)
September 2000 Online Only Revised for MATLAB 6.0 (Release 12)
June 2001 Online only Revised for MATLAB 6.1 (Release 12.1)
July 2002 Online only Revised for MATLAB 6.5 (Release 13)
January 2003 Online only Revised for MATLAB 6.5.1 (Release 13SP1)
June 2004 Online only Revised for MATLAB 7.0 (Release 14)
October 2004 Online only Revised for MATLAB 7.0.1 (Release 14SP1)
March 2005 Online only Revised for MATLAB 7.0.4 (Release 14SP2)
September 2005 Online only Revised for MATLAB 7.1 (Release 14SP3)
March 2006 Online only Revised for MATLAB 7.2 (Release 2006a)
September 2006 Online only Revised for MATLAB 7.3 (Release 2006b)
March 2007 Online only Revised and renamed for MATLAB 7.4
(Release 2007a)
September 2007 Online only Revised and renamed for MATLAB 7.5
(Release 2007b)
March 2008 Online only Revised and renamed for MATLAB 7.6
(Release 2008a)
October 2008 Online only Revised and renamed for MATLAB 7.7
(Release 2008b)
March 2009 Online only Revised for MATLAB 7.8 (Release 2009a)
September 2009 Online only Revised for MATLAB 7.9 (Release 2009b)
March 2010 Online only Revised and renamed for MATLAB 7.10
(Release 2010a)
September 2010 Online only Revised for MATLAB 7.11 (Release 2010b)
April 2011 Online only Revised for MATLAB 7.12 (Release 2011a)
September 2011 Online only Revised for MATLAB 7.13 (Release 2011b)
March 2012 Online only Revised for MATLAB 7.14 (Release 2012a)
September 2012 Online only Revised for MATLAB 8.0 (Release 2012b)
March 2013 Online only Revised for MATLAB 8.1 (Release 2013a)
September 2013 Online only Revised for MATLAB 8.2 (Release 2013b)
March 2014 Online only Revised for MATLAB 8.3 (Release 2014a)
October 2014 Online only Revised for MATLAB 8.4 (Release 2014b)
March 2015 Online only Revised for MATLAB 8.5 (Release 2015a)
September 2015 Online only Revised for MATLAB 8.6 (Release 2015b)
March 2016 Online only Revised for MATLAB 9.0 (Release 2016a)
September 2016 Online only Revised for MATLAB 9.1 (Release 2016b)
March 2017 Online only Revised for MATLAB 9.2 (Release 2017a)
Contents
API Reference
1
v
1
API Reference
1 API Reference
com.mathworks.engine.MatlabEngine class
Package: com.mathworks.engine
Java class using MATLAB as a computational engine
Description
®
The com.mathworks.engine.MatlabEngine class uses a MATLAB process as a
®
computational engine for Java . This class provides an interface between the Java
language and MATLAB, enabling you to evaluate MATLAB functions and expressions
from Java.
Constructor Summary
The MatlabEngine class provides static methods to start MATLAB and to connect to a
shared MATLAB session synchronously or asynchronously. Only these static methods
can instantiate this class:
• Start MATLAB synchronously — “startMatlab” on page 1-4
• Connect to shared MATLAB session synchronously — “connectMatlab” on page
1-7
• Start MATLAB asynchronously — “startMatlabAsync” on page 1-5
• Connect to shared MATLAB session asynchronously — “connectMatlabAsync” on
page 1-8
Unsupported Startup Options
The engine does not support these MATLAB startup options:
• -h
• -help
• -?
• -n
1-2
com.mathworks.engine.MatlabEngine class
• -e
• -softwareopengl
• -logfile
For information on MATLAB startup options, see “Commonly Used Startup Options”.
Method Summary
Static Methods
“startMatlab” on Start MATLAB synchronously.
page 1-4
“startMatlabAsyncS” tart MATLAB asynchronously.
on page 1-5
“findMatlab” on Find all available shared MATLAB sessions from a local machine
page 1-6 synchronously.
“findMatlabAsync”Find all available shared MATLAB sessions from a local machine
on page 1-6 asynchronously.
“connectMatlab” Connect to a shared MATLAB session on a local machine
on page 1-7 synchronously.
“connectMatlabAsyCncon”nect to a shared MATLAB session on a local machine
on page 1-8 asynchronously.
Member Variable
NULL_WRITER Use a writer that ignores the contents from the MATLAB
command window.
Member Functions
“feval” on page Evaluate a MATLAB function with arguments synchronously.
1-8
“fevalAsync” on Evaluate a MATLAB function with arguments asynchronously.
page 1-10
1-3
1 API Reference
“eval” on page Evaluate a MATLAB expression as a string synchronously.
1-11
“evalAsync” on Evaluate a MATLAB expression as a string asynchronously.
page 1-12
“getVariable” on Get a variable from the MATLAB base workspace synchronously.
page 1-13
“getVariableAsyncG” et a variable from the MATLAB base workspace asynchronously.
on page 1-14
“putVariable” on Put a variable into the MATLAB base workspace synchronously.
page 1-14
“putVariableAsyncP” ut a variable into the MATLAB base workspace asynchronously.
on page 1-15
“disconnect” on Disconnect from the current MATLAB session synchronously.
page 1-16
“disconnectAsync”Disconnect from the current MATLAB session asynchronously.
on page 1-16
“quit” on page Force the shutdown of the current MATLAB session
1-17 synchronously.
“quitAsync” on Force the shutdown of the current MATLAB session
page 1-17 asynchronously.
“close” on page Disconnect or terminate the current MATLAB session.
1-18
Method Details
startMatlab
static MatlabEngine startMatlab(String[] options)
static MatlabEngine startMatlab()
Description
Start MATLAB synchronously.
1-4