[BACK]Return to process.texi CVS log [TXT][DIR] Up to [local] / OpenXM / src / asir-doc / parts

Annotation of OpenXM/src/asir-doc/parts/process.texi, Revision 1.3

1.3     ! noro        1: @comment $OpenXM: OpenXM/src/asir-doc/parts/process.texi,v 1.2 1999/12/21 02:47:31 noro Exp $
1.2       noro        2: \BJP
1.1       noro        3: @node $BJ,;67W;;(B,,, Top
                      4: @chapter $BJ,;67W;;(B
1.2       noro        5: \E
                      6: \BEG
                      7: @node Distributed computation,,, Top
                      8: @chapter Distributed computation
                      9: \E
1.1       noro       10:
                     11: @menu
                     12: * OpenXM::
                     13: * Mathcap::
1.2       noro       14: \BJP
1.1       noro       15: * $B%9%?%C%/%^%7%s%3%^%s%I(B::
                     16: * $B%G%P%C%0(B::
                     17: * $BJ,;67W;;$K4X$9$k4X?t(B::
1.2       noro       18: \E
                     19: \BEG
                     20: * Stackmachine commands::
                     21: * Debugging::
                     22: * Functions for distributed computation::
                     23: \E
1.1       noro       24: @end menu
                     25:
1.2       noro       26: \JP @node OpenXM,,, $BJ,;67W;;(B
                     27: \EG @node OpenXM,,, Distributed computation
1.1       noro       28: @section OpenXM
                     29:
1.2       noro       30: \BJP
                     31: @b{Asir} $B$O(B, $BJ,;67W;;$K$*$1$kDL?.%W%m%H%3%k$H$7$F(B, @b{OpenXM}
1.1       noro       32: (Open message eXchange protocol for Mathematics) $B$r:NMQ$7$F$$$k(B.
1.2       noro       33: @b{OpenXM} $B$O(B, $B<g$H$7$F?t3X%*%V%8%'%/%H$r%W%m%;%94V$G$d$j$H$j$9$k(B
                     34: $B$?$a$N5,Ls$G$"$k(B. @b{OpenXM} $B$K$*$$$F$O(B
                     35: \E
                     36: \BEG
1.3     ! noro       37: On @b{Asir} distributed computations are done under @b{OpenXM}
1.2       noro       38: (Open message eXchange protocol for Mathematics), which
                     39: is a protocol for exchanging mainly mathematical objects
                     40: between processes.
                     41: In @b{OpenXM} a distributed computation is done as follows:
                     42: \E
1.1       noro       43:
                     44: @enumerate
1.2       noro       45: \BJP
1.1       noro       46: @item client $B$,(B server $B$KBP$7$F7W;;<B9T0MMj$N%a%C%;!<%8$rAw$k(B.
                     47: @item server $B$,7W;;$r<B9T$9$k(B.
                     48: @item client $B$,(B server $B$K7k2LAwIU0MMj$N%a%C%;!<%8$rAw$k(B.
                     49: @item server $B$O7k2L$rJV$7(B, client $B$O7k2L$r<u$1<h$k(B
1.2       noro       50: \E
                     51: \BEG
                     52: @item A client requests something to a server.
                     53: @item The server does works according to the request.
                     54: @item The client requests to send data to the server.
                     55: @item The server sends the data to the client and the client gets the data.
                     56: \E
1.1       noro       57: @end enumerate
                     58:
1.2       noro       59: \BJP
1.1       noro       60: $B$H$$$&7A$GJ,;67W;;$,9T$o$l$k(B. server $B$O%9%?%C%/%^%7%s$G$"$k(B. $B$9$J$o$A(B,
                     61: client $B$+$iAw$i$l$?%G!<%?%*%V%8%'%/%H$O(B, $B;XDj$,$J$$8B$j(B server $B$N%9%?%C(B
                     62: $B%/$K@Q$^$l(B, $B%3%^%s%I$,Aw$i$l$?;~$K(B, $BI,MW$J$@$1%9%?%C%/$+$i%G!<%?$r<h$j=P(B
                     63: $B$7$F(B, $B4X?t8F$S=P$7$N0z?t$H$9$k(B.
1.2       noro       64: \E
                     65: \BEG
                     66: The server is a stack machine. That is data objects sent by the client
                     67: are pushed to the stack of the server.
                     68: If the server gets a command, then the data are
                     69: popped form the stack and they are used as arguments of a function call.
                     70: \E
1.1       noro       71:
1.2       noro       72: \BJP
                     73: @b{OpenXM} $B$K$*$$$FFCD'E*$J$3$H$O(B, $B7W;;7k2L$OC1$K(B server $B$N%9%?%C%/$K(B
1.1       noro       74: $B@Q$^$l$k$@$1$G(B, client $B$+$i$N0MMj$,$J$$8B$j(B, $BDL?.O)$K%G!<%?$ON.$l$J$$(B
                     75: $B$H$$$&E@$G$"$k(B.
1.2       noro       76: \E
1.1       noro       77:
1.2       noro       78: \BEG
                     79: In @b{OpenXM}, the result of a computation done in the server
                     80: is simply pushed to the stack and the data is not written to
                     81: the communication stream without requests from the client.
                     82: \E
                     83:
                     84: \BJP
1.1       noro       85: $B%W%m%H%3%k$K$O(B, $B%*%V%8%'%/%H$N6&DL%U%)!<%^%C%H$r5,Dj(B
                     86: $B$9$k(B @b{CMO} (Common Mathematical Object format), $B%W%m%;%9$KBP$9$k(B
                     87: $BF0:n$r;XDj$9$k(B @b{SM} (Stack Machine command) $B$,4^$^$l$k(B.
1.2       noro       88: $B$3$l$i$O(B, $B%G!<%?$rAw$k:]$K(B, $B%G!<%?$N<oN`$r;XDj$9$k(B
1.1       noro       89: $B$?$a$N(B @b{OX} expression $B$H$7$F%i%C%T%s%0$5$l$k(B.
                     90:
1.2       noro       91: @b{OpenXM} $B$K$h$kJ,;67W;;$r9T$&>l9g$K$O(B,
1.1       noro       92: $B$^$:(B, server $B$rN)$A>e$2$F(B, $BDL?.$r@.N)$5$;$kI,MW$,$"$k(B. $B$3$N$?$a$K(B,
                     93: @code{ox_launch()}, @code{ox_launch_nox()}, @code{ox_launch_generic()}
                     94: $B$J$I$N4X?t$,MQ0U$5$l$F$$$k(B. $B$5$i$K(B, $BDL?.$N@.N)$7$?(B server $B$KBP$7$F(B
                     95: $B0J2<$N$h$&$JA`:n$,4X?t$H$7$FMQ0U$5$l$F$$$k(B.
1.2       noro       96: \E
                     97:
                     98: \BEG
                     99: @b{OpenXM} protocol consists of two components:
                    100: @b{CMO} (Common Mathematical Object format) which determines
                    101: a common format of data representations and
                    102: @b{SM} (StackMachine command) which specifies actions on servers.
                    103: These are wrapped as @b{OX} expressions to indicate the sort of
                    104: data when they are sent.
                    105:
                    106: To execute a distributed computation by @b{OpenXM},
                    107: one has to invoke @b{OpenXM} servers and to establish communications
                    108: between the client and the servers.
                    109: @code{ox_launch()}, @code{ox_launch_nox()}, @code{ox_launch_generic()}
                    110: are preprared for such purposes. Furthermore the following functions
                    111: are available.
                    112: \E
1.1       noro      113:
                    114: @table @code
                    115: @item @code{ox_push_cmo()}
                    116:
1.2       noro      117: \JP $B%G!<%?$r(B server $B$N%9%?%C%/$K@Q$`(B
1.3     ! noro      118: \EG It requests a server to push an object to the stack of a server.
1.1       noro      119:
                    120: @item @code{ox_pop_cmo()}
1.2       noro      121: \JP $B%G!<%?$r(B server $B$N%9%?%C%/$+$i<h$j=P$9(B.
1.3     ! noro      122: \EG It request a server to pop an object from the stack of a server.
1.1       noro      123:
                    124: @item @code{ox_cmo_rpc()}
                    125:
1.2       noro      126: \JP server $B$N4X?t$r8F$S=P$7(B, $B7k2L$r%9%?%C%/$K@Q$`(B.
                    127: \BEG
                    128: It requests to execute a function on a server.
                    129: The result is pushed to the stack of the server.
                    130: \E
1.1       noro      131:
                    132: @item @code{ox_execute_string()}
                    133:
1.2       noro      134: \BJP
1.1       noro      135: server $B8GM-$N%f!<%68@8l(B (@b{Asir} $B$J$i(B Asir $B8@8l(B) $B$G=q$+$l$?J8;zNs$r(B
                    136: server $B$,<B9T$7(B, $B7k2L$r%9%?%C%/$K@Q$`(B.
1.2       noro      137: \E
                    138: \BEG
                    139: It requests a server to parse and execute a string
                    140: by the parser and the evaluater of the server.
                    141: The result is pushed to the stack of the server.
                    142: \E
1.1       noro      143:
                    144: @item @code{ox_push_cmd()}
                    145:
1.2       noro      146: \JP @b{SM} $B%3%^%s%I$NAw?.(B.
                    147: \EG It requests a server to execute a command.
1.1       noro      148:
                    149: @item @code{ox_get()}
                    150:
1.2       noro      151: \JP $B4{$KDL?.O)$K$"$k%G!<%?$N<h$j=P$7(B.
                    152: \EG It gets an object from a data stream.
1.1       noro      153: @end table
                    154:
1.2       noro      155: \JP @node Mathcap,,, $BJ,;67W;;(B
                    156: \EG @node Mathcap,,, Distributed computation
1.1       noro      157: @section Mathcap
                    158:
1.2       noro      159: \BJP
                    160: server, client $B$H$b$K(B, @b{OpenXM} $B$G5,Dj$5$l$F$$$kA4$F$N(B@b{CMO} $B%U%)!<(B
1.1       noro      161: $B%^%C%H(B, @b{SM} $B%3%^%s%I$r<BAu$7$F$$$k$H$O8B$i$J$$(B. $BAj<j$NCN$i$J$$%G!<%?(B,
1.2       noro      162: $B%3%^%s%I$rAw$C$?>l9g(B, $B8=>u$G$O7k2L$OM=A[$G$-$J$$(B. $B$3$N$?$a(B, @b{OpenXM}
1.1       noro      163: $B$G$O(B, $B$"$i$+$8$a8_$$$N%5%]!<%H$9$k(B @b{CMO}, @b{SM} $B$N%j%9%H$r8r49$7$"$C$F(B,
                    164: $BAj<j$NCN$i$J$$%G!<%?$rAw$i$J$$$h$&$K$9$k;EAH$_$rDs>'$7$F$$$k(B. $B$3$N$?$a$N(B
                    165: $B%G!<%?$,(B Mathcap $B$G$"$k(B. Mathcap $B$O(B @b{CMO} $B$H$7$F$O%j%9%H$G$"$j(B, $B$=$N(B
                    166: $BMWAG$O(B 32 bit $B@0?t$^$?$OJ8;zNs$G$"$k(B. $B8=:_$N5,Dj$G$O(B, Mathcap $B$O(B
                    167: $BD9$5$,(B 3 $B$N%j%9%H$G(B,
                    168:
1.2       noro      169: [[version $BHV9f(B, server $BL>(B],@b{SM}taglist,[[@b{OX}tag,@b{CMO}taglist],
                    170: [@b{OX}tag,@b{CMO}taglist],...]]
1.1       noro      171:
1.2       noro      172: $B$H$$$&7A$r$7$F$$$k(B. [@b{OX}tag,@b{CMO}taglist] $B$O(B,
1.1       noro      173: @b{OX}tag $B$G<($5$l$k%+%F%4%j$N%G!<%?$KBP$7$F(B, $B$I$N$h$&$J(B @b{CMO} $B$,;HMQ2D(B
                    174: $BG=$+$r<($9$b$N$G$"$k(B. $B$3$N;XDj$rJ#?t5v$9$3$H$K$h$j(B, $BNc$($P(B
                    175: @samp{ox_asir} $B$N$h$&$K(B, @b{CMO} $B%G!<%?0J30$K(B, @b{Asir} $B8GM-$N%G!<%?7A<0(B
                    176: $B$K$h$j(B, @b{CMO}$B$h$jB?$/$N<oN`$N%G!<%?Aw<u?.$r9T$($k$3$H$r<($;$k(B.
                    177:
                    178: $B%G!<%?Aw?.$N:]$K(B, $BAj<j%W%m%;%9$N(B Mathcap $B$,4{$KEPO?$5$l$F$$$k>l9g(B,
                    179: Mathcap $B$K$h$k%A%'%C%/$r9T$&$+H]$+$O(B,
                    180: @code{ctrl} $B%3%^%s%I$N(B @code{"ox_check"} $B%9%$%C%A$K$h$j7h$^$k(B.
                    181: $B$3$N%9%$%C%A$N=i4|CM$O(B 1 $B$G(B, $B%A%'%C%/$r9T$&$3$H$r0UL#$9$k(B.
                    182: @code{ctrl("ox_check",0)} $B$K$h$j%A%'%C%/$r9T$o$J$$$h$&$K$G$-$k(B.
1.2       noro      183: \E
                    184: \BEG
                    185: A server or a client does not necessarily implement full specifications
                    186: of @b{OpenXM}. If a program sends data unknown to its peer, an unrecoverable
                    187: error may occur. To avoid such a case @b{OpenXM} provides a scheme not
                    188: to send data unknown to peers. It is realized by exchanging the list of
                    189: supported @b{CMO} and @b{SM}. The list is called mathcap.
                    190: Mathcap is also defined as a @b{CMO} and the elements are 32bit integers
                    191: or strings.
                    192: The format of mathcap is as follows.
                    193:
1.3     ! noro      194: [[version number, server name],@b{SM}taglist,
        !           195: [[@b{OX}tag,@b{CMO}taglist],[@b{OX}tag,@b{CMO}taglist],...]]
1.2       noro      196:
                    197: [@b{OX}tag,@b{CMO}taglist] indicates that available object tags for
                    198: a category of data specified by @b{OX}tag.
                    199: For example @samp{ox_asir} accepts the local object format used by @b{Asir}
                    200: and the mathcap from @samp{ox_asir} reflects the fact.
                    201:
                    202: If @code{"ox_check"} switch of @code{ctrl} is set to 1,
                    203: the check by a mathcap is done before data is sent.
                    204: If @code{"ox_check"} switch of @code{ctrl} is set to 0,
                    205: the check is not done.
                    206: By default it is set to 1.
                    207: \E
1.1       noro      208:
1.2       noro      209: \BJP
1.1       noro      210: @node $B%9%?%C%/%^%7%s%3%^%s%I(B,,, $BJ,;67W;;(B
                    211: @section $B%9%?%C%/%^%7%s%3%^%s%I(B
1.2       noro      212: \E
                    213: \BEG
                    214: @node Stackmachine commands,,, Distributed computation
                    215: @section Stackmachine commands
                    216: \E
1.1       noro      217:
1.2       noro      218: \BJP
1.1       noro      219: $B%9%?%C%/%^%7%s%3%^%s%I$O(B, $B%9%?%C%/%^%7%s$G$"$k(B server $B$K2?$i$+$NA`:n$r9T(B
                    220: $B$o$;$k$?$a$KMQ0U$5$l$F$$$k(B. $B$$$/$D$+$N%3%^%s%I$O(B, $B$h$/MQ$$$i$l$k7A$G(B, $BB>(B
1.2       noro      221: $B$N%3%^%s%I(B, $B%G!<%?$H$H$b$K(B, @b{Asir} $B$NAH$_9~$_4X?t$K$h$jAw$i$l$k$,(B, $B%f!<(B
1.1       noro      222: $B%6$,L@<(E*$K$"$k%3%^%s%I$rAw$kI,MW$,$7$P$7$P@8$:$k(B. $B%9%?%C%/%^%7%s%3%^%s(B
                    223: $B%I$O(B 32 bit $B0J2<$N@0?t$G$"$j(B, @code{ox_push_cmd()} $B%3%^%s%I$GAw?.$G$-$k(B.
                    224: $B0J2<$G(B, $BBeI=E*$J%9%?%C%/%^%7%s%3%^%s%I$K$D$$$F2r@b$9$k(B. @b{SM_xxx=yyy}
                    225: $B$G(B, @b{SM_xxx} $B$,(B mnemonic, @b{yyy} $B$,CM$G$"$k(B.
                    226:
                    227: $B0J2<$G(B, $B%9%?%C%/$+$i%G!<%?$r<h$j=P$9$H$O(B, $B%9%?%C%/$N0lHV>e$+$i%G!<%?$r(B
                    228: $B<h$j=|$/$3$H$r8@$&(B.
1.2       noro      229: \E
                    230:
                    231: \BEG
                    232: The stackmachine commands are provided to request a server to execute
                    233: various operations.
                    234: They are automatically sent by built-in functions of @b{Asir},
                    235: but one often has to send them manually. They are represented by
                    236: 32bit integers. One can send them by calling @code{ox_push_cmd()}.
                    237: Typical stackmachine commands are as follows.
                    238: @b{SM_xxx=yyy} means that @b{SM_xxx} is a mnemonic and that
                    239: @b{yyy} is its value.
                    240: \E
1.1       noro      241:
                    242: @table @b
                    243: @item SM_popSerializedLocalObject=258
                    244:
1.2       noro      245: \BJP
1.1       noro      246: server $B$,(B @samp{ox_asir} $B$N>l9g$K(B, $BI,$:$7$b(B @b{CMO} $B$GDj5A$5$l$F$$$J$$(B
1.2       noro      247: $B%*%V%8%'%/%H$r%9%?%C%/$+$i<h$j=P$7(B, $BDL?.O)$KN.$9(B.
                    248: \E
                    249: \BEG
                    250: An object not necessarily defined as @b{CMO} is popped from the stack
                    251: and is sent to the client. This is available only on @samp{ox_asir}.
                    252: \E
1.1       noro      253:
                    254: @item SM_popCMO=262
                    255:
1.2       noro      256: \JP @b{CMO} $B%*%V%8%'%/%H$r%9%?%C%/$+$i<h$j=P$7(B, $BDL?.O)$KN.$9(B.
                    257: \EG A @b{CMO} object is popped from the stack and is sent to the client.
1.1       noro      258:
                    259: @item SM_popString=263
                    260:
1.2       noro      261: \JP $B%9%?%C%/$+$i%G!<%?$r<h$j=P$7(B, $B2DFI7A<0$NJ8;zNs$KJQ49$7$FDL?.O)$KN.$9(B.
                    262: \EG An object is popped from the stack and is sent to the client as a readable string.
1.1       noro      263:
                    264: @item SM_mathcap=264
                    265:
1.2       noro      266: \JP server $B$N(B mathcap $B$r%9%?%C%/$K@Q$`(B.
                    267: \EG The server's mathcap is pushed to the stack.
1.1       noro      268:
                    269: @item SM_pops=265
                    270:
1.2       noro      271: \BJP
1.1       noro      272: $B%9%?%C%/$+$i<h$j=P$7$?%G!<%?$r8D?t$H$7$F(B, $B$=$N8D?tJ,%9%?%C%/$+$i(B
                    273: $B%G!<%?$r<h$j=|$/(B.
1.2       noro      274: \E
                    275: \BEG
                    276: Objects are removed from the stack. The number of object to be removed
                    277: is specified by the object at the top of the stack.
                    278: \E
1.1       noro      279:
                    280: @item SM_setName=266
                    281:
1.2       noro      282: \BJP
1.1       noro      283: $B%9%?%C%/$+$i%G!<%?$rJQ?tL>$H$7$F<h$j=P$7(B, $B<!$K<h$j=P$7$?%G!<%?$r$=$N(B
                    284: $BJQ?t$K3d$jEv$F$k(B. $B$3$N3d$jEv$F$O(B, server $B8GM-$N=hM}$H$7$F9T$o$l$k(B.
1.2       noro      285: \E
                    286: \BEG
                    287: A variable name is popped form the stack. Then an object is
                    288: popped and it is assigned to the variable. This assignment is done
                    289: by the local language of the server.
                    290: \E
1.1       noro      291:
                    292: @item SM_evalName=267
                    293:
1.2       noro      294: \JP $B%9%?%C%/$+$i<h$j=P$7$?%G!<%?$rJQ?tL>$H$7$F(B, $B$=$NCM$r%9%?%C%/$K:\$;$k(B.
                    295: \BEG
                    296: A variable name is popped from the stack.
                    297: Then the value of the variable is pushed to the stack.
                    298: \E
1.1       noro      299:
                    300: @item SM_executeStringByLocalParser=268
                    301:
1.2       noro      302: \BJP
1.1       noro      303: $B%9%?%C%/$+$i<h$j=P$7$?%G!<%?$r(B, server $B8GM-$N(B parser, evaluator $B$G(B
                    304: $B=hM}$7(B, $B7k2L$r%9%?%C%/$K:\$;$k(B.
1.2       noro      305: \E
                    306: \BEG
                    307: A string popped from the stack is parsed and evaluated.
                    308: The result is pushed to the stack.
                    309: \E
1.1       noro      310:
                    311: @item SM_executeFunction=269
                    312:
1.2       noro      313: \BJP
1.1       noro      314: $B%9%?%C%/$+$i(B, $B4X?tL>(B, $B0z?t$N8D?t(B, $B8D?tJ,$N0z?t$r<h$j=P$7(B, $B4X?t$r8F$S=P$7(B
                    315: $B7k2L$r%9%?%C%/$K:\$;$k(B.
1.2       noro      316: \E
                    317: \BEG
                    318: A function name, the number of arguments and the arguments are
                    319: popped from the stack. Then the function is executed and the result
                    320: is pushed to the stack.
                    321: \E
1.1       noro      322:
                    323: @item SM_beginBlock=270
1.2       noro      324: \JP $B%G!<%?%V%m%C%/$N$O$8$^$j(B.
                    325: \EG It indicates the beginning of a block.
1.1       noro      326:
                    327: @item SM_endBlock=271
1.2       noro      328: \JP $B%G!<%?%V%m%C%/$N=*$j(B.
                    329: \EG It indicates the end of a block.
1.1       noro      330:
                    331: @item SM_shutdown=272
                    332:
1.2       noro      333: \JP server $B$H$N8r?.$r@ZCG$7(B, server $B$r=*N;$5$;$k(B.
                    334: \EG It shuts down communications and terminates servers.
1.1       noro      335:
                    336: @item SM_setMathcap=273
                    337:
1.2       noro      338: \JP $B%9%?%C%/$N%G!<%?$r(B client $B$N(B mathcap $B$H$7$F(B, server $B$KEPO?$rMW5a$9$k(B.
                    339: \BEG
                    340: It requests a server to register the data at the top of the stack
                    341: as the client's mathcap.
                    342: \E
1.1       noro      343:
                    344: @item SM_getsp=275
                    345:
1.2       noro      346: \JP $B8=:_%9%?%C%/$K@Q$^$l$F$$$k%G!<%?$N?t$r%9%?%C%/$K:\$;$k(B.
                    347: \EG The number of objects in the current stack is pushed to the stack.
1.1       noro      348:
                    349: @item SM_dupErrors=276
                    350:
1.2       noro      351: \BJP
1.1       noro      352: $B8=:_%9%?%C%/$K@Q$^$l$F$$$k%*%V%8%'%/%H$NFb(B, $B%(%i!<%*%V%8%'%/%H$N$_(B
                    353: $B$r%j%9%H$K$7$F(B, $B%9%?%C%/$K:\$;$k(B.
1.2       noro      354: \E
                    355: \BEG
                    356: The list of all the error objects in the current stack is pushed to
                    357: the stack.
                    358: \E
1.1       noro      359:
                    360: @item SM_nop=300
                    361:
1.2       noro      362: \JP $B$J$K$b$7$J$$(B.
                    363: \EG Nothing is done.
1.1       noro      364: @end table
                    365:
1.2       noro      366: \BJP
1.1       noro      367: @node $B%G%P%C%0(B,,, $BJ,;67W;;(B
                    368: @section $B%G%P%C%0(B
1.2       noro      369: \E
                    370: \BEG
                    371: @node Debugging,,, Distributed computation
                    372: @section Debugging
                    373: \E
1.1       noro      374:
1.2       noro      375: \BJP
1.1       noro      376: $BJ,;67W;;$K$*$$$F$O(B, $B0lHL$K%G%P%C%0$,:$Fq$H$J$k(B. @samp{ox_asir} $B$K(B
                    377: $B$*$$$F$O(B, $B%G%P%C%0$N$?$a$N$$$/$D$+$N5!G=$rDs6!$7$F$$$k(B.
1.2       noro      378: \E
                    379: \BEG
                    380: In general, it is difficult to debug distributed computations.
                    381: @samp{ox_asir} provides several functions for debugging.
                    382: \E
1.1       noro      383:
                    384: @menu
1.2       noro      385: \BJP
1.1       noro      386: * $B%(%i!<%*%V%8%'%/%H(B::
                    387: * $B%j%;%C%H(B::
                    388: * $B%G%P%C%0MQ%]%C%W%"%C%W%&%#%s%I%&(B::
1.2       noro      389: \E
                    390: \BEG
                    391: * Error object::
                    392: * Resetting a server::
                    393: * Pop-up command window for debugging::
                    394: \E
1.1       noro      395: @end menu
                    396:
1.2       noro      397: \BJP
1.1       noro      398: @node $B%(%i!<%*%V%8%'%/%H(B,,, $B%G%P%C%0(B
                    399: @subsection $B%(%i!<%*%V%8%'%/%H(B
1.2       noro      400: \E
                    401: \BEG
                    402: @node Error object,,, Debugging
                    403: @subsection Error object
                    404: \E
1.1       noro      405:
1.2       noro      406: \BJP
                    407: @b{OpenXM} server $B$,<B9TCf$K%(%i!<$r5/$3$7$?>l9g(B, $B7k2L$N$+$o$j$K(B
1.1       noro      408: @b{CMO} $B%(%i!<%*%V%8%'%/%H$r%9%?%C%/$K@Q$`(B. $B%(%i!<%*%V%8%'%/%H$O(B, $BBP1~$9$k(B
                    409: @b{SM} $B%3%^%s%I$N%7%j%"%kHV9f$H(B, $B%(%i!<%a%C%;!<%8$+$i$J$j(B, $B$=$l$K$h$C$F(B
                    410: $B$I$N(B @b{SM} $B%3%^%s%I$,$I$N$h$&$J%(%i!<$r5/$3$7$?$,$"$kDxEYH=L@$9$k(B.
1.2       noro      411: \E
                    412: \BEG
                    413: When an error has occurred on an @b{OpenXM} server,
                    414: an error object is pushed to the stack instead of a result of the computation.
                    415: The error object consists of the serial number of the @b{SM} command
                    416: which caused the error, and an error message.
                    417: \E
1.1       noro      418:
                    419: @example
                    420: [340] ox_launch();
                    421: 0
                    422: [341] ox_rpc(0,"fctr",1.2*x);
                    423: 0
                    424: [342] ox_pop_cmo(0);
                    425: error([8,fctrp : invalid argument])
                    426: @end example
                    427:
1.2       noro      428: \BJP
1.1       noro      429: @node $B%j%;%C%H(B,,, $B%G%P%C%0(B
1.2       noro      430: @subsection $B%j%;%C%H(B
                    431: \E
                    432: \BEG
                    433: @node Resetting a server,,, Debugging
                    434: @subsection Resetting a server
                    435: \E
1.1       noro      436:
1.2       noro      437: \BJP
1.1       noro      438: @code{ox_reset()} $B$O8=:_<B9TCf$N(B server $B$r%j%;%C%H$7$F(B, $B%3%^%s%I<u$1IU$1(B
                    439: $B>uBV$KLa$9(B. $B$3$N5!G=$O(B, $BDL>o$N(B @b{Asir} $B%;%C%7%g%s$K$*$1$k%-!<%\!<%I3d$j9~$_(B
1.2       noro      440: $B$H$[$\F1MM$K(B, @b{OpenXM} server $B$r%j%;%C%H$G$-$k(B. $B$^$?(B, $B2?$i$+$N860x$G(B,
1.1       noro      441: $BDL?.O)$N%G!<%?$,:\$C$?$^$^$N>uBV$G(B @code{ox_rpc()} $B$J$I$r<B9T$9$k$H(B,
                    442: @code{ox_pop_cmo()} $B$J$I(B, $B%9%?%C%/$+$i$N<h$j=P$7$H(B, $B<B:]$KFI$^$l$k%G!<%?(B
                    443: $B$NBP1~$,IT@5$K$J$k(B. $B$=$N$h$&$J>l9g$K$bM-8z$G$"$k(B.
1.2       noro      444: \E
1.1       noro      445:
1.2       noro      446: \BEG
                    447: @code{ox_reset()} resets a process whose identifier is @var{number}.
                    448: After its execution the process is ready for receiving data.
                    449: This function corresponds to the keyboard interrupt on an usual @b{Asir}
                    450: session. It often happens that a request of a client does not correspond
                    451: correctly to the result from a server. It is caused by remaining data
                    452: on data streams. @code{ox_reset} is effective for such cases.
                    453: \E
1.1       noro      454:
1.2       noro      455: \BJP
1.1       noro      456: @node $B%G%P%C%0MQ%]%C%W%"%C%W%&%#%s%I%&(B,,, $B%G%P%C%0(B
                    457: @subsection $B%G%P%C%0MQ%]%C%W%"%C%W%&%#%s%I%&(B
1.2       noro      458: \E
                    459: \BEG
                    460: @node Pop-up command window for debugging,,, Debugging
                    461: @subsection Pop-up command window for debugging
                    462: \E
1.1       noro      463:
1.2       noro      464: \BJP
1.1       noro      465: server $B$K$O(B, client $B$K$*$1$k%-!<%\!<%I$KAjEv$9$kF~NO5!G=$,$J$$$?$a(B,
                    466: server $BB&$GF0:n$7$F$$$k%f!<%68@8l%W%m%0%i%`$N%G%P%C%0$,:$Fq$K$J$k(B. $B$3$N(B
                    467: $B$?$a(B, server $BB&$G$N%f!<%68@8l%W%m%0%i%`<B9TCf$N%(%i!<$*$h$S(B, client $B$+$i(B
                    468: $B$N(B @code{ox_rpc(@var{id},"debug")} $B<B9T$K$h$j(B, server $B$K%G%P%C%0%3%^%s%I(B
                    469: $B$rF~NO$9$k$?$a$N>.$5$J%&%#%s%I%&$,%]%C%W%"%C%W$9$k(B. $B$3$N%&%#%s%I%&$+$i$N(B
                    470: $BF~NO$KBP$9$k=PNO$O(B, log $BMQ$N(B @samp{xterm} $B$KI=<($5$l$k(B. $B$3$N%&%#%s%I%&$r(B
                    471: $BJD$8$k$K$O(B, @code{quit} $B$rF~NO$9$l$P$h$$(B.
1.2       noro      472: \E
                    473: \BEG
                    474: As a server does not have any standard input device such as a keyboard,
                    475: it is difficult to debug user programs running on the server.
                    476: @samp{ox_asir} pops up a small command window to input debug commands
                    477: when an error has occurred during user a program execution or
                    478: @code{ox_rpc(@var{id},"debug")} has been executed.
                    479: The responses to commands are shown in @samp{xterm} to display
                    480: standard outputs from the server. To close the small window,
                    481: input @code{quit}.
                    482: \E
1.1       noro      483:
1.2       noro      484: \BJP
1.1       noro      485: @node $BJ,;67W;;$K4X$9$k4X?t(B,,, $BJ,;67W;;(B
                    486: @section $BJ,;67W;;$K4X$9$k4X?t(B
1.2       noro      487: \E
                    488: \BEG
                    489: @node Functions for distributed computation,,, Distributed computation
                    490: @section Functions for distributed computation
                    491: \E
1.1       noro      492:
                    493: @menu
                    494: * ox_launch ox_launch_nox ox_shutdown::
                    495: * ox_launch_generic::
                    496: * ox_asir::
                    497: * ox_rpc ox_cmo_rpc ox_execute_string::
                    498: * ox_push_cmo ox_push_local::
                    499: * ox_pop_cmo ox_pop_local::
                    500: * ox_push_cmd ox_sync::
                    501: * ox_get::
                    502: * ox_pops::
                    503: * ox_reset register_handler::
                    504: * ox_select::
                    505: * ox_flush::
                    506: * ox_get_serverinfo::
                    507: * generate_port try_bind_listen try_connect try_accept register_server::
                    508: * ifplot conplot plot plotover::
                    509: @end menu
                    510:
1.2       noro      511: \JP @node ox_launch ox_launch_nox ox_shutdown,,, $BJ,;67W;;$K4X$9$k4X?t(B
                    512: \EG @node ox_launch ox_launch_nox ox_shutdown,,, Functions for distributed computation
1.1       noro      513: @subsection @code{ox_launch}, @code{ox_launch_nox}, @code{ox_shutdown}
                    514: @findex ox_launch
                    515: @findex ox_launch_nox
                    516: @findex ox_shutdown
                    517:
                    518: @table @t
                    519: @item ox_launch([@var{host}[,@var{dir}],@var{command}])
                    520: @itemx ox_launch_nox([@var{host}[,@var{dir}],@var{command}])
1.2       noro      521: \JP :: $B1s3V%W%m%;%9$N5/F0$*$h$SDL?.$r3+;O$9$k(B.
                    522: \EG :: Initialize OpenXM servers.
1.1       noro      523: @item ox_shutdown(@var{id})
1.2       noro      524: \JP :: $B1s3V%W%m%;%9$r=*N;$5$;(B, $BDL?.$r=*N;$9$k(B.
                    525: \EG :: Terminates OpenXM servers.
1.1       noro      526: @end table
                    527:
                    528: @table @var
                    529: @item return
1.2       noro      530: \JP $B@0?t(B
                    531: \EG integer
1.1       noro      532: @item host
1.2       noro      533: \JP $BJ8;zNs$^$?$O(B 0
                    534: \EG string or 0
1.1       noro      535: @item dir, command
1.2       noro      536: \JP $BJ8;zNs(B
                    537: \EG string
1.1       noro      538: @item id
1.2       noro      539: \JP $B@0?t(B
                    540: \EG integer
1.1       noro      541: @end table
                    542:
                    543: @itemize @bullet
1.2       noro      544: \BJP
1.1       noro      545: @item
                    546: @code{ox_launch()} $B$O(B, $B%[%9%H(B @var{host} $B>e$G%3%^%s%I(B @var{command} $B$r5/F0$7(B,
                    547: $B$3$N%W%m%;%9$HDL?.$r3+;O$9$k(B.
                    548: $B0z?t$,(B 3 $B$D$N>l9g(B, @var{host} $B>e$G(B,
                    549: @var{dir} $B$K$"$k(B @samp{ox_launch} $B$H$$$&%5!<%P5/F0MQ%W%m%0%i%`$rN)$A>e$2$k(B.
                    550: @samp{ox_launch} $B$O(B @var{command} $B$r5/F0$9$k(B.
                    551: @var{host} $B$,(B 0 $B$N;~(B, @b{Asir} $B$,F0:n$7$F$$$k(B
                    552: $B%^%7%s>e$G%3%^%s%I$r5/F0$9$k(B.
                    553: $BL50z?t$N>l9g(B, @var{host} $B$O(B 0, @var{dir} $B$O(B @code{get_rootdir()}
                    554: $B$GJV$5$l$k%G%#%l%/%H%j(B, @var{command} $B$OF1$8%G%#%l%/%H%j$N(B @samp{ox_asir}
                    555: $B$r0UL#$9$k(B.
1.2       noro      556:
1.1       noro      557: @item
                    558: @var{host} $B$,(B 0, $B$9$J$o$A%5!<%P$r(B local $B$K5/F0$9$k>l9g$K$O(B, @var{dir}
                    559: $B$r>JN,$G$-$k(B. $B$3$N>l9g(B, @var{dir} $B$O(B @code{get_rootdir()} $B$GJV$5$l$k(B
                    560: $B%G%#%l%/%H%j$H$J$k(B.
1.2       noro      561:
1.1       noro      562: @item
                    563: @var{command} $B$,(B @samp{/} $B$G;O$^$kJ8;zNs$N>l9g(B, $B@dBP%Q%9$H2r<a$5$l$k(B.
                    564: $B$=$l0J30$N>l9g(B, @var{dir} $B$+$i$NAjBP%Q%9$H2r<a$5$l$k(B.
1.2       noro      565:
1.1       noro      566: @item
                    567: UNIX $BHG$K$*$$$F$O(B, @code{ox_launch()} $B$O(B, @var{command} $B$NI8=`=PNO(B, $BI8=`(B
                    568: $B%(%i!<=PNO$rI=<($9$k$?$a$N(B @samp{xterm} $B$r5/F0$9$k(B.
                    569: @code{ox_launch_nox()} $B$O(B, @code{X} $B$J$7$N4D6-$N>l9g(B, $B$"$k$$$O(B @samp{xterm}
                    570: $B$r5/F0$;$:$K%5!<%P$rN)$A>e$2$k>l9g$KMQ$$$k(B. $B$3$N>l9g(B,
                    571: @var{command} $B$N=PNO$O(B @samp{/dev/null} $B$K@\B3$5$l$k(B.
                    572: @code{ox_launch()} $B$N>l9g$G$b(B, $B4D6-JQ?t(B @code{DISPLAY} $B$,@_Dj$5$l$F$$$J$$(B
                    573: $B>l9g$K$O(B, @code{ox_launch_nox()} $B$HF1$8F0:n$r$9$k(B.
                    574:
                    575: @item
                    576: $BJV$5$l$k@0?t$ODL?.$N$?$a$N<1JL;R$H$J$k(B.
                    577:
                    578: @item
                    579: @b{Asir} $B$HDL?.$9$k%W%m%;%9$OF10l$N%^%7%s>e$GF0:n$7$F$$$kI,MW$O$J$$(B. $B$^(B
                    580: $B$?(B, $BDL?.$K$*$1$k%P%$%H%*!<%@$O(B server, client $B4V$G$N:G=i$N(B negotiation
                    581: $B$G7h$^$k$?$a(B, $BAj<j@h$N%^%7%s$H%P%$%H%*!<%@$,0[$J$C$F$$$F$b9=$o$J$$(B.
                    582:
                    583: @item
                    584: @var{host} $B$K%^%7%sL>$r;XDj$9$k>l9g(B, $B0J2<$N=`Hw$,I,MW$G$"$k(B.
                    585: $B$3$3$G(B, @b{Asir} $B$NF0$$$F$$$k%[%9%H$r(B @code{A}, $BDL?.Aj<j$N%W%m%;%9(B
                    586: $B$,5/F0$5$l$k%[%9%H$r(B @code{B} $B$H$9$k(B.
                    587:
                    588: @enumerate
                    589: @item
                    590: $B%[%9%H(B @code{B} $B$N(B @samp{~/.rhosts} $B$K(B, $B%[%9%H(B @code{A} $B$N%[%9%H(B
                    591: $BL>$rEPO?$9$k(B.
                    592:
                    593: @item
                    594: @samp{ox_plot} $B$J$I(B, @code{X} $B$H$N%3%M%/%7%g%s$bMQ$$$i$l$k>l9g(B,
                    595: @code{Xserver} $B$KBP$7(B, $BI,MW$J%[%9%H$r(B authorize $B$5$;$k(B.
                    596: @code{xhost} $B$GI,MW$J%[%9%HL>$rDI2C$9$l$P$h$$(B.
                    597:
                    598: @item
                    599: @var{command} $B$K$h$C$F$O(B, $B%9%?%C%/$rBgNL$K;HMQ$9$k(B
                    600: $B$b$N$b$"$k$?$a(B, @samp{.cshrc} $B$G%9%?%C%/%5%$%:$rBg$-$a(B (16MB $BDxEY(B) $B$K(B
                    601: $B;XDj$7$F$*$/$N$,0BA4$G$"$k(B. $B%9%?%C%/%5%$%:$O(B @code{limit stacksize 16m}
                    602: $B$J$I$H;XDj$9$k(B.
                    603: @end enumerate
                    604:
                    605: @item
                    606: @var{command} $B$,(B, X $B>e$K%&%$%s%I%&$r3+$1$k>l9g(B,
                    607: @var{display}$B$,;XDj$5$l$l$P$=$NJ8;zNs$r(B, $B>JN,;~$K$O4D6-JQ?t(B
                    608: @code{DISPLAY} $B$NCM$rMQ$$$k(B.
                    609:
                    610: @item
                    611: @code{ox_shutdown()} $B$O<1JL;R(B @var{id} $B$KBP1~$9$k1s3V%W%m%;%9(B
                    612: $B$r=*N;$5$;$k(B.
                    613:
                    614: @item
                    615: @b{Asir} $B$,@5>o$7$?>l9g$K$OA4$F$NF~=PNO%9%H%j!<%`$O<+F0E*$KJD$8$i$l(B,
                    616: $B5/F0$5$l$F$$$k%W%m%;%9$OA4$F=*N;$9$k$,(B, $B0[>o=*N;$7$?>l9g(B, $B1s3V%W%m%;%9(B
                    617: $B$,=*N;$7$J$$>l9g$b$"$k(B. @b{Asir} $B$,0[>o=*N;$7$?>l9g(B, $B1s3V%W%m%;%9$r(B
                    618: $B5/F0$7$?%^%7%s>e$G(B @code{ps} $B$J$I$r5/F0$7$F(B, $B$b$7(B @b{Asir} $B$+$i5/F0(B
                    619: $B$7$?%W%m%;%9$,;D$C$F$$$k>l9g(B, @code{kill} $B$9$kI,MW$,$"$k(B.
                    620:
                    621: @item
                    622: log $BI=<(MQ(B @samp{xterm} $B$O(B @samp{-name ox_term} $B%*%W%7%g%s$G5/F0$5$l$k(B.
                    623: $B$h$C$F(B, @samp{ox_term} $B$J$k%j%=!<%9L>$KBP$7$F(B @samp{xterm} $B$N%j%=!<%9@_Dj(B
                    624: $B$r9T$($P(B, log $BMQ(B @samp{xterm} $B$N5sF0$N$_$rJQ$($k$3$H$,$G$-$k(B.
                    625: $BNc$($P(B,
1.2       noro      626:
1.1       noro      627: @example
                    628: ox_xterm*iconic:on
                    629: ox_xterm*scrollBar:on
                    630: ox_xterm*saveLines:1000
                    631: @end example
1.2       noro      632:
1.1       noro      633: $B$K$h$j(B, icon $B$G5/F0(B, scrollbar $B$D$-(B, scrollbar $B$G;2>H$G$-$k9T?t(B
                    634: $B$,:GBg(B 1000 $B9T(B, $B$H$$$&;XDj$,$G$-$k(B.
1.2       noro      635: \E
                    636:
                    637: \BEG
                    638: @item
                    639: Function @code{ox_launch()} invokes a process to execute @var{command}
                    640: on a host @var{host} and enables @b{Asir} to communicate with that
                    641: process.
                    642: If the number of arguments is 3, @samp{ox_launch} in @var{dir}
                    643: is invoked on @var{host}. Then @samp{ox_launch} invokes @var{command}.
                    644: If @var{host} is equal to 0, all the commands are invoked
                    645: on the same machine as the @b{Asir} is running.
                    646: If no arguments are specified, @var{host}, @var{dir} and @var{command}
1.3     ! noro      647: are regarded as 0, the value of @code{get_rootdir()} and @samp{ox_asir} in
1.2       noro      648: the same directory respectively.
                    649:
                    650: @item
                    651: If @var{host} is equal to 0, then @var{dir} can be omitted.
                    652: In such a case @var{dir} is regarded as the value of @code{get_rootdir()}.
                    653:
                    654: @item
                    655: If @var{command} begins with @samp{/}, it is regarded as an absolute
                    656: pathname. Otherwise it is regarded as a relative pathname from
                    657: @var{dir}.
                    658:
                    659: @item
                    660: On UNIX, @code{ox_launch()} invokes @samp{xterm} to display
                    661: standard outputs from @var{command}.
                    662: If @code{X11} is not available or one wants to invoke servers without
                    663: @samp{xterm}, use @code{ox_launch_nox()}, where the outputs of
                    664: @var{command} are redirected to @samp{/dev/null}.
                    665: If the environment variable @code{DISPLAY} is not set,
                    666: @code{ox_launch()} and @code{ox_launch_nox()} behave identically.
                    667:
                    668: @item
                    669: The returned value is used as the identifier for communication.
                    670:
                    671: @item
                    672: The peers communicating with @b{Asir} are not necessarily processes
                    673: running on the same machine.
                    674: The communication will be successful even if
                    675: the byte order is different from those of the peer processes,
                    676: because the byte order for the communication is determined
                    677: by a negotiation between a client and a server.
                    678:
                    679: @item
                    680: The following preparations are necessary.
                    681: Here, Let @code{A} be the host on which @b{Asir} is running, and
                    682: @code{B} the host on which the peer process will run.
                    683:
                    684: @enumerate
                    685: @item
                    686: Register the hostname of the host @code{A} to the @samp{~/.rhosts} of
                    687: the host @code{B}.
                    688: That is, you should be allowed to access the host @code{B} from @code{A}
                    689: without supplying a password.
                    690:
                    691: @item
                    692: For cases where connection to @code{X} is also used,
                    693: let @code{Xserver} authorize the relevant hosts.
                    694: Adding the hosts can be done by command @code{xhost}.
                    695:
                    696: @item
                    697: Some @var{command}'s consume much stack space.  You are recommended
                    698: to set the stack size to about 16MB large in @samp{.cshrc} for safe.
                    699: To specify the size, put @code{limit stacksize 16m} for an example.
                    700: @end enumerate
                    701:
                    702: @item
                    703: When @var{command} opens a window on @code{X},
                    704: it uses the string specified for @var{display};
                    705: if the specification is omitted, it uses the value set for the
                    706: environment variable @code{DISPLAY}.
                    707:
                    708: @item
                    709: @code{ox_shutdown()} terminates OpenXM servers whose identifier
                    710: is @var{id}.
                    711:
                    712: @item
                    713: When @b{Asir} is terminated successfully, all I/O streams are
                    714: automatically closed, and all the processes invoked are also terminated.
                    715: However, some remote processes may not terminated when @b{Asir}
                    716: is terminated abnormally.
                    717: If ever @b{Asir} is terminated abnormally, you have to kill all the
                    718: unterminated process invoked by @b{Asir} on every remote host.
                    719: Check by @code{ps} command on the remote hosts to see if such processed
                    720: are alive.
                    721:
                    722: @item
                    723: @samp{xterm} for displaying the outputs from @var{command} is
                    724: invoked with @samp{-name ox_term} option. Thus, by
                    725: specifying resources for the resource name @samp{ox_term},
                    726: only the behaviour of the @samp{xterm} can be customized.
                    727:
                    728: @example
                    729: /* iconify on start */
                    730: ox_xterm*iconic:on
                    731: /* activate the scroll bar */
                    732: ox_xterm*scrollBar:on
                    733: /* 1000 lines can be shown by the scrollbar */
                    734: ox_xterm*saveLines:1000
                    735: @end example
                    736: \E
1.1       noro      737: @end itemize
                    738:
                    739: @example
                    740: [219] ox_launch();
                    741: 0
                    742: [220] ox_rpc(0,"fctr",x^10-y^10);
                    743: 0
                    744: [221] ox_pop_local(0);
                    745: [[1,1],[x^4+y*x^3+y^2*x^2+y^3*x+y^4,1],
                    746: [x^4-y*x^3+y^2*x^2-y^3*x+y^4,1],[x-y,1],[x+y,1]]
                    747: [222] ox_shutdown(0);
                    748: 0
                    749: @end example
                    750:
                    751: @table @t
1.2       noro      752: \JP @item $B;2>H(B
                    753: \EG @item References
                    754: @fref{ox_rpc ox_cmo_rpc ox_execute_string},
                    755: @fref{ox_pop_cmo ox_pop_local},
                    756: @fref{ifplot conplot plot plotover}
1.1       noro      757: @end table
                    758:
1.2       noro      759: \JP @node ox_launch_generic,,, $BJ,;67W;;$K4X$9$k4X?t(B
                    760: \EG @node ox_launch_generic,,, Functions for distributed computation
1.1       noro      761: @subsection @code{ox_launch_generic}
                    762: @findex ox_launch_generic
                    763:
                    764: @table @t
                    765: @item ox_launch_generic(@var{host},@var{launch},@var{server},@var{use_unix},@var{use_ssh},@var{use_x},@var{conn_to_serv})
1.2       noro      766: \JP :: $B1s3V%W%m%;%9$N5/F0$*$h$SDL?.$r3+;O$9$k(B.
                    767: \EG :: Initialize OpenXM servers.
1.1       noro      768: @end table
                    769:
                    770: @table @var
                    771: @item return
1.2       noro      772: \JP $B@0?t(B
                    773: \EG integer
1.1       noro      774: @item host
1.2       noro      775: \JP $BJ8;zNs$^$?$O(B 0
                    776: \EG string or 0
1.1       noro      777: @item launcher, server
1.2       noro      778: \JP $BJ8;zNs(B
                    779: \EG string
1.1       noro      780: @item use_unix, use_ssh, use_x, conn_to_serv
1.2       noro      781: \JP $B@0?t(B
                    782: \EG integer
1.1       noro      783: @end table
                    784:
                    785: @itemize @bullet
1.2       noro      786: \BJP
1.1       noro      787: @item
                    788: @code{ox_launch_generic()} $B$O(B,
                    789: $B%[%9%H(B @var{host} $B>e$G(B, $B%3%s%H%m!<%k%W%m%;%9(B @var{launch} $B$*$h$S(B
                    790: $B%5!<%P%W%m%;%9(B @var{server} $B$r5/F0$9$k(B. $B$=$NB>$N0z?t$O(B, $B;HMQ$9$k(B
                    791: protocol $B$N<oN`(B, X $B$N;HMQ(B/$BIT;HMQ(B, rsh/ssh $B$K$h$k%W%m%;%95/F0(B, connect
                    792: $BJ}K!$N;XDj$J$I$r9T$&%9%$%C%A$G$"$k(B.
1.2       noro      793:
1.1       noro      794: @item
                    795: @var{host} $B$,(B 0 $B$N>l9g(B, @b{Asir} $B$,F0:n$7$F$$$k%^%7%s>e$K(B, @var{launch},
                    796: @var{server} $B$rN)$A>e$2$k(B. $B$3$N>l9g(B, @var{use_unix} $B$NCM$K$+$+$o$i$:(B,
                    797: UNIX internal protocol $B$,MQ$$$i$l$k(B.
1.2       noro      798:
1.1       noro      799: @item
                    800: @var{use_unix} $B$,(B 1 $B$N>l9g(B, UNIX internal protocol $B$rMQ$$$k(B. 0 $B$N>l9g(B,
                    801: Internet protocol $B$rMQ$$$k(B.
1.2       noro      802:
1.1       noro      803: @item
                    804: @var{use_ssh} $B$,(B 1 $B$N>l9g(B, @samp{ssh} (Secure Shell) $B$K$h$j%3%s%H%m!<%k(B,
1.2       noro      805: $B%5!<%P%W%m%;%9$rN)$A>e$2$k(B. @samp{ssh-agent} $B$J$I$rMxMQ$7$F$$$J>l9g(B,
                    806: $B%Q%9%o!<%I$NF~NO$,I,MW$H$J$k(B.
1.1       noro      807: $BAj<j@h$G(B @samp{sshd} $B$,F0$$$F$$$J$$>l9g(B, $B<+F0E*$K(B @samp{rsh} $B$,MQ$$$i$l$k$,(B,
                    808: $B%Q%9%o!<%I$,I,MW$H$J$k>l9g$K$O(B, $B$=$N>l$G5/F0$K<:GT$9$k(B.
1.2       noro      809:
1.1       noro      810: @item
                    811: @var{use_x} $B$,(B 1 $B$N>l9g(B, X $B>e$G$NF0:n$r2>Dj$7(B, $B@_Dj$5$l$F$$$k(B DISPLAY$BJQ(B
                    812: $B?t$rMQ$$$F(B, log $BI=<(MQ(B @samp{xterm} $B$N$b$H$G(B @var{server} $B$,5/F0$5$l(B
                    813: $B$k(B. DISPLAY $BJQ?t$,%;%C%H$5$l$F$$$J$$>l9g$K$O(B, $B<+F0E*$K(B X $B$J$7$N@_Dj$H$J(B
                    814: $B$k(B. DISPLAY $B$,ITE,@Z$K%;%C%H$5$l$F$$$k>l9g$K$O(B, $B%3%s%H%m!<%k(B, $B%5!<%P$,%O(B
                    815: $B%s%0$9$k$N$GMWCm0U$G$"$k(B.
1.2       noro      816:
1.1       noro      817: @item
                    818: @var{conn_to_serv} $B$,(B 1 $B$N>l9g(B, @b{Asir} (client) $B$,@8@.$7$?%]!<%H$K(B
                    819: $BBP$7(B, client $B$,(B bind,listen $B$7(B, $B5/F0$5$l$?%W%m%;%9$,(B connect $B$9$k(B.
                    820: @var{conn_to_serv} $B$,(B 0 $B$N>l9g(B, $B5/F0$5$l$?%W%m%;%9$,(B bind, listen $B$7(B,
                    821: client $B$,(B connect $B$9$k(B.
1.2       noro      822: \E
                    823:
                    824: \BEG
                    825: @item
                    826: @code{ox_launch_generic()} invokes a control process @var{launch}
                    827: and a server process @var{server} on @var{host}. The other arguments
                    828: are switches for protocol family selection, on/off of the X environment,
                    829: method of process invocation and selection of connection type.
                    830:
                    831: @item
                    832: If @var{host} is equal to 0, processes
                    833: are invoked on the same machine as the @b{Asir} is running.
                    834: In this case UNIX internal protocol is always used.
                    835:
                    836: @item
                    837: If @var{use_unix} is equal to 1, UNIX internal protocol is used.
                    838: If @var{use_unix} is equal to 0, Internet protocol is used.
                    839:
                    840: @item
                    841: If @var{use_ssh} is equal to 1,@samp{ssh} (Secure Shell)
                    842: is used to invoke processes. If one does not use @samp{ssh-agent},
                    843: a password (passphrase) is required.
                    844: If @samp{sshd} is not running on the target machine,
                    845: @samp{rsh} is used instead. But it will immediately fail
                    846: if a password is required.
                    847:
                    848: @item
                    849: If @var{use_x} is equal to 1, it is assumed that X environment
                    850: is available. In such a case @var{server} is invoked under
                    851: @samp{xterm} by using the current @code{DISPLAY} variable.
                    852: If @code{DISPLAY} is not set, it is invoked without X.
                    853: Note that the processes will hang up if @code{DISPLAY} is incorrectly set.
                    854:
                    855: @item
                    856: If @var{conn_to_serv} is equal to 1, @b{Asir} (client)
                    857: executes @code{bind} and @code{listen}, and the invoked processes execute
                    858: @code{connect}.
                    859: If @var{conn_to_serv} is equal to 0, @b{Asir} (client)
                    860: the invoked processes execute @code{bind} and @code{listen}, and
                    861: the client executes @code{connect}.
                    862: \E
1.1       noro      863: @end itemize
                    864:
                    865: @example
                    866: [342] LIB=get_rootdir();
                    867: /export/home/noro/ca/Kobe/build/OpenXM/lib/asir
                    868: [343] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",0,0,0,0);
                    869: 1
                    870: [344] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",1,0,0,0);
                    871: 2
                    872: [345] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",1,1,0,0);
                    873: 3
                    874: [346] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",1,1,1,0);
                    875: 4
                    876: [347] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",1,1,1,1);
                    877: 5
                    878: [348] ox_launch_generic(0,LIB+"/ox_launch",LIB+"/ox_asir",1,1,0,1);
                    879: 6
                    880: @end example
                    881:
                    882: @table @t
1.2       noro      883: \JP @item $B;2>H(B
                    884: \EG @item References
                    885: @fref{ox_launch ox_launch_nox ox_shutdown}, @fref{ox_launch_generic}
1.1       noro      886: @end table
                    887:
1.2       noro      888: \JP @node generate_port try_bind_listen try_connect try_accept register_server,,, $BJ,;67W;;$K4X$9$k4X?t(B
                    889: \EG @node generate_port try_bind_listen try_connect try_accept register_server,,, Functions for distributed computation
1.1       noro      890: @subsection @code{generate_port}, @code{try_bind_listen}, @code{try_connect}, @code{try_accept}, @code{register_server}
                    891: @findex generate_port
                    892: @findex try_bind_listen
                    893: @findex try_connect
                    894: @findex try_accept
                    895: @findex register_server
                    896:
                    897: @table @t
                    898: @item generate_port([@var{use_unix}])
1.2       noro      899: \JP :: port $B$N@8@.(B
                    900: \EG :: Generates a port number.
1.1       noro      901: @itemx try_bind_listen(@var{port})
1.2       noro      902: \JP :: port $B$KBP$7$F(B bind, listen
                    903: \EG :: Binds and listens on a port.
1.1       noro      904: @itemx try_connect(@var{host},@var{port})
1.2       noro      905: \JP :: port $B$KBP$7$F(B connect
                    906: \EG :: Connects to a port.
1.1       noro      907: @itemx try_accept(@var{socket},@var{port})
1.2       noro      908: \JP :: connect $BMW5a$r(B accept
                    909: \EG :: Accepts a connection request.
1.1       noro      910: @itemx register_server(@var{control_socket},@var{control_port},@var{server_socket},@var{server_port})
1.2       noro      911: \JP :: connection $B$N@.N)$7$?(B control socket, server socket $B$NEPO?(B
                    912: \EG :: Registers the sockets for which connections are established.
1.1       noro      913: @end table
                    914:
                    915: @table @var
                    916: @item return
1.2       noro      917: \JP @code{generate_port()} $B$N$_@0?t$^$?$OJ8;zNs(B. $B$=$NB>$O@0?t(B.
                    918: \EG integer or string for @code{generate_port()}, integer for the others
1.1       noro      919: @item use_unix
1.2       noro      920: \JP 0 $B$^$?$O(B 1
                    921: \EG 0 or 1
1.1       noro      922: @item host
1.2       noro      923: \JP $BJ8;zNs(B
                    924: \EG string
1.1       noro      925: @item port,control_port,server_port
1.2       noro      926: \JP $B@0?t$^$?$OJ8;zNs(B
                    927: \EG integer or string
1.1       noro      928: @item socket,control_socket,server_socket
1.2       noro      929: \JP $B@0?t(B
                    930: \EG integer
1.1       noro      931: @end table
                    932:
                    933: @itemize @bullet
1.2       noro      934: \BJP
1.1       noro      935: @item
                    936: $B$3$l$i$N4X?t$O(B, $B1s3V%W%m%;%9$HDL?.$r@.N)$5$;$k$?$a$N%W%j%_%F%#%V$G$"$k(B.
1.2       noro      937:
1.1       noro      938: @item
                    939: @code{generate_port()} $B$ODL?.$N$?$a$N(B port $B$r@8@.$9$k(B. $BL50z?t$"$k$$$O(B
                    940: $B0z?t$,(B 0 $B$N>l9g(B, Internet domain $B$N(B socket $B$N$?$a$N(B port $BHV9f(B, $B$=$l(B
                    941: $B0J30$N>l9g$K$O(B, UNIX domain (host-internal protocol) $B$N$?$a$N(B, $B%U%!%$%kL>(B
                    942: $B$r@8@.$9$k(B. port $BHV9f$O(B random $B$K@8@.$5$l$k$,(B, $B$=$N(B port $B$,;HMQCf$G$J$$(B
                    943: $BJ]>Z$O$J$$(B.
1.2       noro      944:
1.1       noro      945: @item
                    946: @code{try_bind_listen()} $B$O(B, $BM?$($i$l$?(B port $B$KBP$7(B, $B$=$N(B protocol $B$K(B
1.2       noro      947: $BBP1~$7$?(B socket $B$r@8@.$7(B, bind, listen $B$9$k(B. $B@.8y$7$?>l9g(B,
                    948: socket $B<1JL;R$rJV$9(B. $B<:GT$7$?>l9g(B, -1 $B$,JV$k(B.
                    949:
1.1       noro      950: @item
                    951: @code{try_connect()} $B$O(B, $B%[%9%H(B @var{host} $B$N(B port @var{port} $B$KBP$7(B
1.2       noro      952: connect $B$r;n$_$k(B. $B@.8y$7$?>l9g(B, socket $B<1JL;R$rJV$9(B. $B<:GT$7$?>l9g(B -1 $B$,JV$k(B.
                    953:
1.1       noro      954: @item
                    955: @code{try_accept()} $B$O(B, @var{socket} $B$KBP$9$k(B connect $BMW5a$r(B accept
                    956: $B$7(B, $B?7$?$K@8@.$5$l$?(B socket $B$rJV$9(B. $B<:GT$7$?>l9g(B -1 $B$,JV$k(B.
                    957: $B$$$:$l$N>l9g$K$b(B, @var{socket} $B$O<+F0E*$K(B close $B$5$l$k(B.
                    958: $B0z?t(B @var{port} $B$O(B, @var{socket} $B$N(B protocol $B$rH=JL$9$k$?$a$KM?$($k(B.
1.2       noro      959:
1.1       noro      960: @item
                    961: @code{register_server()} $B$O(B, control, server $B$=$l$>$l$N(B socket $B$r(B
                    962: $B0lAH$K$7$F(B, server list $B$KEPO?$7(B, @code{ox_push_cmo()} $B$J$I$GMQ$$$k(B
                    963: $B%W%m%;%9<1JL;R$rJV$9(B.
1.2       noro      964:
1.1       noro      965: @item
                    966: $B1s3V%W%m%;%9$N5/F0$O(B, @code{shell()} $B$^$?$O<jF0$G9T$&(B.
1.2       noro      967: \E
                    968: \BEG
                    969: @item
                    970: These functions are primitives to establish communications between
                    971: a client and servers.
                    972:
                    973: @item
                    974: @code{generate_port()} generates a port name for communication.
                    975: If the argument is not specified or equal to 0, a port number
                    976: for Internet domain socket is generated randomly. Otherwise
                    977: a file name for UNIX domain (host-internal protocol) is generated.
                    978: Note that it is not assured that the generated port is not in use.
                    979:
                    980: @item
                    981: @code{try_bind_listen()} creates a socket according to the protocol
                    982: family indicated by the given port and executes @code{bind} and @code{listen}.
                    983: It returns a socket identifier if it is successful. -1 indicates an error.
                    984:
                    985: @item
                    986: @code{try_connect()} tries to connect to a port @var{port} on
                    987: a host @var{host}.
                    988: It returns a socket identifier if it is successful. -1 indicates an error.
                    989:
                    990: @item
                    991: @code{try_accept()} accepts a connection request to a socket @var{socket}.
                    992: It returns a new socket identifier if it is successful. -1 indicates an error.
                    993: In any case @var{socket} is automatically closed.
                    994: @var{port} is specified to distinguish the protocol family of @var{socket}.
                    995:
                    996: @item
                    997: @code{register_server()} registers a pair of a control socket and a server
                    998: socket. A process identifier indicating the pair is returned.
                    999: The process identifier is used as an argument
                   1000: of @code{ox} functions such as @code{ox_push_cmo()}.
                   1001:
                   1002: @item
                   1003: Servers are invoked by using @code{shell()}, or manually.
                   1004: \E
1.1       noro     1005: @end itemize
                   1006:
                   1007: @example
                   1008: [340] CPort=generate_port();
                   1009: 39896
                   1010: [341] SPort=generate_port();
                   1011: 37222
                   1012: [342] CSocket=try_bind_listen(CPort);
                   1013: 3
                   1014: [343] SSocket=try_bind_listen(SPort);
                   1015: 5
                   1016:
                   1017: /*
1.2       noro     1018: \JP $B$3$3$G(B, ox_launch $B$r5/F0(B :
                   1019: \EG ox_launch is invoked here :
1.1       noro     1020: %  ox_launch "127.1" 0 39716 37043 ox_asir "shio:0"
                   1021: */
                   1022:
                   1023: [344] CSocket=try_accept(CSocket,CPort);
                   1024: 6
                   1025: [345] SSocket=try_accept(SSocket,SPort);
                   1026: 3
                   1027: [346] register_server(CSocket,CPort,SSocket,SPort);
                   1028: 0
                   1029: @end example
                   1030:
                   1031: @table @t
1.2       noro     1032: \JP @item $B;2>H(B
                   1033: \EG @item References
                   1034: @fref{ox_launch ox_launch_nox ox_shutdown},
                   1035: @fref{ox_launch_generic}, @fref{shell}, @fref{ox_push_cmo ox_push_local}
1.1       noro     1036: @end table
                   1037:
1.2       noro     1038: \JP @node ox_asir,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1039: \EG @node ox_asir,,, Functions for distributed computation
1.1       noro     1040: @subsection @samp{ox_asir}
                   1041:
1.2       noro     1042: \BJP
                   1043: @samp{ox_asir} $B$O(B, @b{Asir} $B$N$[$\A4$F$N5!G=$r(B @b{OpenXM} $B%5!<%P(B
                   1044: $B$H$7$FDs6!$9$k(B.
                   1045: @samp{ox_asir} $B$O(B, @code{ox_launch} $B$^$?$O(B @code{ox_launch_nox} $B$G(B
                   1046: $B5/F0$9$k(B. $B8e<T$O(B X $B4D6-$rMQ$$$J$$>l9g$N$?$a$KMQ0U$5$l$F$$$k(B.
                   1047: \E
                   1048: \BEG
                   1049: @samp{ox_asir} provides almost all the functionalities of @b{Asir} as
                   1050: an @b{OpenXM} server.
                   1051: @samp{ox_asir} is invoked by @code{ox_launch} or @code{ox_launch_nox}.
                   1052: If X environment is not available or is not necessary, one can use
                   1053: @code{ox_launch_nox}.
                   1054: \E
1.1       noro     1055:
                   1056: @example
                   1057: [5] ox_launch();
                   1058: 0
                   1059: @end example
                   1060:
                   1061: @example
                   1062: [5] ox_launch_nox("127.0.0.1","/usr/local/lib/asir","/usr/local/lib/asir/ox_asir");
                   1063: 0
                   1064: @end example
                   1065:
                   1066: @example
                   1067: [7] RemoteLibDir = "/usr/local/lib/asir/"$
                   1068: [8] Machines = ["sumire","rokkaku","genkotsu","shinpuku"];
                   1069: [sumire,rokkaku,genkotsu,shinpuku]
                   1070: [9] Servers = map(ox_launch,Machines,RemoteLibDir,RemoteLibDir+"ox_asir");
                   1071: [0,1,2,3]
                   1072: @end example
                   1073:
                   1074: @table @t
1.2       noro     1075: \JP @item $B;2>H(B
                   1076: \EG @item References
                   1077: @fref{ox_launch ox_launch_nox ox_shutdown}
1.1       noro     1078: @end table
                   1079:
1.2       noro     1080: \JP @node ox_rpc ox_cmo_rpc ox_execute_string,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1081: \EG @node ox_rpc ox_cmo_rpc ox_execute_string,,, Functions for distributed computation
1.1       noro     1082: @subsection @code{ox_rpc}, @code{ox_cmo_rpc}, @code{ox_execute_string}
                   1083: @findex ox_rpc
                   1084: @findex ox_cmo_rpc
                   1085: @findex ox_execute_string
                   1086:
                   1087: @table @t
                   1088: @item ox_rpc(@var{number},@code{"@var{func}"},@var{arg0},...)
                   1089: @itemx ox_cmo_rpc(@var{number},@code{"@var{func}"},@var{arg0},...)
                   1090: @itemx ox_execute_string(@var{number},@code{"@var{command}"},...)
1.2       noro     1091: \JP :: $B%W%m%;%9$NH!?t8F$S=P$7(B
                   1092: \EG :: Calls a function on an OpenXM server
1.1       noro     1093: @end table
                   1094:
                   1095: @table @var
                   1096: @item return
                   1097: 0
                   1098: @item number
1.2       noro     1099: \JP $B?t(B ($B%W%m%;%9<1JL;R(B)
                   1100: \EG integer (process identifier)
1.1       noro     1101: @item func
1.2       noro     1102: \JP $BH!?tL>(B
                   1103: \EG function name
1.1       noro     1104: @item command
1.2       noro     1105: \JP $BJ8;zNs(B
                   1106: \EG string
1.1       noro     1107: @item arg0, arg1, ...
1.2       noro     1108: \JP $BG$0U(B ($B0z?t(B)
                   1109: \EG arbitrary (arguments)
1.1       noro     1110: @end table
                   1111:
                   1112: @itemize @bullet
1.2       noro     1113: \BJP
1.1       noro     1114: @item
                   1115: $B<1JL;R(B @var{number} $B$N%W%m%;%9$NH!?t$r8F$S=P$9(B.
1.2       noro     1116:
1.1       noro     1117: @item
                   1118: $BH!?t$N7W;;=*N;$rBT$?$:(B, $BD>$A$K(B 0 $B$rJV$9(B.
1.2       noro     1119:
1.1       noro     1120: @item
                   1121: @code{ox_rpc()} $B$O(B, $B%5!<%P$,(B @samp{ox_asir} $B$N>l9g$N$_MQ$$$k$3$H$,$G$-$k(B.
                   1122: $B$=$l0J30$N>l9g$O(B, @code{ox_cmo_rpc()} $B$rMQ$$$k(B.
1.2       noro     1123:
1.1       noro     1124: @item
                   1125: $BH!?t$,JV$9CM$O(B @code{ox_pop_local()}, @code{ox_pop_cmo()} $B$K$h$j<h$j=P$9(B.
1.2       noro     1126:
1.1       noro     1127: @item
                   1128: $B%5!<%P$,(B @samp{ox_asir} $B0J30$N$b$N(B ($BNc$($P(B Kan $B%5!<%P(B @samp{ox_sm1}$B$J$I(B)
                   1129: $B$N>l9g$K$O(B, @b{Open_XM} $B%W%m%H%3%k$G%5%]!<%H$5$l$F$$$k%G!<%?$N$_$r(B
                   1130: $BAw$k$3$H$,$G$-$k(B.
1.2       noro     1131:
1.1       noro     1132: @item
                   1133: @code{ox_execute_string} $B$O(B, $BAw$C$?J8;zNs(B @var{command} $B$r%5!<%P$,<+$i$N(B
                   1134: $B%f!<%68@8l%Q!<%6$G2r@O$7(B, $BI>2A$7$?7k2L$r%5!<%P$N%9%?%C%/$KCV$/$h$&$K(B
                   1135: $B;X<($9$k(B.
1.2       noro     1136: \E
                   1137:
                   1138: \BEG
                   1139: @item
                   1140: Calls a function on an @b{OpenXM} server whose identifier is @var{number}.
                   1141:
                   1142: @item
                   1143: It returns 0 immediately. It does not wait the termination of the function
                   1144: call.
                   1145:
                   1146: @item
                   1147: @code{ox_rpc()} can be used when the server is @samp{ox_asir}.
                   1148: Otherwise @code{ox_cmo_rpc()} should be used.
                   1149:
                   1150: @item
                   1151: The result of the function call is put on the stack of the server.
                   1152: It can be received by @code{ox_pop_local()} or @code{ox_pop_cmo()}.
                   1153:
                   1154: @item
                   1155: If the server is not @samp{ox_asir}, only data defined in
                   1156: @b{OpenXM} can be sent.
                   1157:
                   1158: @item
                   1159: @code{ox_execute_string} requests the server to parse and execute
                   1160: @var{command} by the parser and the evaluater of the server.
                   1161: The result is pushed to the stack.
                   1162: \E
1.1       noro     1163: @end itemize
                   1164:
                   1165: @example
                   1166: [234] ox_cmo_rpc(0,"dp_ht",dp_ptod((x+y)^10,[x,y]));
                   1167: 0
                   1168: [235] ox_pop_cmo(0);
                   1169: (1)*<<10,0>>
                   1170: [236] ox_execute_string(0,"12345 % 678;");
                   1171: 0
                   1172: [237] ox_pop_cmo(0);
                   1173: 141
                   1174: @end example
                   1175:
                   1176: @table @t
1.2       noro     1177: \JP @item $B;2>H(B
                   1178: \EG @item References
                   1179: @fref{ox_pop_cmo ox_pop_local}
1.1       noro     1180: @end table
                   1181:
1.2       noro     1182: \JP @node ox_reset register_handler,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1183: \EG @node ox_reset register_handler,,, Functions for distributed computation
1.1       noro     1184: @subsection @code{ox_reset},@code{register_handler}
                   1185: @findex ox_reset
                   1186: @findex register_handler
                   1187:
                   1188: @table @t
                   1189: @item ox_reset(@var{number})
1.2       noro     1190: \JP :: $B%W%m%;%9$N%j%;%C%H(B
                   1191: \EG :: Resets an OpenXM server
1.1       noro     1192: @item register_handler(@var{func})
1.2       noro     1193: \JP :: $B%W%m%;%9$N%j%;%C%H$N$?$a$N4X?tEPO?(B
                   1194: \EG :: Registers a function callable on a keyboard interrupt.
1.1       noro     1195: @end table
                   1196:
                   1197: @table @var
                   1198: @item return
                   1199: 1
                   1200: @item number
1.2       noro     1201: \JP $B?t(B ($B%W%m%;%9<1JL;R(B)
                   1202: \EG integer(process identifier)
1.1       noro     1203: @item func
1.2       noro     1204: \JP $B4X?t;R$^$?$O(B 0
                   1205: \EG functor or 0
1.1       noro     1206: @end table
                   1207:
                   1208: @itemize @bullet
1.2       noro     1209: \BJP
1.1       noro     1210: @item
                   1211: @code{ox_reset()} $B$O(B, $B<1JL;R(B @var{number} $B$N%W%m%;%9$r%j%;%C%H$7(B, $B%3%^%s(B
                   1212: $B%I<u$1IU$1>uBV$K$9$k(B.
1.2       noro     1213:
1.1       noro     1214: @item
                   1215: $B$=$N%W%m%;%9$,4{$K=q$-=P$7$?(B, $B$"$k$$$O8=:_=q$-=P$7Cf$N%G!<%?$,$"$k>l9g(B,
                   1216: $B$=$l$rA4ItFI$_=P$7(B, $B=PNO%P%C%U%!$r6u$K$7$?;~E@$GLa$k(B.
1.2       noro     1217:
1.1       noro     1218: @item
                   1219: $B;R%W%m%;%9$,(B RUN $B>uBV$N>l9g$G$b(B, $B3d$j9~$_$K$h$j6/@)E*$K7W;;$r=*N;$5$;$k(B.
1.2       noro     1220:
1.1       noro     1221: @item
                   1222: $BJ,;67W;;$r9T$&H!?t$N@hF,$G(B, $B;HMQ$9$k%W%m%;%9$KBP$7$F<B9T$9$k(B. $B$"$k$$$O(B
                   1223: $B7W;;ESCf$G$N6/@)CfCG$KMQ$$$k(B.
1.2       noro     1224:
1.1       noro     1225: @item
                   1226: @code{register_handler()} $B$O(B, @kbd{C-c} $B$J$I$K$h$k3d$j9~$_$N:]$K(B,
                   1227: @kbd{u} $B$r;XDj$9$k$3$H$G(B, $BL50z?t%f!<%6Dj5A4X?t(B @var{func()} $B$,8F$S=P$5$l$k(B
                   1228: $B$h$&$K@_Dj$9$k(B. $B$3$N4X?t$K(B, @code{ox_reset()} $B$r8F$S=P$5$;$k$3$H$G(B,
1.2       noro     1229: $B3d$j9~$_$N:]$K<+F0E*$K(B @b{OpenXM} server $B$N%j%;%C%H$r9T$&$3$H$,$G$-$k(B.
                   1230:
1.1       noro     1231: @item
                   1232: @var{func} $B$K(B 0 $B$r;XDj$9$k$3$H$G(B, $B@_Dj$r2r=|$G$-$k(B.
1.2       noro     1233: \E
                   1234:
                   1235: \BEG
                   1236: @item
                   1237: @code{ox_reset()} resets a process whose identifier is @var{number}.
                   1238: After its execution the process is ready for receiving data.
                   1239:
                   1240: @item
                   1241: After executing @code{ox_reset()}, sending/receiving buffers and
                   1242: stream buffers are assured to be empty.
                   1243:
                   1244: @item
                   1245: Even if a process is running, the execution is safely stopped.
                   1246:
                   1247: @item
                   1248: @code{ox_reset()} may be used prior to a distirbuted computation.
                   1249: It can be also used to interrupt a distributed computation.
                   1250:
                   1251: @item
                   1252: @code{register_handler()} registers a function @var{func()}.
                   1253: If @kbd{u} is specified on a keybord interrupt, @var{func()}
                   1254: is executed before returning the toplevel.
                   1255: If @code{ox_reset()} calls are included in @var{func()},
                   1256: one can automatically reset @b{OpenXM} servers on a keyboard interrupt.
                   1257:
                   1258: @item
                   1259: If @var{func} is equal to 0, the setting is reset.
                   1260: \E
1.1       noro     1261: @end itemize
                   1262:
                   1263: @example
                   1264: [10] ox_launch();
                   1265: 0
                   1266: [11] ox_rpc(0,"fctr",x^100-y^100);
                   1267: 0
1.2       noro     1268: \BJP
                   1269: [12] ox_reset(0); /* xterm $B$N%&%#%s%I%&$K$O(B                             */
                   1270: 1                 /* usr1 : return to toplevel by SIGUSR1 $B$,I=<($5$l$k(B. */
                   1271: \E
                   1272: \BEG
                   1273: [12] ox_reset(0); /* usr1 : return to toplevel by SIGUSR1 */
                   1274: 1                 /* is displayed on the xterm.           */
                   1275: \E
1.1       noro     1276: @end example
                   1277:
                   1278: @example
                   1279: [340] Procs=[ox_launch(),ox_launch()];
                   1280: [0,1]
                   1281: [341] def reset() @{ extern Procs; map(ox_reset,Procs);@}
                   1282: [342] map(ox_rpc,Procs,"fctr",x^100-y^100);
                   1283: [0,0]
                   1284: [343] register_handler(reset);
                   1285: 1
                   1286: [344] interrupt ?(q/t/c/d/u/w/?) u
                   1287: Abort this computation? (y or n) y
                   1288: Calling the registered exception handler...done.
                   1289: return to toplevel
                   1290: @end example
                   1291: @table @t
1.2       noro     1292: \JP @item $B;2>H(B
                   1293: \EG @item References
                   1294: @fref{ox_rpc ox_cmo_rpc ox_execute_string}
1.1       noro     1295: @end table
                   1296:
1.2       noro     1297: \JP @node ox_push_cmo ox_push_local,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1298: \EG @node ox_push_cmo ox_push_local,,, Functions for distributed computation
1.1       noro     1299: @subsection @code{ox_push_cmo}, @code{ox_push_local}
                   1300: @findex ox_push_cmo
                   1301: @findex ox_push_local
                   1302:
                   1303: @table @t
                   1304: @item ox_push_cmo(@var{number},@var{obj})
                   1305: @itemx ox_push_local(@var{number},@var{obj})
1.2       noro     1306: \JP :: @var{obj} $B$r<1JL;R(B @var{number} $B$N%W%m%;%9$KAw?.(B
                   1307: \EG :: Sends @var{obj} to a process whose identifier is @var{number}.
1.1       noro     1308: @end table
                   1309:
                   1310: @table @var
                   1311: @item return
                   1312: 0
                   1313: @item number
1.2       noro     1314: \JP $B?t(B($B%W%m%;%9<1JL;R(B)
                   1315: \EG integer(process identifier)
1.1       noro     1316: @item obj
1.2       noro     1317: \JP $B%*%V%8%'%/%H(B
                   1318: \EG object
1.1       noro     1319: @end table
                   1320:
                   1321: @itemize @bullet
1.2       noro     1322: \BJP
1.1       noro     1323: @item $B<1JL;R(B @var{number} $B$N%W%m%;%9$K(B @var{obj} $B$rAw?.$9$k(B.
                   1324: @item @code{ox_push_cmo} $B$O(B, Asir $B0J30$N(B @b{Open_XM} $B%5!<%P$KAw?.(B
                   1325: $B$9$k:]$KMQ$$$k(B.
                   1326: @item @code{ox_push_local} $B$O(B, @samp{ox_asir}, @samp{ox_plot} $B$K(B
                   1327: $B%G!<%?$rAw$k>l9g$KMQ$$$k$3$H$,$G$-$k(B.
                   1328: @item $B%P%C%U%!$,$$$C$Q$$$K$J$i$J$$8B$j(B, $B$?$@$A$KI|5"$9$k(B.
1.2       noro     1329: \E
                   1330: \BEG
                   1331: @item
                   1332: Sends @var{obj} to a process whose identifier is @var{number}.
                   1333:
                   1334: @item
                   1335: @code{ox_push_cmo} is used to send data to an @b{Open_XM} other
                   1336: than @samp{ox_asir} and @samp{ox_plot}.
                   1337:
                   1338: @item
                   1339: @code{ox_push_local} is used to send data to @samp{ox_asir} and @samp{ox_plot}.
                   1340:
                   1341: @item
                   1342: The call immediately returns unless the stream buffer is full.
                   1343: \E
1.1       noro     1344: @end itemize
                   1345:
                   1346: @table @t
1.2       noro     1347: \JP @item $B;2>H(B
                   1348: \EG @item References
                   1349: @fref{ox_rpc ox_cmo_rpc ox_execute_string},
                   1350: @fref{ox_pop_cmo ox_pop_local}
1.1       noro     1351: @end table
                   1352:
1.2       noro     1353: \JP @node ox_pop_cmo ox_pop_local,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1354: \EG @node ox_pop_cmo ox_pop_local,,, Functions for distributed computation
1.1       noro     1355: @subsection @code{ox_pop_cmo}, @code{ox_pop_local}
                   1356: @findex ox_pop_local
                   1357: @findex ox_pop_cmo
                   1358:
                   1359: @table @t
                   1360: @item ox_pop_local(@var{number})
1.2       noro     1361: \JP :: $B%W%m%;%9<1JL;R(B @var{number} $B$+$i%G!<%?$r<u?.$9$k(B.
                   1362: \EG :: Receives data from a process whose identifier is @var{number}.
1.1       noro     1363: @end table
                   1364:
                   1365: @table @var
                   1366: @item return
1.2       noro     1367: \JP $B<u?.%G!<%?(B
                   1368: \EG received data
1.1       noro     1369: @item number
1.2       noro     1370: \JP $B?t(B ($B%W%m%;%9<1JL;R(B)
                   1371: \EG integer(process identifier)
1.1       noro     1372: @end table
                   1373:
                   1374: @itemize @bullet
1.2       noro     1375: \BJP
1.1       noro     1376: @item
                   1377: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$+$i%G!<%?$r<u?.$9$k(B.
                   1378: @item @code{ox_pop_cmo} $B$O(B, Asir $B0J30$N(B @b{Open_XM} $B%5!<%P$+$i<u?.(B
                   1379: $B$9$k:]$KMQ$$$k(B.
                   1380: @item @code{ox_pop_local} $B$O(B, @samp{ox_asir}, @samp{ox_plot} $B$+$i(B
                   1381: $B%G!<%?$r<u$1<h$k>l9g$KMQ$$$k$3$H$,$G$-$k(B.
                   1382: @item $B%5!<%P$,7W;;Cf$N>l9g%V%m%C%/$9$k(B. $B$3$l$rHr$1$k$?$a$K$O(B,
                   1383: @code{ox_push_cmd} $B$G(B @code{SM_popCMO} (262) $B$^$?$O(B @code{SM_popSerializedLocalObject} (258) $B$rAw$C$F$*$-(B, @code{ox_select} $B$G%W%m%;%9$,(B ready
                   1384: $B$K$J$C$F$$$k$3$H$r3N$+$a$F$+$i(B @code{ox_get} $B$9$l$P$h$$(B.
1.2       noro     1385: \E
                   1386: \BEG
1.1       noro     1387: @item
1.2       noro     1388: Receives data from a process whose identifier is @var{number}.
                   1389: @item
                   1390: @code{ox_pop_cmo} can be used to receive data form an @b{OpenXM} server
                   1391: other than @samp{ox_asir} and @samp{ox_plot}.
                   1392: @item
                   1393: @code{ox_pop_local} can be used to receive data from
                   1394: @samp{ox_asir}, @samp{ox_plot}.
                   1395: @item
                   1396: If no data is available, these functions block.
                   1397: To avoid it, send @code{SM_popCMO} (262) or
                   1398: @code{SM_popSerializedLocalObject} (258).
                   1399: Then check the process status by @code{ox_select}.
                   1400: Finally call @code{ox_get} for a ready process.
                   1401: \E
1.1       noro     1402: @end itemize
                   1403:
                   1404: @example
                   1405: [3] ox_rpc(0,"fctr",x^100-y^100);
                   1406: 0
                   1407: [4] ox_push_cmd(0,258);
                   1408: 0
                   1409: [5] ox_select([0]);
                   1410: [0]
                   1411: [6] ox_get(0);
                   1412: [[1,1],[x^2+y^2,1],[x^4-y*x^3+y^2*x^2-y^3*x+y^4,1],...]
                   1413: @end example
                   1414:
                   1415: @table @t
1.2       noro     1416: \JP @item $B;2>H(B
                   1417: \EG @item References
                   1418: @fref{ox_rpc ox_cmo_rpc ox_execute_string},
                   1419: @fref{ox_push_cmd ox_sync}, @fref{ox_select}, @fref{ox_get}
1.1       noro     1420: @end table
                   1421:
1.2       noro     1422: \JP @node ox_push_cmd ox_sync,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1423: \EG @node ox_push_cmd ox_sync,,, Functions for distributed computation
1.1       noro     1424: @subsection @code{ox_push_cmd}, @code{ox_sync}
                   1425: @findex ox_push_cmd
                   1426: @findex ox_sync
                   1427:
                   1428: @table @t
                   1429: @item ox_push_cmd(@var{number},@var{command})
1.2       noro     1430: \JP :: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$K%3%^%s%I(B @var{command} $B$rAw?.$9$k(B.
                   1431: \EG :: Sends a command @var{command} to a process whose identifier is @var{number}.
1.1       noro     1432: @item ox_sync(@var{number})
1.2       noro     1433: \JP :: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$K(B @b{OX_SYNC_BALL} $B$rAw?.$9$k(B.
                   1434: \EG :: Sends @b{OX_SYNC_BALL} to a process whose identifier is @var{number}.
1.1       noro     1435: @end table
                   1436:
                   1437: @table @var
                   1438: @item return
                   1439: 0
                   1440: @item number
1.2       noro     1441: \JP $B?t(B ($B%W%m%;%9<1JL;R(B)
                   1442: \EG integer(process identifier)
1.1       noro     1443: @item command
1.2       noro     1444: \JP $B?t(B ($B%3%^%s%I<1JL;R(B)
                   1445: \EG integer(command identifier)
1.1       noro     1446: @end table
                   1447:
                   1448: @itemize @bullet
1.2       noro     1449: \BJP
1.1       noro     1450: @item
                   1451: $B<1JL;R(B @var{number} $B$N%W%m%;%9$K%3%^%s%I$^$?$O(B @b{OX_SYNC_BALL} $B$rAw?.$9$k(B.
1.2       noro     1452:
1.1       noro     1453: @item
                   1454: @b{Open_XM} $B$K$*$$$FAw<u?.%G!<%?$O(B @b{OX_DATA}, @b{OX_COMMAND},
                   1455: @b{OX_SYNC_BALL}$B$N(B 3 $B<oN`$KJ,$+$l$k(B. $BDL>o(B, $B%3%^%s%I$O2?$i$+$NA`:n$K(B
                   1456: $BIU?o$7$F0EL[$N$&$A$KAw?.$5$l$k$,(B, $B$3$l$r%f!<%6$,8DJL$KAw$j$?$$>l9g$K(B
                   1457: $BMQ$$$i$l$k(B.
1.2       noro     1458:
1.1       noro     1459: @item
                   1460: @b{OX_SYNC_BALL} $B$O(B @code{ox_reset} $B$K$h$k7W;;CfCG(B, $BI|5"$N:]$KAw<u?.$5$l$k(B
                   1461: $B$,(B, $B$3$l$r8DJL$KAw$j$?$$>l9g$KMQ$$$k(B. $B$J$*(B, $BDL>o>uBV$G$O(B @b{OX_SYNC_BALL}
                   1462: $B$OL5;k$5$l$k(B.
1.2       noro     1463: \E
                   1464:
                   1465: \BEG
                   1466: @item
                   1467: Sends a command or @b{OX_SYNC_BALL} to a process whose identifier is
                   1468: @var{number}.
                   1469:
                   1470: @item
                   1471: Data in @b{OpenXM} are categorized into three types:
                   1472: @b{OX_DATA}, @b{OX_COMMAND}, @b{OX_SYNC_BALL}.
                   1473: Usually @b{OX_COMMAND} and @b{OX_SYNC_BALL} are
                   1474: sent implicitly with high level operations, but
                   1475: these functions are prepared to send these data explicitly.
                   1476:
                   1477: @item
                   1478: @b{OX_SYNC_BALL} is used on the reseting operation by @code{ox_reset}.
                   1479: Usually @b{OX_SYNC_BALL} will be ignored by the peer.
                   1480: \E
1.1       noro     1481: @end itemize
                   1482:
                   1483: @table @t
1.2       noro     1484: \JP @item $B;2>H(B
                   1485: \EG @item References
                   1486: @fref{ox_rpc ox_cmo_rpc ox_execute_string}, @fref{ox_reset register_handler}
1.1       noro     1487: @end table
                   1488:
1.2       noro     1489: \JP @node ox_get,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1490: \EG @node ox_get,,, Functions for distributed computation
1.1       noro     1491: @subsection @code{ox_get}
                   1492: @findex ox_get
                   1493:
                   1494: @table @t
                   1495: @item ox_get(@var{number})
1.2       noro     1496: \JP :: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$+$i%G!<%?$r<u?.$9$k(B.
                   1497: \EG :: Receives data form a process whose identifer is @var{number}.
1.1       noro     1498: @end table
                   1499:
                   1500: @table @var
                   1501: @item return
1.2       noro     1502: \JP $B<u?.%G!<%?(B
1.1       noro     1503: @item number
1.2       noro     1504: \JP $B?t(B($B%W%m%;%9<1JL;R(B)
                   1505: \EG integer(process identifier)
1.1       noro     1506: @end table
                   1507:
                   1508: @itemize @bullet
1.2       noro     1509: \BJP
1.1       noro     1510: @item
                   1511: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$+$i%G!<%?$r<u?.$9$k(B. $B4{$K(B
                   1512: $B%9%H%j!<%`>e$K%G!<%?$,$"$k$3$H$r2>Dj$7$F$$$k(B.
1.2       noro     1513:
1.1       noro     1514: @item
                   1515: @code{ox_push_cmd} $B$HAH$_9g$o$;$FMQ$$$k(B.
1.2       noro     1516:
1.1       noro     1517: @item
                   1518: @code{ox_pop_cmo}, @code{ox_pop_local} $B$O(B, @code{ox_push_cmd} $B$H(B
                   1519: @code{ox_get} $B$NAH$_9g$o$;$G<B8=$5$l$F$$$k(B.
1.2       noro     1520: \E
                   1521: \BEG
                   1522: @item
                   1523: Receives data form a process whose identifer is @var{number}.
                   1524:
                   1525: @item
                   1526: One may use this function with @code{ox_push_cmd}.
                   1527:
                   1528: @item
                   1529: @code{ox_pop_cmo} and @code{ox_pop_local}
                   1530: is realized as combinations of @code{ox_push_cmd} and @code{ox_get}.
                   1531: \E
1.1       noro     1532: @end itemize
                   1533:
                   1534: @example
                   1535: [11] ox_push_cmo(0,123);
                   1536: 0
                   1537: [12] ox_push_cmd(0,262); /* 262=OX_popCMO */
                   1538: 0
                   1539: [13] ox_get(0);
                   1540: 123
                   1541: @end example
                   1542:
                   1543: @table @t
1.2       noro     1544: \JP @item $B;2>H(B
                   1545: \EG @item References
                   1546: @fref{ox_pop_cmo ox_pop_local}, @fref{ox_push_cmd ox_sync}
1.1       noro     1547: @end table
                   1548:
1.2       noro     1549: \JP @node ox_pops,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1550: \EG @node ox_pops,,, Functions for distributed computation
1.1       noro     1551: @subsection @code{ox_pops}
                   1552: @findex ox_pops
                   1553:
                   1554: @table @t
                   1555: @item ox_pops(@var{number}[,@var{nitem})
1.2       noro     1556: \JP :: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$N%9%?%C%/$+$i%G!<%?$r<h$j=|$/(B.
                   1557: \EG :: Removes data form the stack of a process whose identifier is @var{number}.
1.1       noro     1558: @end table
                   1559:
                   1560: @table @var
                   1561: @item return
                   1562: 0
                   1563: @item number
1.2       noro     1564: \JP $B?t(B ($B%W%m%;%9<1JL;R(B)
                   1565: \EG integer(process identifier)
1.1       noro     1566: @item nitem
1.2       noro     1567: \JP $B<+A3?t(B
                   1568: \EG non-negative integer
1.1       noro     1569: @end table
                   1570:
                   1571: @itemize @bullet
1.2       noro     1572: \BJP
                   1573: @item
                   1574: $B%W%m%;%9<1JL;R(B @var{number} $B$N%W%m%;%9$N%9%?%C%/$+$i%G!<%?$r<h$j=|$/(B.
1.1       noro     1575: @var{nitem} $B$,;XDj$5$l$F$$$k>l9g$O(B @var{nitem} $B8D(B, $B;XDj$N$J$$>l9g$O(B
                   1576: 1 $B8D<h$j=|$/(B.
1.2       noro     1577: \E
                   1578: \BEG
                   1579: @item
                   1580: Removes data form the stack of a process whose identifier is @var{number}.
                   1581: If @var{nitem} is specified, @var{nitem} items are removed.
                   1582: If @var{nitem} is not specified, 1 item is removed.
                   1583: \E
1.1       noro     1584: @end itemize
                   1585:
                   1586: @example
                   1587: [69] for(I=1;I<=10;I++)ox_push_cmo(0,I);
                   1588: [70] ox_pops(0,4);
                   1589: 0
                   1590: [71] ox_pop_cmo(0);
                   1591: 6
                   1592: @end example
                   1593:
                   1594: @table @t
1.2       noro     1595: \JP @item $B;2>H(B
                   1596: \EG @item References
                   1597: @fref{ox_pop_cmo ox_pop_local}
1.1       noro     1598: @end table
                   1599:
1.2       noro     1600: \JP @node ox_select,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1601: \EG @node ox_select,,, Functions for distributed computation
1.1       noro     1602: @subsection @code{ox_select}
                   1603: @findex ox_select
                   1604:
                   1605: @table @t
                   1606: @item ox_select(@var{nlist}[,@var{timeout}])
1.2       noro     1607: \JP :: $BFI$_=P$72DG=$J%W%m%;%9$N<1JL;R$rJV$9(B.
                   1608: \EG :: Returns the list of process identifiers on which data is available.
1.1       noro     1609: @end table
                   1610:
                   1611: @table @var
                   1612: @item return
1.2       noro     1613: \JP $B%j%9%H(B
                   1614: \EG list
1.1       noro     1615: @item nlist
1.2       noro     1616: \JP $B?t(B ($B;R%W%m%;%9<1JL;R(B) $B$N%j%9%H(B
                   1617: \EG list of integers (process identifier)
1.1       noro     1618: @item timeout
1.2       noro     1619: \JP $B?t(B
                   1620: \EG number
1.1       noro     1621: @end table
                   1622:
                   1623: @itemize @bullet
1.2       noro     1624: \BJP
1.1       noro     1625: @item
                   1626: $B<1JL;R%j%9%H(B @var{nlist} $B$N%W%m%;%9$N$&$A4{$K=PNO$rJV$7$F$$$k(B
                   1627: $B%W%m%;%9$N<1JL;R%j%9%H$rJV$9(B.
1.2       noro     1628:
1.1       noro     1629: @item
                   1630: $BA4$F$N%W%m%;%9$,(B RUN $B>uBV$N$H$-(B, $B$$$:$l$+$N%W%m%;%9$N=*N;$rBT$D(B.
                   1631: $BC"$7(B, @var{timeout} $B$,;XDj$5$l$F$$$k>l9g(B, @var{timeout} $BIC$@$1BT$D(B.
1.2       noro     1632:
1.1       noro     1633: @item
                   1634: @code{ox_push_cmd()} $B$G(B @code{SM_popCMO} $B$"$k$$$O(B
                   1635: @code{SM_popSerializedLocalObject} $B$rAw$C$F$*$-(B, @code{ox_select()} $B$G(B
                   1636: ready $B>uBV$N%W%m%;%9$rD4$Y$F(B@code{ox_get()} $B$9$k$3$H$G(B,
                   1637: @code{ox_pop_local()}, @code{ox_pop_cmo()}$B$GBT$A>uBV$KF~$k$N$rKI$0$3$H$,(B
                   1638: $B$G$-$k(B.
1.2       noro     1639: \E
                   1640: \BEG
                   1641: @item
                   1642: Returns the list of process identifiers on which data is available.
                   1643:
                   1644: @item
                   1645: If all the processes in @var{nlist} are running, it blocks until
                   1646: one of the processes returns data. If @var{timeout} is specified,
                   1647: it waits for only @var{timeout} seconds.
                   1648:
                   1649: @item
                   1650: By sending @code{SM_popCMO} or @code{SM_popSerializedLocalObject} with
                   1651: @code{ox_push_cmd()} in advance and by examining the process status with
                   1652: @code{ox_select()}, one can avoid a hanging up caused by @code{ox_pop_local()}
                   1653: or @code{ox_pop_cmo()}. In such a case, data can be received by
                   1654: @code{ox_get()}.
                   1655: \E
1.1       noro     1656: @end itemize
                   1657:
                   1658: @example
                   1659: ox_launch();
                   1660: 0
                   1661: [220] ox_launch();
                   1662: 1
                   1663: [221] ox_launch();
                   1664: 2
                   1665: [222] ox_rpc(2,"fctr",x^500-y^500);
                   1666: 0
                   1667: [223] ox_rpc(1,"fctr",x^100-y^100);
                   1668: 0
                   1669: [224] ox_rpc(0,"fctr",x^10-y^10);
                   1670: 0
                   1671: [225] P=[0,1,2];
                   1672: [0,1,2]
                   1673: [226] map(ox_push_cmd,P,258);
                   1674: [0,0,0]
                   1675: [227] ox_select(P);
                   1676: [0]
                   1677: [228] ox_get(0);
                   1678: [[1,1],[x^4+y*x^3+y^2*x^2+y^3*x+y^4,1],
                   1679: [x^4-y*x^3+y^2*x^2-y^3*x+y^4,1],[x-y,1],[x+y,1]]
                   1680: @end example
                   1681:
                   1682: @table @t
1.2       noro     1683: \JP @item $B;2>H(B
                   1684: \EG @item References
                   1685: @fref{ox_pop_cmo ox_pop_local}, @fref{ox_push_cmd ox_sync}, @fref{ox_get}
1.1       noro     1686: @end table
                   1687:
1.2       noro     1688: \JP @node ox_flush ,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1689: \EG @node ox_flush ,,, Functions for distributed computation
1.1       noro     1690: @subsection @code{ox_flush}
                   1691: @findex ox_flush
                   1692:
                   1693: @table @t
                   1694: @item ox_flush(@var{id})
1.2       noro     1695: \JP :: $BAw?.%P%C%U%!$N6/@)(B flush
                   1696: \EG :: Flushes the sending buffer.
1.1       noro     1697: @end table
                   1698:
                   1699: @table @var
                   1700: @item return
                   1701: 1
                   1702: @item id
1.2       noro     1703: \JP $B;R%W%m%;%9<1JL;R(B
                   1704: \EG process identifier
1.1       noro     1705: @end table
                   1706:
                   1707: @itemize @bullet
1.2       noro     1708: \BJP
1.1       noro     1709: @item $BDL>o$O%P%C%A%b!<%I$O(B off $B$G$"$j(B, $B%G!<%?(B, $B%3%^%s%IAw?.$4$H$K(B
                   1710: $BAw?.%P%C%U%!$O(B flush $B$5$l$k(B.
1.2       noro     1711:
1.1       noro     1712: @item $B%P%C%A%b!<%I$O(B @code{"ctrl"} $B%3%^%s%I$N(B @code{"ox_batch"} $B%9%$%C%A(B
                   1713: $B$G(B on/off $B$G$-$k(B.
1.2       noro     1714:
1.1       noro     1715: @item $B:Y$+$$%G!<%?$rB??tAw$k>l9g$K(B, @code{ctrl("ox_batch",1)}
                   1716: $B$G%P%C%A%b!<%I$r(B on $B$K$9$k$H(B, $B%P%C%U%!$,$$$C$Q$$$K$J$C$?>l9g$K$N$_(B flush
                   1717: $B$5$l$k$?$a(B, overhead $B$,>.$5$/$J$k>l9g$,$"$k(B. $B$?$@$7$3$N>l9g$K$O(B, $B:G8e$K(B
                   1718: @code{ox_flush(@var{id})} $B$r<B9T$7$F(B, $B%P%C%U%!$r6/@)E*$K(B flush $B$9$kI,MW$,(B
                   1719: $B$"$k(B.
1.2       noro     1720:
1.1       noro     1721: @item @code{ox_pop_cmo}, @code{ox_pop_local} $B$N$h$&$K(B, $B%3%^%s%IAw?.8e(B
                   1722: $B$?$@$A$K%G!<%?BT$A$KF~$k4X?t$,%O%s%0$7$J$$$h$&(B, $B$3$l$i$N4X?t$NFbIt$G$O(B
                   1723: $B6/@)(B flush $B$,<B9T$5$l$F$$$k(B.
1.2       noro     1724: \E
                   1725:
                   1726: \BEG
                   1727: @item
                   1728: By default the batch mode is off and the sending buffer is flushed
                   1729: at every sending operation of data and command.
                   1730:
                   1731: @item
                   1732: The batch mode is set by @code{"ox_batch"} switch of @code{"ctrl"}.
                   1733:
                   1734: @item
                   1735: If one wants to send many pieces of small data,
                   1736: @code{ctrl("ox_batch",1)} may decrease the overhead of flush operations.
                   1737: Of course, one has to call @code{ox_flush(@var{id})} at the end of
                   1738: the sending operations.
                   1739:
                   1740: @item
                   1741: Functions such as @code{ox_pop_cmo} and @code{ox_pop_local}
                   1742: enter a waiting mode immediately after sending a command.
                   1743: These functions always flush the sending buffer.
                   1744: \E
1.1       noro     1745: @end itemize
                   1746:
                   1747: @example
                   1748: [340] ox_launch_nox();
                   1749: 0
                   1750: [341] cputime(1);
                   1751: 0
                   1752: 7e-05sec + gc : 4.8e-05sec(0.000119sec)
                   1753: [342] for(I=0;I<10000;I++)ox_push_cmo(0,I);
                   1754: 0.232sec + gc : 0.006821sec(0.6878sec)
                   1755: [343] ctrl("ox_batch",1);
                   1756: 1
                   1757: 4.5e-05sec(3.302e-05sec)
                   1758: [344] for(I=0;I<10000;I++)ox_push_cmo(0,I); ox_flush(0);
                   1759: 0.08063sec + gc : 0.06388sec(0.4408sec)
                   1760: [345] 1
                   1761: 9.6e-05sec(0.01317sec)
                   1762: @end example
                   1763:
                   1764: @table @t
1.2       noro     1765: \JP @item $B;2>H(B
                   1766: \EG @item References
                   1767: @fref{ox_pop_cmo ox_pop_local}, @fref{ctrl}
1.1       noro     1768: @end table
                   1769:
1.2       noro     1770: \JP @node ox_get_serverinfo ,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1771: \EG @node ox_get_serverinfo ,,, Functions for distributed computation
1.1       noro     1772: @subsection @code{ox_get_serverinfo}
                   1773: @findex ox_get_serverinfo
                   1774:
                   1775: @table @t
                   1776: @item ox_get_serverinfo([@var{id}])
1.2       noro     1777: \JP :: server $B$N(B Mathcap, $BF0:nCf$N%W%m%;%9<1JL;R$N<hF@(B
                   1778: \EG :: Gets server's mathcap and proess id.
1.1       noro     1779: @end table
                   1780:
                   1781: @table @var
                   1782: @item return
1.2       noro     1783: \JP $B%j%9%H(B
                   1784: \EG list
1.1       noro     1785: @item id
1.2       noro     1786: \JP $B;R%W%m%;%9<1JL;R(B
                   1787: \EG process identifier
1.1       noro     1788: @end table
                   1789:
                   1790: @itemize @bullet
1.2       noro     1791: \BJP
1.1       noro     1792: @item $B0z?t(B @var{id} $B$,$"$k$H$-(B, $B%W%m%;%9<1JL;R(B @var{id} $B$N%W%m%;%9$N(B
                   1793: Mathcap $B$r%j%9%H$H$7$FJV$9(B.
                   1794: @item $B0z?t$J$7$N$H$-(B, $B8=:_F0:nCf$N%W%m%;%9<1JL;R$*$h$S$=$N(B Mathcap $B$+$i(B
                   1795: $B$J$k%Z%"$r(B, $B%j%9%H$H$7$FJV$9(B.
1.2       noro     1796: \E
                   1797: \BEG
                   1798: @item If @var{id} is specified, the mathcap of the process whose
                   1799: identifier is @var{id} is returned.
                   1800: @item If @var{id} is not specified, the list of @var{[id,Mathcap]}
                   1801: is returned, where @var{id} is the identifier of a currently active process,
                   1802: and @var{Mathcap} is the mathcap of the process.
                   1803: identifier @var{id} is returned.
                   1804: \E
1.1       noro     1805: @end itemize
                   1806:
                   1807: @example
                   1808: [343] ox_get_serverinfo(0);
                   1809: [[199909080,Ox_system=ox_sm1.plain,Version=2.991118,HOSTTYPE=FreeBSD],
                   1810: [262,263,264,265,266,268,269,272,273,275,276],
                   1811: [[514],[2130706434,1,2,4,5,17,19,20,22,23,24,25,26,30,31,60,61,27,33,40,16,34]]]
                   1812: [344] ox_get_serverinfo();
                   1813: [[0,[[199909080,Ox_system=ox_sm1.plain,Version=2.991118,HOSTTYPE=FreeBSD],
                   1814: [262,263,264,265,266,268,269,272,273,275,276],
                   1815: [[514],[2130706434,1,2,4,5,17,19,20,22,23,24,25,26,30,31,60,61,27,33,40,16,34]]]],
                   1816: [1,[[199901160,ox_asir],
                   1817: [276,275,258,262,263,266,267,268,274,269,272,265,264,273,300,270,271],
                   1818: [[514,2144202544],
                   1819: [1,2,3,4,5,2130706433,2130706434,17,19,20,21,22,24,25,26,31,27,33,60],[0,1]]]]]
                   1820: @end example
                   1821:
                   1822: @table @t
1.2       noro     1823: \JP @item $B;2>H(B
                   1824: \EG @item References
                   1825: @fref{Mathcap}.
1.1       noro     1826: @end table
                   1827:
1.2       noro     1828: \JP @node ifplot conplot plot plotover,,, $BJ,;67W;;$K4X$9$k4X?t(B
                   1829: \EG @node ifplot conplot plot plotover,,, Functions for distributed computation
1.1       noro     1830: @subsection @code{ifplot}, @code{conplot}, @code{plot}, @code{plotover}
                   1831: @findex ifplot
                   1832: @findex conplot
                   1833: @findex plot
                   1834: @findex plotover
                   1835:
                   1836: @table @t
                   1837: @item ifplot(@var{func} [,@var{geometry}] [,@var{xrange}] [,@var{yrange}] [,@var{id}] [,@var{name}])
1.2       noro     1838: \JP :: 2 $BJQ?t4X?t$N<B?t>e$G$NNmE@$rI=<($9$k(B.
                   1839: \EG :: Displays real zeros of a bi-variate function.
1.1       noro     1840: @item conplot(@var{func} [,@var{geometry}] [,@var{xrange}] [,@var{yrange}] [,@var{zrange}] [,@var{id}] [,@var{name}])
1.2       noro     1841: \JP :: 2 $BJQ?t4X?t$N<B?t>e$G$NEy9b@~$rI=<($9$k(B.
                   1842: \EG :: Displays real contour lines of a bi-variate function.
1.1       noro     1843: @item plot(@var{func} [,@var{geometry}] [,@var{xrange}] [,@var{id}] [,@var{name}])
1.2       noro     1844: \JP :: 1 $BJQ?t4X?t$N%0%i%U$rI=<($9$k(B.
                   1845: \EG :: Displays the graph of a univariate function.
1.1       noro     1846: @item plotover(@var{func},@var{id},@var{number})
1.2       noro     1847: \JP :: $B$9$G$KB8:_$7$F$$$k%&%#%s%I%&$XIA2h$9$k(B.
                   1848: \EG Plots on the existing window real zeros of a bivariate function.
1.1       noro     1849: @end table
                   1850:
                   1851: @table @var
                   1852: @item return
1.2       noro     1853: \JP $B@0?t(B
                   1854: \EG integer
1.1       noro     1855: @item func
1.2       noro     1856: \JP $BB?9`<0(B
                   1857: \EG polynomial
1.1       noro     1858: @item geometry, xrange, yrange, zrange
1.2       noro     1859: \JP $B%j%9%H(B
                   1860: \EG list
1.1       noro     1861: @item id, number
1.2       noro     1862: \JP $B@0?t(B
                   1863: \EG integer
1.1       noro     1864: @item name
1.2       noro     1865: \JP $BJ8;zNs(B
                   1866: \EG string
1.1       noro     1867: @end table
                   1868:
                   1869: @itemize @bullet
1.2       noro     1870: \BJP
1.1       noro     1871: @item
                   1872: @code{ifplot()} $B$O(B, 2 $BJQ?t4X?t(B @var{func} $B$N<B?t>e$G$NNmE@$N(B
                   1873: $B%0%i%U$NI=<($r9T$&(B. @code{conplot()} $B$O(B, $BF1MM$N0z?t$KBP$7(B,
                   1874: $BEy9b@~$NI=<($r9T$&(B. @code{plot()} $B$O(B 1 $BJQ?t4X?t$N(B
                   1875: $B%0%i%U$NI=<($r9T$&(B. Windows $BHG$O8=>u$G$OL$%5%]!<%H$G$"$k(B.
1.2       noro     1876:
1.1       noro     1877: @item
                   1878: UNIX $BHG$O(B, $B1s3V%W%m%;%9$K$h$j<B8=$5$l$F$$$k(B. $B%3%^%s%I$O(B @samp{ox_plot}
                   1879: $B$G(B, @code{ox_launch()} $B$K$h$j5/F0$7$F$*$/I,MW$,$"$k(B. @samp{ox_plot}
                   1880: $B$O(B, @b{Asir} $B$NI8=`%i%$%V%i%j%G%#%l%/%H%j$K$"$k(B.
1.2       noro     1881:
1.1       noro     1882: @item
                   1883: $B0z?t$NFb(B, @var{func} $B$OI,?\$G$"$k(B. $B$=$NB>$N0z?t$O%*%W%7%g%s$G$"$k(B.
                   1884: $B%*%W%7%g%s$N7A<0$*$h$S$=$N%G%U%)%k%HCM(B ($B%+%C%3Fb(B) $B$O<!$NDL$j(B.
1.2       noro     1885:
1.1       noro     1886: @table @var
                   1887: @item geometry
                   1888: $B%&%#%s%I%&$N%5%$%:$r%I%C%HC10L$G(B @var{[x,y]} $B$G;XDj$9$k(B.
                   1889: (UNIX $BHG$G$O(B @var{[}@code{300},@code{300}@var{]}. )
1.2       noro     1890:
1.1       noro     1891: @item xrange, yrange
                   1892: $BJQ?t$NHO0O$N;XDj$G(B, @var{[v,vmin,vmax]} $B$G;XDj$9$k(B.
                   1893: ($B$$$:$l$NJQ?t$b(B @var{[v},@code{-2},@code{2}@var{]}.)
                   1894: $B$3$N;XDj$,$J$$>l9g(B, @var{func} $B$K4^$^$l$kJQ?t$NFbJQ?t=g=x$N>e$NJQ?t(B
                   1895: $B$,(B @samp{x}, $B2<$NJQ?t$,(B @samp{y} $B$H$7$F07$o$l$k(B. $B$3$l$rHr$1$k$?$a$K$O(B
                   1896: @var{xrange}, @var{yrange} $B$r;XDj$9$k(B. $B$^$?(B, @var{func} $B$,(B 1 $BJQ?t$N(B
                   1897: $B>l9g(B, $B$3$l$i$N;XDj$OI,?\$H$J$k(B.
1.2       noro     1898:
1.1       noro     1899: @item zrange
                   1900: @code{conplot()} $B$N>l9g$N$_;XDj$G$-$k(B. $B7A<0$O(B
                   1901: @var{[v,vmin,vmax} @code{[},@var{step} @code{]}@var{]} $B$G(B, @var{step} $B$,;XDj$5$l(B
                   1902: $B$?>l9g$K$O(B, $BEy9b@~$N4V3V$,(B @var{(vmax-vmin)/step} $B$H$J$k(B.
                   1903: (@var{[z},@code{-2},@code{2},@code{16}@var{]}.)
1.2       noro     1904:
1.1       noro     1905: @item id
                   1906: $B1s3V%W%m%;%9$NHV9f(B, $B$9$J$o$A(B @code{ox_launch()} $B$,JV$7$?HV9f$r;XDj$9$k(B.
                   1907: ($B0lHV:G6a$K:n$i$l(B, $B$+$D%"%/%F%#%V$J%W%m%;%9$KBP1~$9$kHV9f(B.)
1.2       noro     1908:
1.1       noro     1909: @item name
                   1910: $B%&%#%s%I%&$NL>A0(B. (@code{Plot}.)
                   1911: $B@8@.$5$l$?%&%#%s%I%&$N%?%$%H%k$O(B @var{name:n/m} $B$H$J$k(B.
                   1912: $B$3$l$O(B, $B%W%m%;%9HV9f(B @var{n} $B$N%W%m%;%9$N(B, @var{m} $BHV$N%&%#%s%I%&$r0UL#$9$k(B.
                   1913: $B$3$NHV9f$O(B, @code{plotover()} $B$GMQ$$$i$l$k(B.
                   1914: @end table
1.2       noro     1915:
1.1       noro     1916: @item
                   1917: $B0l$D$N%W%m%;%9>e$GIA2h$G$-$k%&%#%s%I%&$N?t$O:GBg(B 128 $B8D$G$"$k(B.
1.2       noro     1918:
1.1       noro     1919: @item
                   1920: @code{plotover()} $B$O(B, $B;XDj$7$?%&%#%s%I%&>e$K(B, $B0z?t$G$"$k(B 2 $BJQ?tB?9`<0$N(B
                   1921: $BNmE@$r>e=q$-$9$k(B.
                   1922:
                   1923: @item
                   1924: $BIA2h=*N;8e$N%&%#%s%I%&>e$G(B, $B%^%&%9$N:8%\%?%s$r2!$7$J$,$i$N%I%i%C%0(B
                   1925: $B$GHO0O$r;XDj$7%\%?%s$rN%$9$H?7$?$J%&%#%s%I%&$,@8@.$5$l(B, $B;XDj$7$?(B
                   1926: $BHO0O$,3HBg$7$FI=<($5$l$k(B. $B%I%i%C%0$O:8>e$+$i1&2<$X$H9T$&(B.
                   1927: $B%I%i%C%0$r;O$a$?8e%-%c%s%;%k$9$k>l9g$O(B, $B%^%&%9%]%$%s%?$r;OE@$N>e$+(B
                   1928: $B:8$K;}$C$F$$$C$F%\%?%s$rN%$;$P$h$$(B. $B?7$7$$%&%$%s%I%&$N7A$O(B, $B;XDj(B
                   1929: $BNN0h$HAj;w$G(B, $B:GBgJU$,(B, $B85$N%&%#%s%I%&$N:GBgJU$H0lCW$9$k$h$&$K(B
                   1930: $BDj$a$i$l$k(B. $B0J2<$G@bL@$9$k(B @code{precise} $B$,(B on $B$N>l9g(B,
                   1931: $BA*Br$7$?NN0h$,F10l(B window $B>e$G=q$-D>$5$l$k(B.
                   1932:
                   1933: @item
                   1934: $B%&%#%s%I%&Fb$G1&%\%?%s$r2!$9$H(B, $B$=$NE@$N:BI8$,%&%#%s%I%&$N2<It$KI=<($5$l$k(B.
                   1935:
                   1936: @item
                   1937: @code{conplot()} $B$G@8@.$7$?%&%#%s%I%&$K$*$$$F(B, $B%&%#%s%I%&$N1&B&$N%^!<%+$r(B
                   1938: $BCf%\%?%s$G%I%i%C%0$9$k$H(B, $BBP1~$9$kEy9b@~$N?'$,JQ$o$j(B, $B1&>e$N(B
                   1939: $B%&%#%s%I%&$KBP1~$9$k%l%Y%k$,I=<($5$l$k(B.
                   1940:
                   1941: @item
1.2       noro     1942: UNIX $BHG$G$O$$$/$D$+$N%\%?%s$K$h$j(B
1.1       noro     1943: $B$$$/$D$+$N@_DjJQ99(B, $BA`:n$,$G$-$k(B. UNIX $BHG$G$O<!$N%\%?%s$,$"$k(B.
                   1944:
                   1945: @table @code
                   1946: @item quit
                   1947: window $B$rGK2u$9$k(B. $B7W;;$rCfCG$9$k>l9g(B, @code{ox_reset()} $B$rMQ$$$k(B.
1.2       noro     1948:
1.1       noro     1949: @item wide ($B%H%0%k(B)
                   1950: $B8=:_$NI=<(ItJ,$r=D2#3F(B 10 $BG\$7$?NN0h$rI=<($9$k(B. $B8=:_I=<($5$l$F$$$kHO0O$O(B
                   1951: $B$3$NI=<($K$*$$$FCf1{It$KD9J}7A$G<($5$l$k(B. $B$3$NI=<($GHO0O;XDj$r9T$&$H(B,
                   1952: $B$=$NHO0O$,?7$7$$%&%#%s%I%&$KIA2h$5$l$k(B.
1.2       noro     1953:
1.1       noro     1954: @item precise ($B%H%0%k(B)
                   1955: $BA*BrNN0h$r(B, $B@0?t1i;;$K$h$j(B, $B$h$j@53N$K:FIA2h$9$k(B. $B$3$l$O(B, @var{func} $B$,(B
                   1956: $BM-M}?t78?t$N(B 2 $BJQ?tB?9`<0$N>l9g$K$N$_M-8z$G$"$k(B. $B$3$N%b!<%I$G$O(B Sturm $BNs(B
                   1957: $B$HFsJ,K!$K$h$j(B, $B6h4VFb$NNmE@$N8D?t$r@53N$K5a$a$F$$$/$b$N$G(B, $B%G%U%)%k%H$N(B
                   1958: $B7W;;K!$h$j$b@53N$JIA2h$,4|BT$G$-$k(B. $B$?$@$7(B, $BIA2h;~4V$OM>7W$K$+$+$k>l9g$,(B
                   1959: $BB?$$(B. $B$3$N@bL@$+$iL@$i$+$J$h$&$K(B, $B$3$N5!G=$OM-M}?t78?t$NB?9`<0$NIA2h$KBP(B
                   1960: $B$7$F$N$_M-8z$G$"$k(B. ((x^2+y^2-1)^2 $B$NIA2h$G;n$7$F$_$h(B.)
                   1961:
                   1962: @item formula
                   1963: $BBP1~$9$k<0$rI=<($9$k(B.
1.2       noro     1964:
1.1       noro     1965: @item noaxis ($B%H%0%k(B)
                   1966: $B:BI8<4$r>C$9(B.
                   1967: @end table
                   1968:
                   1969: @item
                   1970: @samp{ox_plot} $B$,5/F0$5$l$k%^%7%s$K$h$C$F$O(B, $B%9%?%C%/$rBgNL$K;HMQ$9$k(B
                   1971: $B$b$N$b$"$k$?$a(B, @samp{.cshrc} $B$G%9%?%C%/%5%$%:$rBg$-$a(B (16MB $BDxEY(B) $B$K(B
                   1972: $B;XDj$7$F$*$/$N$,0BA4$G$"$k(B. $B%9%?%C%/%5%$%:$O(B @code{limit stacksize 16m}
                   1973: $B$J$I$H;XDj$9$k(B.
                   1974:
                   1975: @item
                   1976: @code{X} $B$G$O!"%&%$%s%I%&$N3FItJ,$K$D$$$F(B resource $B$K$h$j(B
                   1977: $B?'IU$1$d!"%\%?%s$N7A$rJQ$($k$3$H$,$G$-$k!#(B
                   1978: resource $B$N;XDj$N;EJ}$O0J2<$NDL$j!#!J%G%U%)%k%H$r<($7$F$*$/!K(B
                   1979: @code{plot*form*shapeStyle} $B$O!"(B@t{rectangle, oval, ellipse, roundedRectangle}
                   1980: $B$,!";XDj$G$-$k!#(B
1.2       noro     1981: \E
                   1982: \BEG
                   1983: @item
                   1984: Function @code{ifplot()} draws a graph of real zeros of a bi-variate
                   1985: function.
                   1986: Function @code{conplot()} plots the contour lines for a same argument.
                   1987: Function @code{plot()} draws the graph of a uninivariate function.
                   1988: These functions are available on UNIX version (on @code{X11}).
                   1989:
                   1990: @item
                   1991: The plotting functions for UNIX version are realized on remote process
                   1992: facilities described previously.
                   1993: The command for this is  @samp{ox_plot} in @b{Asir} root directory.
                   1994: Of course, it must be activated by @code{ox_launch()}.
                   1995:
                   1996: @item
                   1997: Argument @var{func} is indispensable. Other arguments are optional.
                   1998: The format of optional arguments and their default values (parenthesized)
                   1999: are listed below.
                   2000:
                   2001: @table @var
                   2002: @item geometry
                   2003: Window size is specified by @var{[x,y]} in unit `dot.'
                   2004: (@var{[}@code{300},@code{300}@var{]} for UNIX version;
                   2005:
                   2006: @item xrange, yrange
                   2007: Value ranges of the variables are specified by @var{[v,vmin,vmax]}.
                   2008: (@var{[v},@code{-2},@code{2}@var{]} for each variable.)
                   2009: If this specification is omitted, the indeterminate having the higher
                   2010: order in @var{func} is taken for @samp{x} and the one with lower order
                   2011: is taken for @samp{y}.  To change this selection, specify explicitly
                   2012: by @var{xrange} and/or @var{yrange}.
                   2013: For an uni-variate function, the specification is mandatory.
                   2014:
                   2015: @item zrange
                   2016: This specification applies only to @code{conplot()}.  The format is
                   2017: @var{[v,vmin,vmax} @code{[},@var{step} @code{]}@var{]}.
                   2018: If @var{step} is specified, the height difference of contours is set to
                   2019: @var{(vmax-vmin)/step}.
                   2020: (@var{[z},@code{-2},@code{2},@code{16}@var{]}.)
                   2021:
                   2022: @item id
                   2023: This specifies the number of the remote process by which you wish
                   2024: to draw a graph.
                   2025: (The number for the newest active process.)
                   2026:
                   2027: @item name
                   2028: The name of the window.
                   2029: (@code{Plot}.)
                   2030: The created window is titled @var{name:n/m} which means the @var{m}-th
                   2031: window of the process with process number @var{n}.
                   2032: These numbers are used for @code{plotover()}.
                   2033: @end table
                   2034:
                   2035: @item
                   2036: The maximum number of the windows that can be created on a process is
                   2037: 128.
                   2038:
                   2039: @item
                   2040: Function @code{plotover()} superposes reals zeros of its argument
                   2041: bi-variate function onto the specified window.
                   2042:
                   2043: @item
                   2044: Enlarged plot can be obtained for rectangular area which is specified,
                   2045: on an already existing window with a graph,
                   2046: by dragging cursor with the left button of mouse
                   2047: from the upper-left corner to lower-right corner
                   2048: and then releasing it.
                   2049: Then, a new window is created whose shape is similar to the specified
                   2050: area and whose size is determined so that the largest
                   2051: side of the new window has the same size of the largest side of
                   2052: the original window.
                   2053: If you wish to cancel the action, drag the cursor to any point
                   2054: above or left of the starting point.
                   2055:
                   2056: This facility is effective when @code{precise} button switch is
                   2057: inactive.  If @code{precise} is selected and active, the area specified
                   2058: by the cursor dragging will be rewritten on the same window. This
                   2059: will be explained later.
                   2060: @item
                   2061: A click of the right button will display the current coordinates of
                   2062: the cursor at the bottom area of the window.
                   2063:
                   2064: @item
                   2065: Place the cursor at any point in the right marker area on
                   2066: a window created by @code{conplot()},
                   2067: and drag the cursor with the middle mutton.  Then you will find the contour lines changing
                   2068: their colors depending on the movement of the cursor and the
                   2069: corresponding height level displayed on the upper right corner of
                   2070: the window.
                   2071:
                   2072: @item
                   2073: Several operations are available on the window: by button operations
                   2074: for UNIX version, and pull-down menus for Macintosh version.
                   2075:
                   2076: @table @code
                   2077: @item quit
                   2078: Destroys (kills) the window.  While computing, quit the current
                   2079: computation.
                   2080: If one wants to interrupt the computation, use @code{ox_reset()}.
                   2081:
                   2082: @item wide (toggle)
                   2083: Will display, on the same window, a new area enlarged by 10 times
                   2084: as large as the current area for both width-direction and
                   2085: height-direction.  The current area will be indicated by a rectangle
                   2086: placed at the center.  Area specification by dragging the cursor will
                   2087: create a new window with a plot of the graph in the specified area.
                   2088: @item precise (toggle)
                   2089: When selected and active,
                   2090: @code{ox_plot} redraws the specified area more precisely by integer
                   2091: arithmetic.
                   2092: This mode uses bisection method based on Sturm sequence computation to
                   2093: locate real zeros precisely.  More precise plotting can be expected
                   2094: by this technique than by the default plotting technique, at the expense
                   2095: of significant increase of computing time.  As you see by above
                   2096: explanation, this function is only effective to polynomials with
                   2097: rational coefficients.
                   2098: (Check how they differ for (x^2+y^2-1)^2.)
                   2099:
                   2100: @item formula
                   2101: Displays the expression for the graph.
                   2102:
                   2103: @item noaxis (toggle)
                   2104: Erase the coordinates.
                   2105: @end table
                   2106:
                   2107: @item
                   2108: Program @samp{ox_plot} may consume much stack space depending on
                   2109: which machine it is running.
                   2110: You are recommended to set the stack size to about 16MB as large
                   2111: in @samp{.cshrc} for safe.
                   2112: To specify the size, put @code{limit stacksize 16m} for an example.
                   2113:
                   2114: @item
                   2115: You can customize various resources of a window on @code{X}, e.g.,
                   2116: coloring, shape of buttons etc.
                   2117: The default setting of resources is shown below.
                   2118: For @code{plot*form*shapeStyle} you can select among
                   2119: @t{rectangle}, @t{oval}, @t{ellipse}, and @t{roundedRectangle}.
                   2120: \E
                   2121:
1.1       noro     2122: @example
                   2123: plot*background:white
                   2124: plot*form*shapeStyle:rectangle
                   2125: plot*form*background:white
                   2126: plot*form*quit*background:white
                   2127: plot*form*wide*background:white
                   2128: plot*form*precise*background:white
                   2129: plot*form*formula*background:white
                   2130: plot*form*noaxis*background:white
                   2131: plot*form*xcoord*background:white
                   2132: plot*form*ycoord*background:white
                   2133: plot*form*level*background:white
                   2134: plot*form*xdone*background:white
                   2135: plot*form*ydone*background:white
                   2136: @end example
                   2137: @end itemize
                   2138:
                   2139: @example
                   2140: @end example
                   2141:
                   2142: @table @t
1.2       noro     2143: \JP @item $B;2>H(B
                   2144: \EG @item References
                   2145: @fref{ox_launch ox_launch_nox ox_shutdown}, @fref{ox_reset register_handler}
1.1       noro     2146: @end table

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>