WSGetRealArray （C 関数）

int WSGetRealArray(WSLINK link,double **a,long **dims,char ***heads,long *d)

link で指定されたWSTP接続から浮動小数点数の配列を得て，配列をa に，その次元をdims に，そしてその深さをd に保持しておく．

詳細

  • 配列a は， と宣言されたC言語の配列のようにメモリにレイアウトされる．
  • heads は，配列の各レベルに頭部として現れる記号名に対応する文字列のリストを返す．
  • WSGetRealArray()は，WSDisownRealArray()を呼び出して解放しなければならないメモリを割り当てる．WSGetRealArray()が不成功で関数の返す値がエラーを示す場合には，a のコンテンツについてWSReleaseRealArray()を呼び出してはならない．
  • WSGetRealArray()は不変のデータを返す．
  • WSGetRealArray()はエラーがあると0を返し，関数が成功すると0以外の値を返す．
  • WSError()を使うと，WSGetRealArray()が不成功の場合にエラーコードを引き出すことができる．
  • WSGetRealArray()はWSGetReal64Array()に等しい．

例題

例  (1)

#include "wstp.h"

/* read an array of double-precision floating-point numbers from a link */

void f(WSLINK lp)
{
    double *data;
    long *dims;
    char **heads;
    long d; /* stores the rank of the array */

    if(! WSGetRealArray(lp, &data, &dims, &heads, &d))
        {
            /* unable to read the array from lp */
            return;
        }

    /* ... */

    WSDisownRealArray(lp, data, dims, heads, d);    
}