Learn more about MATLAB

mxCreateDoubleScalar (C and Fortran) - Create scalar, double-precision array initialized to specified value

C Syntax

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

Fortran Syntax

mwPointer mxCreateDoubleScalar(value)
real*8 value

Arguments

value

Value to which you want to initialize the array

Returns

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 (non-MEX-file) application, mxCreateDoubleScalar returns NULL in C (0 in Fortran).

Description

Call mxCreateDoubleScalar to create a scalar double mxArray. When you finish using the mxArray, call mxDestroyArray to destroy it.

Alternatives

C Language

In C, you can replace the statements:

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

with a call to mxCreateDoubleScalar:

pa = mxCreateDoubleScalar(value);

Fortran Language

In Fortran, you can replace the statements:

pm = mxCreateDoubleMatrix(1, 1, 0)
mxCopyReal8ToPtr(value, mxGetPr(pm), 1)

with a call to mxCreateDoubleScalar:

pm = mxCreateDoubleScalar(value)

See Also

mxGetPr, mxCreateDoubleMatrix

mxCreateDoubleMatrix (C and Fortran)

mxCreateLogicalArray (C)

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS