8

C/C++ で記述された関数をMathematicaにリンクする方法を理解し始めていると思います。私が直面している問題は、C ラッパーから Mathematica にエラー メッセージを送信する方法がわからないことです。Google で検索した後、このMathLink Tutorialを見つけました。

セクション 1.7 で、エラー メッセージを送信する方法についての洞察が得られましたが、奇妙な結果が得られています。ここに私が取り組んでいるコードがあります。


//File cppFunctions.h
#ifndef CPPFUNCTIONS_H
#define CPPFUNCTIONS_H
class Point {
public:
    double x, y;
    Point(){ x=y=0.0;}
    Point(double a, double b): x(a), y(b) {}
};
class Line {
public:
    Point p1, p2;
    Line(void) {}
    Line(const Point &P, const Point &Q): p1(P), p2(Q) {}
    double distanceTo(const Line &M, const double &EPS = 0.000001){
        double x21 = p2.x - p1.x;     double y21 = p2.y - p1.y;
        double x43 = M.p2.x - M.p1.x; double y43 = M.p2.y - M.p1.y;
        double x13 = p1.x - M.p1.x;   double y13 = p1.y - M.p1.y;
        double den = y43*x21 - x43*y21;
        if (den*den < EPS) return -INFINITY;
        double numL = (x43*y13 - y43*x13)/den;
        double numM = (x21*y13 - y21*x13)/den;
        if (numM < 0 || numM > 1) return -INFINITY;
        return numL;
    }
};
#endif

ファイル cppFunctions.h は、クラスPointLine. Mathematicaで使用したい関数を除いて、このクラスを最小限に抑えました。ある線から別の線までの距離を見つけたい。この関数は Mathematica のlineIntin wireframesの C バージョンです。この関数をMathematicaで使用するには、 Mathematicaから入力を取得し、出力をMathematicaに送り返すラッパー関数が必要です。


//mlwrapper.cpp
#include "mathlink.h"
#include <math.h>
#include "cppFunctions.h"

void ML_GetPoint(Point &P){
    long n;
    MLCheckFunction(stdlink, "List", &n);
    MLGetReal64(stdlink, &P.x);
    MLGetReal64(stdlink, &P.y);
}
void ML_GetLine(Line &L){
    long n;
    MLCheckFunction(stdlink, "List", &n);
    ML_GetPoint(L.p1);
    ML_GetPoint(L.p2);
}
double LineDistance(void) {
    Line L, M;
    ML_GetLine(L);
    ML_GetLine(M);
    return L.distanceTo(M);
}
int main(int argc, char* argv[]) {
    return MLMain(argc, argv);
}

Mathematicaからの入力を取得するために、ML_GetPointとの2 つのヘルパー関数を作成しました。2 つのリストを含むリストから行を取得します。各サブリストは、2 つの実数 (点) のリストです。Mathematica でこの関数を試すには、さらにファイルが必要です。ML_GetLine


//mlwrapper.tm
double LineDistance P((void));
:Begin:
:Function: LineDistance
:Pattern: LineDistance[L_List, M_List]
:Arguments: {L, M}
:ArgumentTypes: {Manual}
:ReturnType: Real
:End:
:Evaluate: LineDistance::usage = "LineDistance[{{x1,y1}, {x2,y2}}, {{x3,y3}, {x4,y4}}] gives the distance between two lines."
:Evaluate: LineDistance::mlink = "There has been a low-level MathLink error. The message is: `1`"

このファイルには、関数 LineDistance が引数を手動で取得し、実数を返すことが記載されています。最後の 2 行が重要です。1 つ目は、関数の をEvaluate宣言しusageます。をMathematica?LineDistanceに入力すると、関数に関する簡単なメッセージが表示されます。もう1 つは、エラーが発生したときに使用したいものです (これについては後で詳しく説明します)。Evaluate


#Makefile
VERSION=8.0
MLINKDIR = .
SYS = MacOSX-x86-64
CADDSDIR = /Applications/Mathematica.app/SystemFiles/Links/MathLink/DeveloperKit/CompilerAdditions

INCDIR = ${CADDSDIR}
LIBDIR = ${CADDSDIR}

MPREP = ${CADDSDIR}/mprep
RM = rm

CXX = g++

BINARIES = mlwrapper

all : $(BINARIES)

mlwrapper : mlwrappertm.o mlwrapper.o
    ${CXX} -I${INCDIR} mlwrappertm.o mlwrapper.o -L${LIBDIR} -lMLi3 -lstdc++ -framework Foundation -o $@

.cpp.o :
    ${CXX} -c -I${INCDIR} $<

mlwrappertm.cpp : mlwrapper.tm
    ${MPREP} $? -o $@

clean :
    @ ${RM} -rf *.o *tm.c mlwrappertm.cpp

最後のファイルは Makefile です。この時点で、Mathematica で関数をテストする準備が整いました。


Mac OS X を使用していることを前に述べておく必要がありましたが、これが Windows でどのように機能するかはわかりません。mlwrapper.cpp では、メイン関数にさらに多くのコードが必要です。これはMathematicaが提供する例の 1 つに見られます。

私が知っている端末でこれを行う:

make > makelog.txt
make clean

これにより、実行可能ファイルが作成されますmlwrapper。これで Mathematica を使い始めることができます:

SetDirectory[NotebookDirectory[]];
link = Install["mlwrapper"];
?LineDistance
Manipulate[
 Grid[{{
    Graphics[{
      Line[{p1, p2}, VertexColors -> {Red, Red}],
      Line[{p3, p4}]
    },
    PlotRange -> 3, Axes -> True],
   LineDistance[{p1, p2}, {p3, p4}]
  }}],
{{p1, {-1, 1}}, Locator, Appearance -> "L1"},
{{p2, {2, 1}}, Locator, Appearance -> "L2"},
{{p3, {2, -2}}, Locator, Appearance -> "M1"},
{{p4, {2, 3}}, Locator, Appearance -> "M2"}

]

得られる出力は次のとおりです。

出力

正しい引数を入力する限り、すべて正常に機能します。つまり、2 つのリストがあり、それぞれが 2 つの double の 2 つのリストのリストです。入力を取得する別の方法があるかもしれません。方法を知っている場合は、私に知らせてください。この方法に固執する場合、必要なのはMathematicaユーザにエラーがあるかどうかを知らせる方法だけです。非常に単純なものは、間違った入力を入力することです。これを入力するとしましょう:

LineDistance[{{0, 0}, {0}}, {{1, -1}, {1, 1}}]

出力は$Failedです。以下はどうでしょう。

LineDistance[{{1, -1}, {1, 1}}]

出力はLineDistance[{{1, -1}, {1, 1}}]です。Patternのセクションで、関数が 2 つのリストを受け入れることを説明したため、これが発生したと推測し.tmています。これは本当ですか?

いずれにせよ、私が見つけたチュートリアルに従って、ファイル mlwrapper.cpp を次のように変更します。

#include "mathlink.h"
#include <math.h>
#include <string>
#include "cppFunctions.h"

bool ML_Attempt(int func, const char* err_tag){
    if (!func) {
        char err_msg[100];
        sprintf(err_msg, "Message[%s,\"%.76s\"]", err_tag, MLErrorMessage(stdlink));
        MLClearError(stdlink); MLNewPacket(stdlink); MLEvaluate(stdlink, err_msg);
        MLNextPacket(stdlink); MLNewPacket(stdlink); MLPutSymbol(stdlink, "$Failed");
        return false;
    }
    return true;
}
void ML_GetPoint(Point &P){
    long n;
    if(!ML_Attempt(MLCheckFunction(stdlink, "List", &n), "LineDistance::mlink2"))return;
    if(!ML_Attempt(MLGetReal64(stdlink, &P.x), "LineDistance::mlink3")) return;
    if(!ML_Attempt(MLGetReal64(stdlink, &P.y), "LineDistance::mlink4")) return;
}
void ML_GetLine(Line &L){
    long n;
    if(!ML_Attempt(MLCheckFunction(stdlink, "List", &n), "LineDistance::mlink1"))return;
    ML_GetPoint(L.p1);
    ML_GetPoint(L.p2);
}
double LineDistance(void) {
    Line L, M;
    ML_GetLine(L);
    ML_GetLine(M);
    return L.distanceTo(M);
}
int main(int argc, char* argv[]) {
    return MLMain(argc, argv);
}

mlwrapper.tm ファイルの末尾に次を追加します。

:Evaluate: LineDistance::mlink1 = "There has been a low-level MathLink error. The message is: `1`"
:Evaluate: LineDistance::mlink2 = "There has been a low-level MathLink error. The message is: `1`"
:Evaluate: LineDistance::mlink3 = "There has been a low-level MathLink error. The message is: `1`"
:Evaluate: LineDistance::mlink4 = "There has been a low-level MathLink error. The message is: `1`"

make を使って、Mathematica で間違いを犯してみましょう。

すべてを書くのではなく、どの出力のスクリーンショットを投稿しています。

出力

呼び出しを繰り返すと、さまざまなエラーが発生することに注意してください。エラーが発生した次の行で機能が継続しているようです。関数のような他の ML 関数を使用せず、エラー タグを送信するためML_Attemptだけに使用するMLEvaluate場合、MathLink が壊れているため、リンクを再インストールする必要があります。CからMathematicaにエラー メッセージを送信する方法を知っている人はいますか?


アップデート:

与えられた回答と別の有用なドキュメント(第 8 章) に基づいて、なんとか機能させることができました。現時点ではコードはそれほどきれいではありませんが、これにより、次の質問をするようになりました。機能を早期に終了することはできますか? 通常の C プログラムでは、エラーが発生した場合、エラー メッセージを出力してexit関数を使用します。似たようなことはできますか?この機能を使用するexitと、リンクが壊れ、機能を再インストールする必要があります。たとえば、関数ML_GetPointを取り上げます。ML_GetLineここでエラーが発生した場合、main 関数で計算を実行しても意味がありませんLineDistance。取得したエラーをすべてクリアし、エラーを指定して Mathematica にメッセージを送信し、いったん終了して次の呼び出しを待つ必要があります。

4

3 に答える 3

4

@ragfieldによる解決策の代わりに、関数をとして宣言しvoid、結果を手動で返すことができます。addTwoこれは、標準的な例に基づく例です。テンプレートは次のとおりです。

void addtwo P(( int, int));

:Begin:
:Function:       addtwo
:Pattern:        AddTwo[i_Integer, j_Integer]
:Arguments:      { i, j }
:ArgumentTypes:  { Integer, Integer }
:ReturnType:     Manual
:End:

:Evaluate: AddTwo::usage = "AddTwo[x, y] gives the sum of two machine 
    integers x and y."
:Evaluate: AddTwo::badargs = "Arguments are expected to be positive numbers"

および機能:

void addtwo( int i, int j) {
    if(i>0&&j>0){
        MLPutInteger(stdlink,i+j);
    }else{
        MLPutFunction(stdlink,"CompoundExpression",2);
            MLPutFunction(stdlink,"Message",1);
                MLPutFunction(stdlink,"MessageName",2);
                    MLPutSymbol(stdlink,"AddTwo");
                    MLPutString(stdlink,"badargs");
            MLPutSymbol(stdlink,"$Failed");
    }
}

使用例は次のとおりです。

In[16]:= AddTwo[1,2]
Out[16]= 3

In[17]:= AddTwo[-1,2]
During evaluation of In[17]:= AddTwo::badargs: Arguments are expected 
to be positive numbers

Out[17]= $Failed

これは、それを行うためのもう少し「高レベル」の方法です。このようにして、パケットを明示的に処理する必要はありません。

しかし、入力引数の完全なエラーチェックは、適切なパターンと、Cコードで検出されたいくつかの内部エラーのために保存されたエラーメッセージのオプションを介してMathematica側で実行する方が良いと思います(実際にはさらに進んでMathematicaに戻ります整数または文字列としてのエラーコードだけで、高レベルのmmaラッパーがそれらを処理してメッセージを発行できるようにします)。これらのパターンをテンプレートファイルに配置するか、MathLinkMathematica関数をエラーチェックを実行する別の関数にラップすることができます。私はMathlinkの経験が非常に限られているので、ここでの私の意見はおそらくそれほど重要ではないはずです。

編集

コメントのリクエストごと(リクエストを正しく理解したかどうかはわかりませんでしたが):

extern void addeight( void );
extern void addall(void);

static void putErrorMessageAndReturnFailure(const char *fname, const char *msgtag);

void addeight(void)
{
    int i,j,k,l,i1,j1,k1,l1;
    MLGetInteger(stdlink,&i);
    MLGetInteger(stdlink,&j);
    MLGetInteger(stdlink,&k);
    MLGetInteger(stdlink,&l);
    MLGetInteger(stdlink,&i1);
    MLGetInteger(stdlink,&j1);
    MLGetInteger(stdlink,&k1);
    MLGetInteger(stdlink,&l1);

    if(i<0||j<0||k<0||l<0||i1<0||j1<0||k1<0||l1<0){
        putErrorMessageAndReturnFailure("AddEight","badargs");              
    }else{
            MLPutFunction(stdlink,"List",2);
            MLPutFunction(stdlink,"List",2);
                MLPutInteger(stdlink,i+i1);
                MLPutInteger(stdlink,j+j1);
            MLPutFunction(stdlink,"List",2);
                MLPutInteger(stdlink,k+k1);
                MLPutInteger(stdlink,l+l1);
    }   
}

void addall(){
    int *data, len, i = 0,sum = 0;
    if(!MLGetIntegerList(stdlink, &data, &len)){
        putErrorMessageAndReturnFailure("AddAll","interr");
        return;
    }
    for(i=0;i<len;i++){
        if(data[i]<0){
            putErrorMessageAndReturnFailure("AddAll","badargs");
            return;
        }else{
            sum+=data[i];
        }
    }
    MLPutInteger(stdlink,sum);
        MLReleaseInteger32List(stdlink, data, len);
}


static void putErrorMessageAndReturnFailure(const char *fname, const char *msgtag){
    MLPutFunction(stdlink,"CompoundExpression",2);
        MLPutFunction(stdlink,"Message",1);
                MLPutFunction(stdlink,"MessageName",2);
                    MLPutSymbol(stdlink,fname);
                    MLPutString(stdlink,msgtag);
        MLPutSymbol(stdlink,"$Failed");
}

とテンプレート

void addeight P(( ));

:Begin:
:Function:       addeight
:Pattern:        AddEight[{{i_Integer, j_Integer},{k_Integer,l_Integer}},{{i1_Integer,j1_Integer},{k1_Integer,l1_Integer}}]
:Arguments:      { i, j, k ,l, i1,j1,k1,l1 }
:ArgumentTypes:  { Manual }
:ReturnType:     Manual
:End:

:Evaluate: AddEight::usage = "AddEight[{{i_Integer, j_Integer},{k_Integer,l_Integer}}, {{i1_Integer, j1_Integer},{k1_Integer,l1_Integer}}] gives the sum as a list: {{i+i1,j+j1},{k+k1,l+l1}}."

:Evaluate: AddEight::badargs = "Arguments are expected to be positive numbers"


void addall P(( ));

:Begin:
:Function:       addall
:Pattern:        AddAll[fst:{{_Integer, _Integer},{_Integer,_Integer}},sec:{{_Integer, _Integer},{_Integer,_Integer}}]
:Arguments:      { Flatten[{fst,sec}]}
:ArgumentTypes:  { Manual }
:ReturnType:     Manual
:End:

:Evaluate: AddAll::usage = "AddAll[{{i_Integer, j_Integer},{k_Integer,l_Integer}},{{i1_Integer, j1_Integer},{k1_Integer,l1_Integer}}] gives the total sum of elemens of the sub-lists."

:Evaluate: AddAll::badargs = "Arguments are expected to be positive numbers"

:Evaluate: AddAll::interr = "Internal error - error getting the data from Mathematica"

例:

In[8]:= AddEight[{{1,2},{3,4}},{{5,6},{7,8}}]
Out[8]= {{6,8},{10,12}}

In[9]:= AddEight[{{-1,2},{3,4}},{{5,6},{7,8}}]
During evaluation of In[9]:= AddEight::badargs: Arguments are expected to be positive numbers

Out[9]= $Failed

In[10]:= AddAll[{{1,2},{3,4}},{{5,6},{7,8}}]
Out[10]= 36

In[11]:= AddAll[{{-1,2},{3,4}},{{5,6},{7,8}}]
During evaluation of In[11]:= AddAll::badargs: Arguments are expected to be positive numbers

Out[11]= $Failed
于 2011-06-29T21:22:07.183 に答える
3

このようなものは通常私にとってはうまくいきます:

void putMessage(const char* messageSymbol, const char* messageTag, const char* messageParam)
{
    MLNewPacket(stdlink);
    MLPutFunction(stdlink, "EvaluatePacket", 1);

    MLPutFunction(stdlink, "Message", 2);
        MLPutFunction(stdlink, "MessageName", 2);
            MLPutSymbol(stdlink, messageSymbol);
            MLPutString(stdlink, messageTag);

        MLPutString(stdlink, messageParam);

    MLFlush(stdlink);
    MLNextPacket(stdlink);
    MLNewPacket(stdlink);
}

結果を返す必要があります。

MLPutSymbol(stdlink, "$Failed");
于 2011-06-29T20:59:25.337 に答える
2

この投稿は、私が最終的なコードをどのように書いたかに興味のある人を対象としています。このコードは、@Leonidとの有益な議論に基づいています。ユーティリティファイルから始めましょう。


//MLErrors.h
#include <stdarg.h>
#include <vector>
#include <sstream>

#define CCHAR const char*
#define UINT unsigned int
class MLException {
public:
    CCHAR sym;
    CCHAR tag;
    std::vector<std::string> err;
    MLException(CCHAR msgSym, CCHAR msgTag, UINT n, ...): 
    sym(msgSym), tag(msgTag), err(n)
    {
        std::stringstream ss;
        va_list args;
        va_start(args, n);
        for (UINT i=0; i < n; ++i) {
            err[i] = va_arg(args, CCHAR);
            if (err[i][0] == '%') {
                switch (err[i][1]) {
                    case 'i':
                        ss << va_arg(args, int);
                        break;
                    case 'd':
                        ss << va_arg(args, double);
                        break;
                    default:
                        break;
                }
                err[i] = ss.str();
            }
        }
        va_end(args);
    }
};
#undef CCHAR
#undef UINT

void ML_SendMessage(const MLException& e){
    if (MLError(stdlink) != MLEOK) MLClearError(stdlink); 
    MLNewPacket(stdlink); 
    MLPutFunction(stdlink, "EvaluatePacket", 1);
    MLPutFunction(stdlink, "Message", e.err.size()+1);
    MLPutFunction(stdlink, "MessageName", 2);
    MLPutSymbol(stdlink, e.sym);
    MLPutString(stdlink, e.tag);
    for (int i=0; i < e.err.size(); ++i) {
        MLPutString(stdlink, e.err[i].c_str());
    }
    MLFlush(stdlink);
    MLNextPacket(stdlink);
    MLNewPacket(stdlink);
    MLPutSymbol(stdlink, "$Failed");
}

このファイルには、MLExceptionクラスと関数が含まれていますML_SendMessage。これが簡単な説明です。このタイプのオブジェクトには、MLException2つの文字列と文字列のベクトルが含まれています。の場合eMLExceptionそれは有効なMathematicaシンボルと有効なタグe.symでなければなりません。これはテンプレートファイルで定義します。パラメータが含まれている場合、それらはに格納されます。たとえば、テンプレートファイルで次のように宣言したとします。e.tagSymbol::tagSymbol::tage.err

:Evaluate: someSymbol::someTag = "Error, the program encountered: `1`, it needed `2`."

次に、何らかの理由でC関数にエラーが発生した場合は、メッセージを含む例外をスローすることで、そこから抜け出すことができます。このような:

if(ERROR) throw MLException("someSymbol", "someTag", 2, "this", "that");

3番目の引数が整数であることに注意してください。これは、メッセージの「1」と「2」の代わりに配置されるメッセージの数です。これは、Mathematicaに表示されるメッセージが「エラー、発生したプログラム:これ、それが必要だった」ということを意味します。メッセージに数字を含める必要がある場合は、文字列の後に数字を書くように作成しました。たとえば、数値100を書き込んでから他のメッセージを書き込みたい場合は、次のような例外をスローできます。

 if(ERROR) throw MLException("someSymbol", "someTag", 2, "%i", 100, "msg");

ダブルを含める場合は、代わりに「%d」を使用してください。

この関数は例外を受け取り、エラーをクリアし、 MathematicaML_sendMessageにメッセージを送信して、を入れます。$Failed

これが私のテンプレートファイルです:

//mlwrapper.tm
:Evaluate: BeginPackage["mlwrapper`"]

:Evaluate: EMPH[a_] := ToString[Style[a, "TI"], StandardForm]
:Evaluate: LINK[url_, label_ : Style["\[RightSkeleton]", "SR"]] := ToString[Hyperlink[label, url], StandardForm]
:Evaluate: LineDistance::usage = "LineDistance["<>EMPH["L"]<>", "<>EMPH["M"]<>"] gives the distance between two lines. "<>LINK["#"]

:Evaluate: mlwrapper::mlink = "There has been a low-level MathLink error. The message is: `1`"
:Evaluate: GetPoint::narg = "A point is a list of 2 numbers. A list of `1` elements was passed instead. "<>LINK["#"]
:Evaluate: GetLine::narg = "A line is a list of 2 points. A list of `1` elements was passed instead. "<>LINK["#"]

:Evaluate: EndPackage[]

:Evaluate: Begin["mlwrapper`Private`"]

void LineDistance P((void));
:Begin:
:Function: LineDistance
:Pattern: LineDistance[L_List, M_List]
:Arguments: {L, M}
:ArgumentTypes: {Manual}
:ReturnType: Manual
:End:

:Evaluate: End[]

これをパッケージにすることにしました。EMPH関数とも宣言しLINKました。最初のものは単語を強調し、もう1つはハイパーリンクを書くことを可能にします。適切に文書化する方法を学んだら、説明にハイパーリンクを追加します。

これで、 Mathematicaの場合と同じ方法でエラーを記述できます。

//mlwrapper.cpp
#include "mathlink.h"
#include "MLErrors.h"
#include <cmath>
#include "cppFunctions.h"

#define MLINKERROR MLException("mlwrapper", "mlink", 1, MLErrorMessage(stdlink))

void ML_GetPoint(Point &P){
    long n = 0;
    MLCheckFunction(stdlink, "List", &n);
    if (n != 2) throw MLException("GetPoint", "narg", 1, "%i", n);
    MLGetReal64(stdlink, &P.x);
    MLGetReal64(stdlink, &P.y);
    if (MLError(stdlink) != MLEOK) throw MLINKERROR;
}
void ML_GetLine(Line &L){
    long n = 0;
    MLCheckFunction(stdlink, "List", &n);
    if (n != 2) throw MLException("GetLine", "narg", 1, "%i", n);
    ML_GetPoint(L.p1);
    ML_GetPoint(L.p2);
}
void LineDistance(void) {
    Line L, M;
    try {
        ML_GetLine(L);
        ML_GetLine(M);
    }
    catch (MLException& e) {
        ML_SendMessage(e);
        return;
    }
    MLPutReal64(stdlink, L.distanceTo(M));
}
int main(int argc, char* argv[]) {
    return MLMain(argc, argv);
}

ここで、パッケージを作成しているので、最後の1つのファイルmlwrapper.mが必要です。このファイルに次の行を追加します:Install["mlwrapper"];mlwrapperもちろん、実行可能ファイルは同じディレクトリにあると想定しています。最後に、結果のスクリーンショットを示します。

出力

私は、例外のオーバーヘッドについて考えるために最後のステートメントを書きました。私は主に、例外が入力の取得と、C /C++関数からのreturnステートメントに基づく他のエラーを処理することを望んでいます。いずれにせよ、例外なしでラッパーを作成することは、例外を使用する場合よりもはるかにうまくいきませんでした。

だからあなたはそれを持っています。MathematicaからC/C++関数を呼び出す方法の別の例。

EMPHまた、@alexey-popkovに書き込みとのアイデアを与えてくれたことに感謝しLINKます。メッセージのフォーマット方法を見つけるのは頭痛の種でした。

于 2011-07-01T02:36:40.503 に答える