mxCalloc (外部インタフェース/API リファレンス)

MATLABのメモリマネージャを使ってダイナミックメモリを割り当て

C 言語表示

#include "matrix.h"
#include <stdlib.h>
void *mxCalloc(size_t n, size_t size);

引数
n
割り当てる要素数。これは、正の数値でなければなりません。

size

要素毎のバイト数(Cのsizeof演算子は、要素毎のバイト数を計算します)。

戻り値

成功した場合は、割り当てられたダイナミックメモリの先頭のポインタ。スタンドアロン(非MEX-ファイル)アプリケーションで成功しない場合、mxCallocはNULLを出力します。MEX-ファイルで成功しない場合、MEX-ファイルは終了し、制御はMATLABプロンプトに戻ります。

mxCallocは、十分なフリーのヒープ領域がない場合は成功しません。

詳細

MATLABアプリケーションは、常にcallocではなくmxCallocを呼び出してメモリを割り当てます。mxCallocは、スタンドアロンMATLABアプリケーションとMEX-ファイルとでは異なる動作をすることに注意してください。

MEX-ファイルでは、mxCallocはつぎのことを自動的に行います。

n個の要素を保持するための連続するヒープ領域を割り当てます。

n個の要素をすべて0に初期化します。

MATLABメモリ管理機能を使って出力されたヒープ領域を登録します。

MATLABメモリ管理機能は、mxCallocによって割り当てられたすべてのメモリのリストをもっています。MATLABメモリ管理機能は、制御がMATLABプロンプトに戻るときにすべてのMEX-ファイルを自動的に開放(デアロケート)します。

スタンドアロンMATLABアプリケーションでは、mxCallocはデフォルトでANSI C関数callocを呼び出します。このデフォルトの動作が好ましくない場合は、ユーザ自身がメモリ割り当てルーチンを書き、mxSetAllocFcnsを使ってそのルーチンを登録することができます。その後、mxCallocが呼び出されるときには、mxCallocはcallocの代わりにユーザ定義のメモリ割り当てルーチンを呼び出します。

デフォルトでは、MEX-ファイルではmxCallocは固定でないmxCallocデータを生成します。言い換えると、メモリ管理機能はMEX-ファイルが終了すると直ちにメモリを自動的に開放します。MEX-ファイルが終了した後でメモリを固定にしたい場合は、mxCallocを呼び出した後でmexMakeMemoryPersistentを呼び出してください。固定メモリを使ってMEX-ファイルを書く場合は、MEX-ファイルがクリアされるイベントで割り当てられたメモリを開放する関数mexAtExitを登録してください。

mxCallocによって割り当てられたメモリの利用を終了するときには、mxFreeを呼び出してください。mxFree はメモリを開放します。

例題

examplesディレクトリのmexサブディレクトリのexplore.cと、examplesディレクトリのrefbookサブディレクトリのphonebook.cとrevord.cを参照してください。

さらに、examplesディレクトリのmxサブディレクトリのmxcalcsinglesubscript.c, mxsetallocfcns.c, mxsetdimensions.cを参照してください。

参考

mxFree, mxDestroyArray, mexMakeArrayPersistent,
mexMakeMemoryPersistent, mxMalloc, mxSetAllocFcns

mxCalcSingleSubscript mxChar