exponenta event banner

mxGetScalar (C и Fortran)

Реальная составляющая первого элемента данных в массиве

Синтаксис C

#include "matrix.h"
double mxGetScalar(const mxArray *pm);

Синтаксис Фортрана

#include "fintrf.h"
real*8 mxGetScalar(pm)
mwPointer pm

Аргументы

pm

Указатель на mxArray; не может быть ячейкой mxArray, структура mxArray, или пустой mxArray.

Прибыль

Значение первого действительного (невообразимого) элемента mxArray.

В C, mxGetScalar возвращает double. Если реальные элементы в mxArray относятся к типу, отличному от double, то mxGetScalar автоматически преобразует скалярное значение в double. Чтобы сохранить исходное представление данных скаляра, приведите возвращаемое значение к требуемому типу данных.

Если pm указывает на разрежение mxArray, то mxGetScalar возвращает значение первого ненулевого вещественного элемента в mxArray. Если ненулевых элементов нет, функция возвращает 0.

Описание

Звонить mxGetScalar для получения значения первого действительного (невообразимого) элемента mxArray.

Обычно вы звоните mxGetScalar когда pm указывает на mxArray содержит только один элемент (скаляр). Однако pm может указывать на mxArray содержит множество элементов. Если pm указывает на mxArray содержащий несколько элементов, то функция возвращает значение первого действительного элемента. Например, если pm указывает на двумерный mxArray, то mxGetScalar возвращает значение (1,1) элемент. Если pm указывает на трехмерный mxArray, то функция возвращает значение (1,1,1) элемент; и так далее.

Использовать mxGetScalar на непустом mxArray типа numeric, logical или char. Для проверки этих условий используйте функции библиотеки матриц, такие как mxIsEmpty, mxIsLogical, mxIsNumeric, или mxIsChar.

Если входное значение равно mxGetScalar является типом int64 или uint64, то значение может потерять точность, если оно больше, чем flintmax.

Примеры

См. эти примеры в разделе matlabroot/extern/examples/refbook:

См. эти примеры в разделе matlabroot/extern/examples/mex:

См. эти примеры в разделе matlabroot/extern/examples/mx:

См. также

mxGetM, mxGetN, mxIsScalar