=================================================================== RCS file: /home/cvs/OpenXM/doc/issac2000/openxm-clients.tex,v retrieving revision 1.6 retrieving revision 1.10 diff -u -p -r1.6 -r1.10 --- OpenXM/doc/issac2000/openxm-clients.tex 2000/01/16 03:15:49 1.6 +++ OpenXM/doc/issac2000/openxm-clients.tex 2000/01/17 01:24:27 1.10 @@ -1,4 +1,4 @@ -% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.5 2000/01/15 06:26:06 takayama Exp $ +% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.9 2000/01/17 00:48:06 takayama Exp $ \section{OpenXM Clients} @@ -28,9 +28,9 @@ are provided to execute these primitive operations: {\tt ox\_push\_cmd()} for sending an {\tt SM} command to a server and {\tt ox\_get()} for receiving data from a stream. -Some operations including the reset operation are realized by +Some operations including the reset operation are implemented by combining these primitives. Among them, frequently used ones are -provided as built-in functions. We show several ones. +provided as built-in functions. We show some of them. \begin{itemize} \item {\tt ox\_pop\_cmo()} @@ -49,32 +49,32 @@ the function. It does not wait the termination of the After sending {\tt SM\_control\_reset\_connection} to a control server, it completes the operations stated in Section \ref{control}. \end{itemize} -Furthermore {\tt ox\_select()} is provided to detect streams ready for -reading. It is realized by the {\tt select()} system call and is used +Furthermore {\tt ox\_select()} is provided to detect if streams are ready for +reading. It is implemented by the {\tt select()} system call and is used to avoid blocking on read operations. \subsection{Mathematica} We provide an OpenXM client {\tt math2ox} written as an external module -for Mathematica. Our client communicates with Mathematica by MathLink and -with an OpenXM server by OpenXM protocols. +for Mathematica. +The module {\tt math2ox} communicates with Mathematica by MathLink and +with any OpenXM server by the OpenXM protocol. By using the module {\tt math2ox}, we can call OpenXM servers from Mathematica; -here is an example of a computation of the de Rham cohomology groups -of ${\bf C}^2 \setminus V(x^3-y^2)$. +here is a demonstration of a computation of the de Rham cohomology groups +of ${\bf C}^2 \setminus V(x^3-y^2)$ from Mathematica. {\footnotesize \begin{verbatim} In[1]:= Install["math2ox"] In[2]:= OxStart["../lib/sm1/bin/ox_sm1_forAsir"] In[3]:= OxExecute[" [(x^3-y^2) (x,y)] deRham "] In[4]:= OxPopString[] -Out[4]= [ 1 , 1 , 0 ] +Out[4]= [ 1 , 1 , 0 ] (* The dimension of + cohomology groups *) \end{verbatim} } -\subsubsection{Functions} - -The {\tt math2ox} has the following functions. +The {\tt math2ox} adds the following functions to Mathematica. \begin{quote} {\tt OxStart[s\_String]} \\ {\tt OxStartInsecure[s\_String]} \\ @@ -86,11 +86,16 @@ The {\tt math2ox} has the following functions. {\tt OxClose[]} \\ {\tt OxReset[]} \end{quote} -For example, {\tt OxPopCMO[]} executes the same operation -as {\tt ox\_pop\_cmo()} in Risa/Asir. -By using the {\tt OxParse[]} function, one can send suitable OX messages, -written by the OX expression, to a server. OX expressions are -Lisp-like expressions for OX messages and are defined -in~\cite{noro-takayama}. +Although the list of functions speaks itself, +we add some explanations. +The function {\tt OxPopCMO[]} executes the same operation +as {\tt ox\_pop\_cmo()} in Risa/Asir; +it pops data from the server stack. The {\tt OxGet[]} receives an OX data message and returns its translation to an local object. +The function {\tt OxParse[]} helps debugging to connect Mathematica +and ox servers. +By using the function, one can send OX messages, +written by the OX expression, to a server. +OX expressions are Lisp-like expressions for OX messages and are defined +in~\cite{noro-takayama}.