mxSetImagData (C)

数値 mxArray 内に虚数データ要素を設定

mxSetImagData は、インターリーブされた複素数 API では使用できません。代わりに、型付きのデータ アクセス関数を使用してください。詳細については、バージョン履歴を参照してください。

C 構文

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

説明

関数 mxSetImagData は mxSetPi と類似していますが、C では pi 引数が void * である点が異なります。この関数は、double 以外の内容をもつ数値配列に使用します。

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

入力引数

pm — MATLAB^® 配列へのポインター

mxArray*

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

pi — 複素数データ配列へのポインター

void*

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

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

バージョン履歴

R2006a より前に導入

R2018a: 実数/虚数分離型複素数 API は使用しない

MathWorks では、インターリーブされた複素数 API で型付きのデータ アクセス関数を使用するように、MEX ファイルを作成し、既存の MEX ファイルを更新することを推奨します。これらの関数は、入力配列が複素数であり、関数にとって正しい型であることを検証します。詳細については、以下を参照してください。

• C MEX ファイルでの型付きデータ アクセス

• MATLAB の MEX 関数におけるインターリーブされた複素数 API のサポート

• インターリーブされた複素数 API を使用するように MEX ファイルをアップグレード

MEX ファイルをビルドするには、-R2018a オプションを指定して mex を呼び出します。

R2018a: インターリーブされた複素数 API で mxSetImagData をビルドする際のエラー

関数 mxSetImagData は実数/虚数分離型複素数 API でのみ使用できます。この関数を使用して myMexFile.c をビルドするには、以下を入力します。

mex -R2017b myMexFile.c

この関数を使用してビルドされた既存の MEX ファイルは引き続き機能します。

参考

トピック

• C MEX ファイルでの型付きデータ アクセス
• MATLAB の MEX 関数におけるインターリーブされた複素数 API のサポート