mxCreateDoubleScalar (External Interfaces/API Reference)

Create scalar, double-precision array initialized to the specified value

Note This function replaces mxCreateScalarDouble in version 6.5 of MATLAB. mxCreateScalarDouble is still supported in version 6.5, but may be removed in a future version.

C Syntax

#include "matrix.h"
mxArray *mxCreateDoubleScalar(double value);

Arguments

value
The desired value to which you want to initialize the array.

Returns

A pointer to the created mxArray, if successful. mxCreateDoubleScalar is unsuccessful if there is not enough free heap space to create the mxArray. If mxCreateDoubleScalar is unsuccessful in a MEX-file, the MEX-file prints an "Out of Memory" message, terminates, and control returns to the MATLAB prompt. If mxCreateDoubleScalar is unsuccessful in a stand-alone (nonMEX-file) application, mxCreateDoubleScalar returns NULL.

Description

Call mxCreateDoubleScalar to create a scalar double mxArray. mxCreateDoubleScalar is a convenience function that can be used in place of the following code:

pa = mxCreateDoubleMatrix(1, 1, mxREAL);
*mxGetPr(pa) = value;

When you finish using the mxArray, call mxDestroyArray to destroy it.

See Also

mxGetPr, mxCreateDoubleMatrix

mxCreateDoubleMatrix mxCreateFull (Obsolete)