mxSetPi (C)

(非推奨) mxDOUBLE_CLASS 配列内に虚数データ要素を設定

このページをすべて展開する

mxSetPi は、インターリーブされた複素数 API では使用できません。代わりに mxSetComplexDoubles を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

#include "matrix.h"
void mxSetPi(mxArray *pm, double *pi);

説明

mxSetPi を使用して、指定された mxArray の虚数データを設定します。

ほとんどの関数 mxCreate* は、虚数データを格納するためのヒープ領域をオプションで割り当てます。関数 mxCreate* の呼び出し時にヒープ領域を割り当てる場合は、mxSetPi を使用して配列の虚数要素を初期化しないでください。代わりに、この関数を呼び出して既存の値を新しい値に置換します。ヒープ領域の割り当ての例には、ComplexFlag を mxCOMPLEX に設定することや、pi を NULL 以外の値に設定することが含まれます。

関数 mxSetPi は、置き換え対象の既存データに割り当てられているメモリは解放しません。既存のメモリを解放するには、mxGetPi によって返されるポインター上で mxFree を呼び出します。

入力引数

すべて展開する

mxDOUBLE_CLASS 型の MATLAB 配列へのポインター。mxArray * として指定します。

mxArray 内にあるデータ配列の虚数部の最初の mxDouble 要素へのポインター。double * として指定します。配列内の各要素には、値の虚数部が含まれています。

配列は、動的メモリ内になければなりません。このメモリを割り当てるには mxCalloc を呼び出します。メモリの配置に問題が発生してプログラムが終了する可能性があるため、ANSI® C の関数 calloc は使用しないでください。pi が静的メモリを指している場合、メモリ リークや他のメモリ エラーが発生する場合があります。

バージョン履歴

R2006a より前に導入

すべて展開する

参考

トピック