Using the Function Reference (MATLAB C Math Library)

MATLAB C Math Library

Using the Function Reference

This reference gives you quick access to the prototypes and call syntax for the MATLAB C Math Library functions. The functions fall into two groups: the mathematical functions and the utility functions. This section discusses the organization of the reference pages.

Refer to the online Application Program Interface Reference for documentation of the mx routines that let you create, access, and delete arrays.

Reference Page Format

Use the reference pages to look up the prototype and syntax for a MATLAB C Math Library function. At the bottom of each page, you'll find a link to the documentation for the MATLAB version of the function. Use the MATLAB function page to look up the description of the arguments and the behavior of the function.

Structure

A reference page for a MATLAB C Math Library function includes these sections:

Purpose
C Prototype
C Syntax
MATLAB Syntax
See Also links to the MATLAB version of the function and to the calling conventions

One C prototype represents the MATLAB syntax.

To make the reference pages easier to read:

The variable names that appear in the "MATLAB Syntax" section are used as parameter names in the prototype for a function.
The first call to a function listed under "C Syntax" corresponds to the first call listed under "MATLAB Syntax." The second C call corresponds to the second MATLAB call, and so forth.

The "C Syntax" section shows only the calls supported by the library. When you link to the MATLAB version of the function, you may notice MATLAB syntax that supports objects. Because this version of the MATLAB C Math Library does not support objects, that documentation does not apply to the C version of the function.

Typographic Conventions

String arrays, including those that represent a function name, are italicized to indicate that you must assign a value to the variable.
In general, a lowercase variable name/argument indicates a vector.
In general, an uppercase variable name/argument indicates a matrix.

What Isn't Presented in the C Syntax Section

Assignments to input arguments
Calls to mlfEnterNewContext() and mlfRestorePreviousContext()
Deletion of allocated arrays (Calls to mxDestroyArray() are not shown.)

Exceptions

Occasionally, you'll find a C prototype where the parameter names do not match those used in the "MATLAB Syntax" section. The correspondence between the arguments used to call the function and the C prototype is too varied to represent in one prototype. O1, O2, etc., and I1, I2, etc., substitute for the output argument and input argument names in the prototype.
Occasionally, a call to mxCreateString() returns a string array that is used as an input argument; a call to mlfScalar() returns an integer array; a call to mlfHorzcat() returns a vector.

[ Previous | Help Desk | Next ]