version 1.4, 2000/03/14 05:46:09 |
version 1.6, 2000/03/14 14:59:39 |
|
|
%% $OpenXM: OpenXM/src/ox_math/documents/math2ox.texi,v 1.3 2000/03/14 02:21:40 ohara Exp $ |
%% $OpenXM: OpenXM/src/ox_math/documents/math2ox.texi,v 1.5 2000/03/14 14:25:27 ohara Exp $ |
|
|
\input texinfo |
\input texinfo |
@iftex |
@iftex |
|
|
@node Top,, (dir), (dir) |
@node Top,, (dir), (dir) |
|
|
@menu |
@menu |
|
* Starting OX servers:: |
* Mathematica Client Functions:: |
* Mathematica Client Functions:: |
* Sample Programs:: |
* Sample Programs:: |
|
* Example:: |
|
* References:: |
@end menu |
@end menu |
|
|
@node Starting OX servers,,, Top |
@node Starting OX servers,,, Top |
|
|
@chapter Starting OX servers |
@chapter Starting OX servers |
|
|
|
@node Loading an OX Client on Mathematica,,, Starting OX servers |
|
@section Loading an OX Client on Mathematica |
|
|
|
The program @code{math2ox} is an external module for Mathematica |
|
to call OpenXM servers. |
|
The @code{math2ox} communicates with OpenXM servers by the OpenXM protocol |
|
and communicates with Mathematica by MathLink. |
|
|
|
@example |
|
In[1]:= Install["math2ox"] |
|
@end example |
|
|
|
We recommend loading a mathematica program @code{oxclient.m} instead of |
|
calling @code{Install[]} directly: |
|
@example |
|
In[1] := <<oxclient.m |
|
@end example |
|
|
@node Starting OX servers on the localhost,,, Starting OX servers |
@node Starting OX servers on the localhost,,, Starting OX servers |
@section Starting OX servers on the localhost |
@section Starting OX servers on the localhost |
|
|
|
|
@end itemize |
@end itemize |
|
|
@example |
@example |
In[1]:= Install["math2ox"] |
In[1]:= pid = OxStart["ox_sm1"] |
In[2]:= pid = OxStart["ox_sm1"] |
|
@end example |
@end example |
|
|
In this example, @code{ox_sm1} is started on the local machine. |
In this example, @code{ox_sm1} is started on the local machine. |
|
|
|
|
|
|
|
|
@node Starting OX servers on a remote machine,,, Top |
@node Starting OX servers on a remote machine,,, Top |
@section Starting OX servers on a remote machine |
@section Starting OX servers on a remote machine |
|
|
Line 123 We note that the @code{OxStartRemoteSSH[]} is an exper |
|
Line 139 We note that the @code{OxStartRemoteSSH[]} is an exper |
|
@end itemize |
@end itemize |
|
|
@example |
@example |
In[2]:= pid = OxStartRemoteSSH["ox_sm1", "remotehost"] |
In[1]:= pid = OxStartRemoteSSH["ox_sm1", "remotehost"] |
@end example |
@end example |
|
|
In this example, @code{ox_sm1} is started on the remote machine @code{remotehost}. |
In this example, @code{ox_sm1} is started on the remote machine @code{remotehost}. |
|
|
@node Mathematica Client Functions,,, Top |
@node Mathematica Client Functions,,, Top |
|
|
@chapter Mathematica Client Functions |
@chapter Mathematica Client Functions |
|
|
The program @code{math2ox} is an external module for Mathematica |
|
to call OpenXM servers. |
|
The @code{math2ox} communicates with OpenXM servers by the OpenXM protocol |
|
and communicates with Mathematica by MathLink. |
|
|
|
@c Description of OxStart |
@c Description of OxStart |
@menu |
@menu |
* OxStart:: |
* OxStart:: |
|
|
@end itemize |
@end itemize |
|
|
@example |
@example |
In[1]:= Install["math2ox"] |
In[1]:= pid = OxStart["ox_sm1"] |
In[2]:= pid = OxStart["ox_sm1"] |
|
@end example |
@end example |
|
|
In this example, @code{ox_sm1} is started on the local machine. |
In this example, @code{ox_sm1} is started on the local machine. |
Line 340 In[5] := cmo = OxGet[pid] |
|
Line 349 In[5] := cmo = OxGet[pid] |
|
@node Sample Programs,,, Top |
@node Sample Programs,,, Top |
@chapter Sample Programs |
@chapter Sample Programs |
|
|
@tex |
@enumerate |
\noindent |
@item |
1. |
@code{OpenXM/lib/math/primadec.m} is a Mathematica program |
{\tt OpenXM/lib/math/primadec.m} is a Mathematica program |
|
to make primary ideal decompositions by calling |
to make primary ideal decompositions by calling |
{\tt ox\_asir}. |
@code{ox_asir}. |
As to usages, see comments in this file. |
As to usages, see comments in this file. |
|
|
\noindent 2. |
@item |
{\tt OpenXM/lib/math/beta.m} is a Mathematica program |
@code{OpenXM/lib/math/beta.m} is a Mathematica program |
to get beta-nbc bases by calling {\tt ox\_asir}. |
to get beta-nbc bases by calling @code{ox_asir}. |
@end tex |
@end enumerate |
|
|
|
@node Example,,, Top |
|
@chapter Example |
|
|
|
The @code{math2ox} has the following commands: |
|
|
|
@code{OxStart[s_String], |
|
OxStartInsecure[s_String, p_Integer, q_Integer], |
|
OxStartRemoteSSH[s_String, t_String], |
|
OxExecuteString[s_String], OxSendMessage[s_String], OxGet[], OxPopCMO[], |
|
OxPopString[], OxClose[], OxReset[]}. |
|
|
|
First, let us load the math2ox. |
|
@example |
|
In[1]:= <<oxclient.m |
|
@end example |
|
|
|
Second, let us open a connection with an OX server. |
|
For example, if we want to call the @code{ox_sm1} (the kan/sm1 server), then |
|
@example |
|
In[2] := pid = OxStart[pid, "ox_sm1"] |
|
@end example |
|
where we have the connection of reverse mode. The OxStart function |
|
automatically invoke @code{ox_sm1} on the local machine. If you need to |
|
connect an OX server on a remote machine, then you can use reverse mode. |
|
@example |
|
In[2] := pid = OxStartInsecure["water.s.kanazawa-u.ac.jp", 1300, 1400] |
|
@end example |
|
The mode is not secured but you can crypt data stream by using ssh |
|
(Secure SHell). |
|
@example |
|
In[3] := Run["ssh -f water ox -insecure -ox ox_sm1 -host water"] |
|
@end example |
|
|
|
Third, let us send an OX message to the OX server. |
|
We can send an OX message written in OX/CMO expressions. |
|
@example |
|
In[4] := OxSendMessage[pid, "(CMO_LIST, (CMO_STRING, "hello world"), (CMO_ZERO))"] |
|
In[5] := OxSendMessage[pid, "(OX_COMMAND, (SM_popCMO))"] |
|
@end example |
|
If the expression contains syntax errors, then nothing is sent. |
|
|
|
Remarks: if @code{SM_popCMO} is sent by the @code{OxSendMessage[]} function, then the |
|
OX stack machine returns the top of the stack to the @code{math2ox}. |
|
Then, in order to receive the message, we need to call the @code{OxGet[]} |
|
function always after executing @code{OxSendMessage[]} |
|
@example |
|
In[6] := OxGet[pid] |
|
@end example |
|
|
|
If we do not use the @code{OxSendMessage} function and use the @code{OxPopCMO[]} |
|
function, then we do not need to call the @code{OxGet[]}. |
|
@example |
|
In[5] := OxPopCMO[pid] |
|
@end example |
|
|
|
Fourth, if we send a command expressed in the local language of the OX |
|
server, then we need to call the @code{OxExecuteString[]} function. |
|
|
|
Last, let us close the connection. |
|
@example |
|
In[7] := OxClose[pid] |
|
@end example |
|
|
|
@c @node Bibliography,,, Top |
|
@c @unnumbered Bibliography |
|
@node References,,, Top |
|
@unnumbered References |
|
|
|
@enumerate |
|
@item |
|
M. Noro, N. Takayama: |
|
Design and Implementation of OpenXM, 1996, 1997, 1998, 1999, 2000. |
|
|
|
@item |
|
@code{http://www.math.kobe-u.ac.jp/OpenXM/} |
|
|
|
@item |
|
M. Noro, K. Ohara, N. Takayama: |
|
{Introduction to Open Asir}, 1999, Suusiki Shori, Vol 7, No 2, |
|
2--17. (ISBN4-87243-086-7, SEG Publishing, Tokyo). (in Japanese) |
|
|
|
@item |
|
Stephen Wolfram: |
|
{The Mathematica Book}, Third edition, |
|
Wolfram Media/Cambridge University Press, 1996. |
|
|
|
@item |
|
T. Miyachi: |
|
{Mathematica Network Programming}, |
|
Iwanami Shoten Publishers, 1998. (in Japanese) |
|
@end enumerate |
|
|
@node Index,,, Top |
@node Index,,, Top |
@unnumbered Index |
@unnumbered Index |