8

我想我开始了解如何将用 C/C++ 编写的函数链接到Mathematica。我面临的问题是我不知道如何将错误消息从我的 C 包装器发送到 Mathematica。在谷歌搜索后,我找到了这个MathLink 教程

第 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中使用的函数之外,我已经将这个类剥离到了最简单的部分。我想找到从一条线到另一条线的距离。这个函数是MathematicalineInt中线框的 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);
}

我创建了两个辅助函数:ML_GetPointML_GetLine帮助我从Mathematica获取输入。一行是从包含两个列表的列表中获得的。每个子列表是 2 个实数(一个点)的列表。要在 Mathematica 中尝试此功能,我们需要更多文件。


//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 将手动获取参数并返回一个实数。最后两行很重要。第一个Evaluate声明usage函数的。?LineDistance当输入到Mathematica时,它会给出关于函数的简短信息。另一个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提供的示例之一中找到这些代码。

在终端我知道这样做:

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 个列表的 2 个双打列表。如果您知道如何让我知道,也许还有另一种获取输入的方法。如果我们坚持这种方法,我们所需要的只是让Mathematica用户知道是否有任何错误。一个非常简单的方法是输入错误。假设我输入了这个:

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

输出是$Failed。以下情况如何:

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

输出是LineDistance[{{1, -1}, {1, 1}}]。我猜会发生这种情况,因为我们在Pattern第 1 节中描述了.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_GetPointML_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

这是一种更“高级”的方法,这样您就不必明确地处理数据包。

但是,我觉得输入参数的完整错误检查最好通过适当的模式在 Mathematica 端执行,并为 C 代码中检测到的一些内部错误保存错误消息选项(实际上我更进一步并返回到 Mathematica只是错误代码作为整数或字符串,并让更高级别的 mma 包装器处理它们并发出消息)。您可以将这些模式放在模板文件中,也可以将 MathLink Mathematica 函数包装到另一个执行错误检查的函数中。不过,我对 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。这是简单的解释。该类型的对象MLException包含 2 个字符串和一个字符串向量。If eis an MLExceptionthene.sym必须是有效的Mathematica符号和e.tag有效的标记。我们Symbol::tag在模板文件中定义它。如果Symbol::tag包含参数,则它们存储在e.err. 例如,假设您在模板文件中声明了以下内容:

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

然后,如果由于某些原因在 C 函数中出现错误,您可以通过抛出带有一些消息的异常来摆脱那里。像这样:

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

注意第三个参数是一个整数。这是将放置的消息数,而不是消息中的“1”和“2”。这意味着您将在 Mathematica 中看到的消息是:“错误,程序遇到:这个,它需要那个。” 如果您需要在我制作的消息中包含数字,以便您编写一个字符串后跟一个数字。例如,如果你想写数字 100,然后写一些其他消息,那么你可以抛出这样的异常:

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

如果要包含双精度,请改用“%d”。

该函数接收异常,清除错误,向MathematicaML_sendMessage发送消息并 puts 。$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[]

我决定把它做成一个包。我还声明了函数EMPHLINK. 第一个强调单词,另一个允许我们编写超链接。一旦我学会了如何正确记录,我将在描述中添加超链接。

现在我们可以像在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);
}

现在,由于我正在制作一个包,我们需要最后一个文件:mlwrapper.m。在这个文件中,我们添加这一行:Install["mlwrapper"];. 我们当然假设可执行文件mlwrapper位于同一目录中。最后,我展示了结果的屏幕截图:

输出

我写了最后一条语句来了解异常的开销。我主要希望异常处理输入的获取以及基于 C/C++ 函数的返回语句的其他一些错误。无论如何,编写一个没有异常的包装器并没有比使用异常好多少。

所以你有它。如何从Mathematica调用 C/C++ 函数的另一个示例。

我还要感谢 @alexey-popkov 给了我写作EMPHLINK. 找出如何格式化我的消息让我很头疼。

于 2011-07-01T02:36:40.503 回答