Return to math2ox.texi CVS log

Up to [local] / OpenXM / src / ox_math / documents

Annotation of OpenXM/src/ox_math/documents/math2ox.texi, Revision 1.2

1.2     ! ohara       1: %% $OpenXM: OpenXM/src/ox_math/documents/math2ox.texi,v 1.1 2000/03/08 06:59:37 ohara Exp $
1.1       ohara       2:
                      3: \input texinfo
                      4: @iftex
                      5: @catcode`@#=6
                      6: @def@b#1{{@bf@gt #1}}
                      7: @catcode`@#=@other
                      8: @end iftex
                      9: @overfullrule=0pt
                     10: @c -*-texinfo-*-
                     11: @comment %**start of header
                     12: @setfilename Math2ox
                     13: @settitle Math2ox
                     14: @comment %**end of header
                     15: @comment %@setchapternewpage odd
                     16:
                     17: @iftex
                     18: @comment @finalout
                     19: @end iftex
                     20:
                     21: @titlepage
                     22:
                     23: @title Math2ox
                     24: @subtitle Math2ox User's Manual (English Edition)
                     25: @subtitle Edition 1.1.2 for OpenXM/oxmath
                     26: @subtitle March 2000
                     27:
                     28: @author  by Katsuyoshi Ohara
                     29: @end titlepage
                     30:
                     31: @synindex vr fn
                     32:
                     33: @comment  node-name,  next,  previous,  up
                     34: @node Top,, (dir), (dir)
                     35:
                     36: @menu
                     37: * Mathematica Client Functions::
                     38: * Sample Programs::
                     39: @end menu
                     40:
                     41: @node Mathematica Client Functions,,, Top
                     42:
                     43: @chapter Mathematica Client Functions
                     44:
                     45: The program @code{math2ox} is an external module for Mathematica
                     46: to call OpenXM servers.
                     47: The @code{math2ox} communicates with OpenXM servers by the OpenXM protocol
                     48: and communicates with Mathematica by MathLink.
                     49:
                     50: @c  Description of OxStart
                     51: @menu
                     52: * OxStart::
                     53: @end menu
                     54: @node OxStart,,, Mathematica Client Functions
                     55: @section @code{OxStart}
                     56: @findex OxStart
                     57: @table @t
1.2     ! ohara      58: @item OxStart[@var{s}]
1.1       ohara      59: ::  Start the OX server @code{s}.
                     60: @end table
                     61:
                     62: @table @var
                     63: @item return
                     64: Integer
                     65: @item s
                     66: String
                     67: @end table
                     68:
                     69: @itemize @bullet
                     70: @item  It starts the OX server @code{s}.
                     71: @item Servers are looked for in the directory $OenXM_HOME/bin , hoge hoge.
                     72: @end itemize
                     73:
                     74: @example
                     75: In[1]:= Install["math2ox"]
1.2     ! ohara      76: In[2]:= pid = OxStart["ox_sm1"]
1.1       ohara      77: @end example
                     78:
                     79: In this example, @code{ox_sm1} is started on the local machine.
                     80:
1.2     ! ohara      81: @c  Description of OxSendMessage
        !            82: @menu
        !            83: * OxSendMessage::
        !            84: @end menu
        !            85: @node OxSendMessage,,, Mathematica Client Functions
        !            86: @section @code{OxSendMessage}
        !            87: @findex OxSendMessage
        !            88: @table @t
        !            89: @item OxSendMessage[@var{pid}, @var{s}]
        !            90: ::  SendMessage @code{s} to the OX server @code{pid}.
        !            91: @end table
        !            92:
        !            93: @table @var
        !            94: @item return
        !            95: Integer
        !            96: @item id
        !            97: Integer
        !            98: @item s
        !            99: String
        !           100: @end table
        !           101:
        !           102: @itemize @bullet
        !           103: @item  It starts the OX server @code{s}.
        !           104: @item Servers are looked for in the directory $OenXM_HOME/bin , hoge hoge.
        !           105: @end itemize
        !           106:
        !           107: @example
        !           108: In[4] := OxSendMessage[pid, "(CMO_LIST, (CMO_STRING, "hello world"), (CMO_ZERO))"]
        !           109: In[5] := OxSendMessage[pid, "(OX_COMMAND, (SM_popCMO))"]
        !           110: @end example
        !           111:
        !           112: In this example, an OX data message
        !           113: (OX_DATA, (CMO_LIST, (CMO_STRING, "hello world"), (CMO_ZERO))
        !           114: and an OX command message (OX_COMMAND, (SM_popCMO)) are sent to
        !           115: the OX server @code{pid}.
        !           116:
1.1       ohara     117: @c  Put descriptions of a next function.
                    118:
1.2     ! ohara     119:
        !           120: @node Starting OX servers on a remote machines,,, Top
        !           121: @chapter Starting OX servers on a remote machines
1.1       ohara     122:
                    123: @node Sample Programs,,, Top
                    124: @chapter Sample Programs
                    125:
                    126: @tex
                    127: \noindent
                    128: 1.
                    129: {\tt OpenXM/lib/math/primadec.m} is a Mathematica program
                    130: to make primary ideal decompositions by calling
                    131: {\tt ox\_asir}.
                    132: As to usages, see comments in this file.
                    133:
                    134: \noindent 2.
                    135: {\tt OpenXM/lib/math/beta.m} is a Mathematica program
                    136: to get beta-nbc bases by calling {\tt ox\_asir}.
                    137: @end tex
                    138:
                    139:
                    140:
                    141: @node Index,,, Top
                    142: @unnumbered Index
                    143: @printindex fn
                    144: @printindex cp
                    145: @iftex
                    146: @vfill @eject
                    147: @end iftex
                    148: @summarycontents
                    149: @contents
                    150: @bye
                    151: