Return to misc.texi CVS log

Up to [local] / OpenXM / src / asir-doc / parts / builtin

Annotation of OpenXM/src/asir-doc/parts/builtin/misc.texi, Revision 1.16

1.16    ! ohara       1: @comment $OpenXM: OpenXM/src/asir-doc/parts/builtin/misc.texi,v 1.15 2003/10/21 05:16:35 takayama Exp $
1.3       noro        2: \BJP
1.1       noro        3: @node $B$=$NB>(B,,, $BAH$_9~$_H!?t(B
                      4: @section $B$=$NB>(B
1.3       noro        5: \E
                      6: \BEG
                      7: @node Miscellaneouses,,, Built-in Function
                      8: @section Miscellaneouses
                      9: \E
1.1       noro       10:
                     11: @menu
                     12: * ctrl::
                     13: * debug::
                     14: * error::
                     15: * help::
                     16: * time::
                     17: * cputime tstart tstop::
1.8       noro       18: * timer::
1.1       noro       19: * heap::
                     20: * version::
                     21: * shell::
                     22: * map::
                     23: * flist::
                     24: * delete_history::
                     25: * get_rootdir::
1.2       noro       26: * getopt::
1.3       noro       27: * getenv::
1.1       noro       28: @end menu
                     29:
1.3       noro       30: \JP @node ctrl,,, $B$=$NB>(B
                     31: \EG @node ctrl,,, Miscellaneouses
1.1       noro       32: @subsection @code{ctrl}
                     33: @findex ctrl
                     34:
                     35: @table @t
                     36: @item ctrl("@var{switch}"[,@var{obj}])
1.3       noro       37: \JP :: $B4D6-@_Dj(B
                     38: \EG :: Sets the value of @var{switch}.
1.1       noro       39: @end table
                     40:
                     41: @table @var
                     42: @item return
1.3       noro       43: \JP $B@_Dj$5$l$F$$$kCM(B
                     44: \EG value of @var{switch}
1.1       noro       45: @item switch
1.3       noro       46: \JP $B%9%$%C%AL>(B
                     47: \EG switch name
1.1       noro       48: @item obj
1.3       noro       49: \JP $B%Q%i%a%?(B
                     50: \EG parameter
1.1       noro       51: @end table
                     52:
                     53: @itemize @bullet
1.3       noro       54: \BJP
1.1       noro       55: @item
                     56: @b{Asir} $B$N<B9T4D6-$N@_DjJQ99(B, $B;2>H$r9T$&(B.
                     57: @item @var{switch} $B$N$_$N>l9g(B, $B$=$N%9%$%C%A$N8=:_$N>uBV$rJV$9(B.
                     58: @item @var{obj} $B$,M?$($i$l$F$$$k$H$-(B, $B$=$NCM$r@_Dj$9$k(B.
                     59: @item
                     60: $B%9%$%C%A$OJ8;zNs$H$7$FF~NO$9$k(B. $B$9$J$o$A%@%V%k%/%)!<%H$G0O$`(B.
                     61: @item
1.3       noro       62: $B%9%$%C%A$O<!$NDL$j(B. $B0J2<$G(B, on $B$O(B 1, off $B$O(B 0 $B$r0UL#$9$k(B.
1.1       noro       63: @table @code
                     64: @item cputime
                     65: on $B$N;~(B CPU time $B$*$h$S(B GC time $B$rI=<((B, off $B$N;~(B $BI=<($7$J$$(B. @code{cputime()}
                     66: $B$r;2>H(B.
                     67: @code{ctrl("cputime",@var{onoff})} $B$O(B @code{cputime(@var{onoff})} $B$HF1$8$G$"$k(B.
                     68: @item nez
                     69: EZGCD $B$N%"%k%4%j%:%`$N@ZBX$((B. $B%G%U%)%k%H$G(B 1 $B$G$"$j(B, $B$H$/$K@ZBX$($kI,MW(B
                     70: $B$O$J$$(B.
                     71: @item echo
                     72: on $B$N;~$OI8=`F~NO$r7+$jJV$7$F=PNO$7(B, off $B$N;~$OI8=`F~NO$r7+$jJV$5$J$$(B.
                     73: @code{output} $B%3%^%s%I$rMQ$$$k:]$KM-8z$G$"$k(B.
                     74: @item bigfloat
                     75: on $B$N;~(B, $BF~NO$5$l$?IbF0>.?t$O(B @b{bigfloat} $B$KJQ49$5$l(B, $BIbF0>.?t1i;;$O(B
1.10      noro       76: @b{PARI} (@ref{pari}) $B$K$h$j9T$o$l$k(B. $B%G%U%)%k%H$NM-8z7e?t$O(B 9 $B7e$G$"$k(B.
1.1       noro       77: $BM-8z7e?t$rA}$d$7$?$$;~$K$O(B @code{setprec()} $B$rMQ$$$k(B.
                     78: off $B$N;~(B, $BF~NO$5$l$?IbF0>.?t$O(B, $BG\@:EYIbF0>.?t$KJQ49$5$l$k(B.
                     79: @cindex PARI
                     80: @item adj
                     81: $B%,!<%Y%C%8%3%l%/%7%g%s$NIQEY$NJQ99(B. 1 $B0J>e$NM-M}?t$,;XDj$G$-$k(B.
                     82: $B%G%U%)%k%HCM$O(B 3. 1 $B$K6a$$Dx(B, $B%,!<%Y%C%8%3%l%/%7%g%s$;$:$K%R!<%W$r(B
                     83: $BBg$-$/$H$k$h$&$K$J$k(B. $B@0?tCM$O%3%^%s%I%i%$%s$G;XDj$G$-$k(B.
                     84: @xref{$B%3%^%s%I%i%$%s%*%W%7%g%s(B}.
                     85: @item verbose
                     86: on $B$N;~(B, $BH!?t$N:FDj5A;~$K%a%C%;!<%8$rI=<($9$k(B.
1.14      ohara      87: @item quiet_mode
1.15      takayama   88: 1 $B$N$H$-(B, $B5/F0;~$KCx:n8"I=<($r9T$o$J$$(B.
                     89: @xref{$B%3%^%s%I%i%$%s%*%W%7%g%s(B}.
                     90: @item prompt
                     91: 0 $B$N$H$-%W%m%s%W%H$rI=<($7$J$$(B. 1 $B$N$H$-I8=`%W%m%s%W%H$rI=<((B.
                     92: C $B%9%?%$%k$N%U%)%^%C%HJ8;zNs$r$b$A$$$k$H%f!<%6Dj5A$N%W%m%s%W%H(B.
                     93: $BNc(B(asirgui $B$G$OIT2D(B):
1.16    ! ohara      94: @code{ ctrl("prompt","\033[32m[%d]:= \033[0m")}
1.1       noro       95: @item hex
                     96: 1 $B$N$H$-(B, $B@0?t$O(B 0x $B$G;O$^$k(B 16 $B?J?t$H$7$FI=<($5$l$k(B. -1 $B$N$H$-(B, 16 $B?J?t$O(B,
                     97: $B4V$K(B @samp{|} $B$r$O$5$s$G(B 8 $B7e$4$H$K6h@Z$C$FI=<($5$l$k(B.
1.13      noro       98: @item real_digit
                     99: $BG\@:EYIbF0>.?t$NI=<($N7e?t$r;XDj$9$k(B.
                    100: @item double_output
                    101: 1 $B$N$H$-(B, $BG\@:EYIbF0>.?t$O$D$M$K(B ddd.ddd $B$N7A$GI=<($5$l$k(B.
1.6       noro      102: @item fortran_output
                    103: 1 $B$N$H$-(B, $BB?9`<0$NI=<($,(B FORTRAN $B%9%?%$%k$K$J$k(B. $B$9$J$o$AQQ$,(B
                    104: @samp{^} $B$NBe$o$j$K(B @samp{**} $B$GI=$5$l$k(B.
                    105: ($B%G%U%)%k%HCM$O(B 0.)
1.1       noro      106: @item ox_batch
                    107: 1 $B$N$H$-(B, $BAw?.%P%C%U%!$,$$$C$Q$$$K$J$C$?;~$N$_<+F0E*$K(B flush.
                    108: 0 $B$N$H$-(B, $B%G!<%?(B, $B%3%^%s%IAw?.Kh$K(B flush. ($B%G%U%)%k%HCM$O(B 0.)
1.10      noro      109: @xref{$BJ,;67W;;(B}.
1.1       noro      110: @item ox_check
                    111: 1 $B$N$H$-(B, $BAw?.%G!<%?$rAj<j%W%m%;%9$,<u$1<h$l$k$+$I$&$+%A%'%C%/$9$k(B.
                    112: 0 $B$N$H$-$7$J$$(B. ($B%G%U%)%k%HCM$O(B 1.)
1.10      noro      113: @xref{$BJ,;67W;;(B}.
1.5       noro      114: @item ox_exchange_mathcap
                    115: 1 $B$N$H$-(B, OX server $B$H$N@\B33+;O;~$K(B, $B<+F0E*$K(B mathcap $B$N8r49$r9T$&(B.
                    116: ($B%G%U%)%k%HCM$O(B 1.)
1.10      noro      117: @xref{$BJ,;67W;;(B}.
1.1       noro      118: @end table
1.3       noro      119: \E
                    120: \BEG
                    121: @item
                    122: This function is used to set or to get the values of switches.
                    123: The switches are used to control an execution of @b{Asir}.
                    124: @item If @var{obj} is not specified, the value of @var{switch} is returned.
                    125: @item If @var{obj} is specified, the value of @var{switch} is set to
                    126: @var{obj}.
                    127: @item
                    128: Switches are specified by strings, namely, enclosed by two
                    129: double quotes.
                    130: @item
                    131: Here are of switches of @b{Asir}.
                    132: @table @code
                    133: @item cputime
                    134: If `on', CPU time and GC time is displayed at every top level evaluation
                    135: of @b{Asir} command; if `off', not displayed.
                    136: @xref{cputime tstart tstop}.
                    137: (The switch is also set by command @code{cputime(1)}, and
                    138: reset by @code{cputime(0)}.)
                    139: @item nez
                    140: Selection for EZGCD algorithm.  It is set to 1 by default.  Ordinary
                    141: users need not change this setting.
                    142: @item echo
                    143: If `on', inputs from the standard input will be echoed onto the
                    144: standard output.  When executing to load a file, the contents of the
                    145: file will be written onto the standard output.
                    146: If `off', the inputs will not be echoed.
                    147: This command will be useful when used with command @code{output}.
                    148: @item bigfloat
                    149: If `on', floating operations will be done by @b{PARI} system with arbitrary
                    150: precision floating point operations.
                    151: Default precision is set to 9 digits.  To change the precision, use
                    152: command @code{setprec}.
                    153: If `off', floating operations will be done by @b{Asir}'s own floating
                    154: operation routines with a fixed precision operations of
                    155: standard floating double.
                    156: @cindex PARI
                    157: @item adj
                    158: Sets the frequency of garbage collection. A rational number greater
                    159: than or equal to 1 can be specified. The default value is 3.
                    160: If a value closer to 1 is specified, larger heap is allocated
                    161: and as a result, the frequency of garbage collection decreases.
                    162: @xref{Command line options}.
                    163: @item verbose
                    164: If `on' a warning messages is displayed when a function is redefined.
1.14      ohara     165: @item quiet_mode
                    166: If 1 is set, the copyright notice has been displayed at boot time.
1.15      takayama  167: @item prompt
                    168: If the value is 0, then prompt is not output.
                    169: If the value is 1, then the standard prompt is output.
                    170: Asir prompt can be customized by giving a C-style format string.
                    171: Example (for unix asir);
1.16    ! ohara     172: @code{ ctrl("prompt","\033[32m[%d]:= \033[0m")}
        !           173:
1.3       noro      174: @item hex
                    175: If 1 is set, integers are displayed as hexadecimal numbers with prefix
1.13      noro      176: @code{0x}. if -1 is set, hexadecimal numbers are displayed with
1.3       noro      177: @samp{|} inserted at every 8 hexadecimal digits.
1.13      noro      178: @item real_digit
                    179: Sets the number of digits used to print a floating double.
                    180: @item double_output
                    181: If set to 1, any floating double is printed in the style ddd.ddd.
1.6       noro      182: @item fortran_output
                    183: If `on' polynomials are displayed in FORTRAN style. That is, a power
                    184: is represented by @samp{**} instead of @samp{^}.
                    185: The default value is 'off.
1.3       noro      186: @item ox_batch
                    187: If 'on', the OpenXM send buffer is flushed only when the buffer is full.
                    188: If 'off', the buffer is always flushed at each sending of data or command.
                    189: The default value is 'off'.
1.10      noro      190: @xref{Distributed computation}.
1.3       noro      191: @item ox_check
                    192: If 'on' the check by mathcap is done before sending data.
1.5       noro      193: The default value is 'on'.
1.10      noro      194: @xref{Distributed computation}.
1.5       noro      195: @item ox_exchange_mathcap
                    196: If 'on' Asir forces the exchange of mathcaps at the communication startup.
1.3       noro      197: The default value is 'on'.
1.10      noro      198: @xref{Distributed computation}.
1.3       noro      199: @end table
                    200: \E
1.1       noro      201: @end itemize
                    202:
                    203: @table @t
1.3       noro      204: \JP @item $B;2>H(B
                    205: \EG @item References
1.1       noro      206: @fref{cputime tstart tstop}, @fref{output},
1.7       noro      207: @fref{pari}, @fref{setprec}, @fref{eval deval}.
1.1       noro      208: @end table
                    209:
1.3       noro      210: \JP @node debug,,, $B$=$NB>(B
                    211: \EG @node debug,,, Miscellaneouses
1.1       noro      212: @subsection @code{debug}
                    213: @findex debug
                    214:
                    215: @table @t
                    216: @item debug
1.3       noro      217: \JP :: $B%G%P%C%0%b!<%I$KF~$k(B.
                    218: \EG :: Forces to enter into debugging mode.
1.1       noro      219: @end table
                    220:
                    221: @itemize @bullet
1.3       noro      222: \BJP
1.1       noro      223: @item
                    224: @code{debug} $B$OL50z?t$NH!?t$G$"$k$,(B, @samp{()} $B$J$7$G8F$S=P$;$k(B.
                    225: @item
                    226: $B%G%P%C%0%b!<%I$KF~$k$H%W%m%s%W%H$,(B @code{(debug)} $B$H$J$j(B, $B%3%^%s%I(B
                    227: $B<u$1IU$1>uBV$H$J$k(B. @code{quit} $B$rF~NO$9$k$H%G%P%C%,$+$iH4$1$k(B.
                    228: @item
                    229: $B%G%P%C%0%b!<%I$K$D$$$F$N>\:Y$O(B @xref{$B%G%P%C%,(B}.
1.3       noro      230: \E
                    231: \BEG
                    232: Function @code{debug} is a function with no argument.
                    233: It can be called without @samp{()}.
                    234: @item
                    235: In the debug-mode, you are prompted by @code{(debug)} and
                    236: the debugger is ready for commands.
                    237: Typing in @code{quit} (Note! without a semicolon.) brings you
                    238: to exit the debug-mode.
                    239: @item
1.10      noro      240: See @ref{Debugger} for details.
1.3       noro      241: \E
1.1       noro      242: @end itemize
                    243:
                    244: @example
                    245: [1] debug;
                    246: (debug) quit
                    247: 0
                    248: [2]
                    249: @end example
                    250:
1.3       noro      251: \JP @node error,,, $B$=$NB>(B
                    252: \EG @node error,,, Miscellaneouses
1.1       noro      253: @subsection @code{error}
                    254: @findex error
                    255:
                    256: @table @t
                    257: @item error(@var{message})
1.3       noro      258: \JP :: $B%W%m%0%i%`Cf$G6/@)E*$K%(%i!<$rH/@8$5$;$k(B.
                    259: \EG :: Forces @b{Asir} to cause an error and enter debugging mode.
1.1       noro      260: @end table
                    261:
                    262: @table @var
                    263: @item message
1.3       noro      264: \JP $BJ8;zNs(B
                    265: \EG string
1.1       noro      266: @end table
                    267:
                    268: @itemize @bullet
1.3       noro      269: \BJP
1.1       noro      270: @item
                    271: $B0lHL$K(B, $B0z?t$N4V0c$$$J$I(B, $BB39TIT2DG=$J%(%i!<$,AH$_9~$_H!?t$K$*$$$F(B
                    272: $BH/@8$7$?;~(B, $B%H%C%W%l%Y%k$KLa$kA0$K(B, $B2DG=$J$i$P$=$N%(%i!<$N;~E@$G(B
                    273: $B%G%P%C%0%b!<%I$KF~$k(B. @code{error()} $B$O(B, $B%f!<%6H!?t$NFbIt$G$3$N(B
                    274: $BF0:n$HF1MM$NF0:n$r9T$o$;$k$?$a$NH!?t$G$"$k(B.
                    275: @item
                    276: $B0z?t$O(B, @code{error()} $B$,8F$S=P$5$l$k:]$KI=<($5$l$k%a%C%;!<%8$G(B,
                    277: $BJ8;zNs$G$"$k(B.
                    278: @item
                    279: $B%f!<%6H!?t$K$*$$$F(B, $BJQ?t$r%A%'%C%/$7$F(B, $B$"$jF@$J$$CM$N>l9g$K(B @code{error()}
                    280: $B$r8F$S=P$9$h$&$K$7$F$*$1$P(B, $B$=$N;~E@$G<+F0E*$K%G%P%C%0%b!<%I$KF~$l$k(B.
1.3       noro      281: \E
                    282: \BEG
                    283: @item
                    284: When @b{Asir} encounters a serious error such that it finds difficult
                    285: to continue execution,
                    286: it, in general, tries to enter debugging mode before it returns to
                    287: top level.
                    288: The command @code{error()} forces a similar behavior in a user program.
                    289: @item
                    290: The argument is a string which will be displayed when @code{error()}
                    291: will be executed.
                    292: @item
                    293: You can enter the debug-mode when your program encounters an illegal
                    294: value for a program variable, if you have written the program
                    295: so as to call @code{error()} upon finding such an error in your program
                    296: text.
                    297: \E
1.1       noro      298: @end itemize
                    299:
                    300: @example
                    301: % cat mod3
                    302: def mod3(A) @{
                    303:         if ( type(A) >= 2 )
                    304:                 error("invalid argument");
                    305:         else
                    306:                 return A % 3;
                    307: @}
                    308: end$
                    309: % asir
                    310: [0] load("mod3");
                    311: 1
                    312: [3] mod3(5);
                    313: 2
                    314: [4] mod3(x);
                    315: invalid argument
                    316: stopped in mod3 at line 3 in file "./mod3"
                    317: 3                       error("invalid argument");
                    318: (debug) print A
                    319: A = x
                    320: (debug) quit
                    321: return to toplevel
                    322: [4]
                    323: @end example
                    324:
                    325: @table @t
1.3       noro      326: \JP @item $B;2>H(B
                    327: \EG @item References
1.1       noro      328: @fref{debug}.
                    329: @end table
                    330:
1.3       noro      331: \JP @node help,,, $B$=$NB>(B
                    332: \EG @node help,,, Miscellaneouses
1.1       noro      333: @subsection @code{help}
                    334: @findex help
                    335:
                    336: @table @t
                    337: @item help(["@var{function}"])
1.3       noro      338: \JP :: $BH!?t$N@bL@$rI=<($9$k(B.
                    339: \EG :: Displays the description of function @var{function}.
1.1       noro      340: @end table
                    341:
                    342: @table @var
                    343: @item return
                    344: 0
                    345: @item function
1.3       noro      346: \JP $BH!?tL>(B
                    347: \EG function name
1.1       noro      348: @end table
                    349:
                    350: @itemize @bullet
1.3       noro      351: \BJP
1.1       noro      352: @item
                    353: $BL50z?t$N;~(B, $B:G>.8B$N@bL@$,I=<($5$l$k(B. $BH!?tL>$,0z?t$H$7$FM?$($i$l$?(B
                    354: $B$H$-(B, $BI8=`%i%$%V%i%j%G%#%l%/%H%j$K$"$k(B @samp{help} $B$H$$$&%G%#%l%/%H%j(B
                    355: $B$KF1L>$N%U%!%$%k$,$"$l$P(B, $B4D6-JQ?t(B @code{PAGER} $B$K@_Dj$5$l$F$$$k%3%^%s%I(B,
                    356: $B$"$k$$$O(B @samp{more} $B$r8F$S=P$7$F$=$N%U%!%$%k$rI=<($9$k(B.
                    357: @item
1.4       noro      358: $B4D6-JQ?t(B @code{LANG} $B$,@_Dj$5$l$F$$$k>l9g(B, $B$=$NCM$,(B @code{"japan"} $B$^$?$O(B
                    359: @code{"ja_JP"} $B$G;O$^$k$J$i(B, @samp{help} $B$NBe$o$j$K(B @samp{help-jp}
                    360: $B$K$"$k%U%!%$%k$,I=<($5$l$k(B. $B$=$&$G$J$$>l9g(B, @samp{help-eg}
                    361: $B$K$"$k%U%!%$%k$,I=<($5$l$k(B.
                    362: @item
1.1       noro      363: Windows $BHG$G$O(B, $B%3%^%s%I%i%$%s$+$i$N%X%k%W8F$S=P$7$OL$%5%]!<%H$@$,(B,
                    364: $B%a%K%e!<$+$i(B HTML $B7A<0$N$b$N$r8F$S=P$7MQ$$$k$3$H$,$G$-$k(B.
1.3       noro      365: \E
                    366: \BEG
                    367: @item
                    368: If invoked without argument, it displays rough usage of @b{Asir}.
                    369: @item
                    370: If a function name is given and if there exists a file with the
                    371: same name in the directory @samp{help} under standard library directory,
                    372: the file is displayed by a command set to the environmental variable
                    373: @code{PAGER} or else command @samp{more}.
1.4       noro      374: @item
                    375: If the @code{LANG} environment variable is set and its value
                    376: begins with @code{"japan"} or @code{"ja_JP"}, then the file in
                    377: @samp{help-jp} is displayed. If its value does not begin with
                    378: @code{"japan"} or @code{"ja_JP"}, then the file in @samp{help-eg}
                    379: is displayed.
1.3       noro      380: @item
                    381: On Windows HTML-style help is available from the menu.
                    382: \E
1.1       noro      383: @end itemize
                    384:
1.3       noro      385: \JP @node time,,, $B$=$NB>(B
                    386: \EG @node time,,, Miscellaneouses
1.1       noro      387: @subsection @code{time}
                    388: @findex time
                    389:
                    390: @table @t
                    391: @item time()
1.3       noro      392: \JP :: $B%;%C%7%g%s3+;O$+$i8=:_$^$G$N(B CPU $B;~4V$*$h$S(B GC $B;~4V$rI=<($9$k(B
                    393: \BEG
                    394: :: Returns a four element list consisting of
                    395: total CPU time, GC time, the elapsed time
                    396: and also total memory quantities requested
                    397: from the start of current @b{Asir} session.
                    398: \E
1.1       noro      399: @end table
                    400:
                    401: @table @var
                    402: @item return
1.3       noro      403: \JP $B%j%9%H(B
                    404: \EG list
1.1       noro      405: @end table
                    406:
                    407: @itemize @bullet
1.3       noro      408: \BJP
1.1       noro      409: @item
                    410: CPU $B;~4V$*$h$S(B GC $B;~4V$NI=<($K4X$9$k%3%^%s%I$G$"$k(B.
                    411: @item
                    412: GC $B;~4V$H$O(B, $B%,!<%Y%8%3%l%/%?$K$h$j>CHq$5$l$?$H8+$J$5$l$k;~4V(B,
                    413: CPU $B;~4V$O(B, $BA4BN$N(B CPU $B;~4V$+$i(B GC $B;~4V$r0z$$$?;D$j$G(B, $BC10L$OIC$G$"$k(B.
                    414: @item
                    415: @code{time()} $B$O0z?t$J$7$G(B, $B%;%C%7%g%s3+;O$+$i8=:_$^$G$N(B CPU $B;~4V(B,
                    416: GC $B;~4V(B, $B8=:_$^$G$KMW5a$5$l$?%a%b%j$N$N$YMFNL(B, $B$*$h$S%;%C%7%g%s3+;O$+$i(B
                    417: $B8=:_$^$G$N7P2a;~4V$NI=<($r$9$k(B.
                    418: $B$9$J$o$A(B, @code{[CPU $B;~4V(B ($BIC(B), GC $B;~4V(B ($BIC(B), $B%a%b%jNL(B ($B%o!<%I(B), $B7P2a;~4V(B ($BIC(B)]}
                    419: $B$J$k%j%9%H$rJV$9(B. 1 $B%o!<%I$ODL>o(B 4 $B%P%$%H$G$"$k(B.
                    420: @item
                    421: $B7W;;$N<B9T3+;O;~(B, $B=*N;;~$N(B @code{time()} $B$+$i(B, $B$=$N7W;;$KBP$9$k(B
                    422: CPU $B;~4V(B, GC $B;~4V$,$o$+$k(B.
                    423: @item
                    424: $B%a%b%jNL$OB?G\D9?t$G$O$J$$$?$a(B, $B$"$kCM$r1[$($k$HL50UL#$JCM$H$J$k$?$a(B
                    425: $B$"$/$^$G$bL\0B$H$7$FMQ$$$k$Y$-$G$"$k(B.
                    426: @item
                    427: @code{ctrl()} $B$d(B @code{cputime()} $B$K$h$j(B @code{cputime} $B%9%$%C%A$,(B
                    428: on $B$K$J$C$F$$$k>l9g$K$O(B, $B%H%C%W%l%Y%k$NJ8$r0l$D$NC10L$H$7$F(B,
                    429: $B$=$N<B9T;~4V$,I=<($5$l$k(B. $B$7$+$7(B, $B%W%m%0%i%`$NFbIt$J$I$G(B, $BFCDj$N(B
                    430: $B7W;;$KBP$9$k7W;;;~4V$rCN$j$?$$;~$K$O(B, @code{time()} $B$J$I$r;H$&(B
                    431: $BI,MW$,$"$k(B.
                    432: @item
                    433: @code{getrusage()} $B$,;H$($k(B UNIX $B>e$G$O(B @code{time()} $B$O?.Mj@-$N$"$kCM(B
                    434: $B$rJV$9$,(B, Windows 95, 98 $B>e$G$O;~9o$rMQ$$$k$[$+J}K!$,$J$$$?$a7P2a;~4V$=$N$b$N(B
                    435: $B$,I=<($5$l$k(B. $B$h$C$F(B, $BBT$A>uBV$,$"$k$H(B, $B$=$l$b7P2a;~4V$K2C;;$5$l$k(B.
1.3       noro      436: \E
                    437: \BEG
                    438: @item
                    439: These are commands regarding CPU time and GC time.
                    440: @item
                    441: The GC time is the time regarded to spent by the garbage collector,
                    442: and the CPU time is the time defined by subtracting the GC time from
                    443: the total time consumed by command @b{Asir}.  Their unit is `second.'
                    444: @item
                    445: Command @code{time()} returns total CPU time and GC time measured
                    446: from the start of current @b{Asir} session. It also returns the elapsed
                    447: time. Time unit is `second.'
                    448: Moreover, it returns total memory quantities in words
                    449: (usually 4 bytes) which are requested
                    450: to the memory manager from the beginning of the current session.
                    451: The return value is a list and the format is @code{[CPU time, GC time,
                    452: Memory, Elapsed time]}.
                    453: @item
                    454: You can find the CPU time and GC time for some computation by taking
                    455: the difference of the figure reported by @code{time()} at the beginning
                    456: and the ending of the computation.
                    457: @item
                    458: Since arbitrary precision integers are NOT used for counting
                    459: the total amount of memory request, the number will eventually happen
                    460: to become meaningless due to integer overflow.
                    461: @item
                    462: When @code{cputime} switch is active by @code{ctrl()} or by
                    463: @code{cputime()}, the execution time will be displayed after every
                    464: evaluation of top level statement.
                    465: In a program, however, in order to know the execution time for a
                    466: sequence of computations, you have to use @code{time()} command, for
                    467: an example.
                    468: @item
                    469: On UNIX, if @code{getrusage()} is available, @code{time()} reports
                    470: reliable figures. On Windows NT it also gives reliable CPU time.
                    471: However, on Windows 95/98, the reported time is nothing but
                    472: the elapsed time of the real world.
                    473: Therefore, the time elapsed in the debug-mode and the time of waiting
                    474: for a reply to interruption prompting are added to the elapsed time.
                    475: \E
1.1       noro      476: @end itemize
                    477:
                    478: @example
                    479: [72] T0=time();
                    480: [2.390885,0.484358,46560,9.157768]
                    481: [73] G=hgr(katsura(4),[u4,u3,u2,u1,u0],2)$
                    482: [74] T1=time();
                    483: [8.968048,7.705907,1514833,63.359717]
                    484: [75] ["CPU",T1[0]-T0[0],"GC",T1[1]-T0[1]];
                    485: [CPU,6.577163,GC,7.221549]
                    486: @end example
                    487:
                    488: @table @t
1.3       noro      489: \JP @item $B;2>H(B
                    490: \EG @item References
1.1       noro      491: @fref{cputime tstart tstop}.
                    492: @end table
                    493:
1.3       noro      494: \JP @node cputime tstart tstop,,, $B$=$NB>(B
                    495: \EG @node cputime tstart tstop,,, Miscellaneouses
1.1       noro      496: @subsection @code{cputime}, @code{tstart}, @code{tstop}
                    497: @findex cputime
                    498: @findex tstart
                    499: @findex tstop
                    500:
                    501: @table @t
                    502: @item cputime(@var{onoff})
1.3       noro      503: \JP :: $B0z?t$,(B 0 $B$J$i$P(B @code{cputime} $B$NI=<($r;_$a$k(B. $B$=$l0J30$J$i$PI=<($r9T$&(B.
                    504: \BEG
                    505: :: Stop displaying @code{cputime} if its argument is 0, otherwise
                    506: start displaying @code{cputime} after every top level evaluation of
                    507: Asir command.
                    508: \E
1.1       noro      509: @item tstart()
1.3       noro      510: \JP :: CPU time $B7WB,3+;O(B.
                    511: \EG :: Resets and starts timer for CPU time and GC time.
1.1       noro      512: @item tstop()
1.3       noro      513: \JP :: CPU time $B7WB,=*N;$*$h$SI=<((B.
                    514: \BEG
                    515: :: Stops timer and then displays CPU time GC time elapsed from the
                    516: last time when timer was started.
                    517: \E
1.1       noro      518: @end table
                    519:
                    520: @table @var
                    521: @item return
                    522: 0
                    523: @item onoff
1.3       noro      524: \JP $B%U%i%0(B ($BG$0U(B)
                    525: \EG flag (arbitrary)
1.1       noro      526: @end table
                    527:
                    528: @itemize @bullet
1.3       noro      529: \BJP
1.1       noro      530: @item
                    531: @code{cputime()} $B$O(B, $B0z?t$,(B 0 $B$J$i$P(B CPU time $B$NI=<($r;_$a$k(B. $B$=$l0J30$J$i$PI=<($r9T$&(B.
                    532: @item
                    533: @code{tsart} $B$O0z?t$J$7(B, @samp{()} $B$J$7$G(B, CPU time $B7WB,$r3+;O$9$k(B.
                    534: @item
                    535: @code{tstop} $B$O0z?t$J$7(B, @samp{()} $B$J$7$G(B, CPU time $B7WB,$r=*N;(B,
                    536: $B$*$h$SI=<($9$k(B.
                    537: @item
                    538: @code{cputime(@var{onoff})} $B$O(B @code{ctrl("cputime",@var{onoff})} $B$HF1$8$G$"$k(B.
                    539: @item
                    540: @code{tstart}, @code{tstop} $B$O(B, $BF~$l;R$K$7$F;H$o$l$k$3$H$OA[Dj$7$F$$$J$$(B
                    541: $B$?$a(B, $B$=$N$h$&$J2DG=@-$,$"$k>l9g$K$O(B, @code{time()} $B$K$h$k7WB,$r9T$&(B
                    542: $BI,MW$,$"$k(B.
                    543: @item
                    544: @code{cputime()} $B$K$h$k(B on, off $B$O(B, $BC1$KI=<($N(B on, off $B$G$"$j(B, $B%H%C%W%l%Y%k(B
                    545: $B$N0l$D$NJ8$KBP$9$k7WB,$O>o$K9T$o$l$F$$$k(B. $B$h$C$F(B, $B7W;;$r;O$a$F$+$i$G$b(B,
                    546: $B7W;;=*N;A0$K%G%P%C%,$KF~$C$F(B @code{cputime(1)} $B$r<B9T$5$;$l$P7W;;;~4V$O(B
                    547: $BI=<($5$l$k(B.
1.3       noro      548: \E
                    549: \BEG
                    550: @item
                    551: Command @code{cputime()} with NON-ZERO argument enables @b{Asir} to display
                    552: CPU time and GC time after every evaluation of top level @b{Asir} command.
                    553: The command with argument 0 disables displaying them.
                    554: @item
                    555: Command @code{tstart()} starts measuring CPU time and GC time without
                    556: arguments.  The parentheses @samp{()} may be omitted.
                    557: @item
                    558: Command @code{tstop()} stops measuring CPU time and GC time and displays
                    559: them without arguments. The parentheses @samp{()} may be omitted.
                    560: @item
                    561: Command @code{cputime(@var{onoff})} has same meaning as
                    562: @code{ctrl("cputime",@var{onoff})}.
                    563: @item
                    564: Nested use of @code{tstart()} and @code{tstop()} is not expected.
                    565: If such an effect is desired, use @code{time()}.
                    566: @item
                    567: On and off states by @code{cputime()} have effects only to displaying
                    568: mode.  Time for evaluation of every top level statement is always
                    569: measured.
                    570: Therefore, even after a computation has already started,
                    571: you can let @b{Asir} display the timings, whenever you enter
                    572: the debug-mode and execute @code{cputime(1)}.
                    573: \E
1.1       noro      574: @end itemize
                    575:
                    576: @example
                    577: [49] tstart$
                    578: [50] fctr(x^10-y^10);
                    579: [[1,1],[x+y,1],[x^4-y*x^3+y^2*x^2-y^3*x+y^4,1],[x-y,1],
                    580: [x^4+y*x^3+y^2*x^2+y^3*x+y^4,1]]
                    581: [51] tstop$
                    582: 80msec + gc : 40msec
                    583: @end example
                    584:
                    585: @table @t
1.3       noro      586: \JP @item $B;2>H(B
                    587: \EG @item References
1.1       noro      588: @fref{time}, @fref{ctrl}.
                    589: @end table
1.8       noro      590:
                    591: \JP @node timer,,, $B$=$NB>(B
                    592: \EG @node timer,,, Miscellaneouses
                    593: @subsection @code{timer}
                    594: @findex timer
                    595:
                    596: @table @t
                    597: @item timer(@var{interval},@var{expr},@var{val})
                    598: \JP :: $B@)8B;~4V$D$-$G7W;;$r<B9T$9$k(B.
                    599: \BEG
                    600: :: Compute an expression under the interval timer.
                    601: \E
                    602: @end table
                    603:
                    604: @table @var
                    605: @item return
                    606: \JP $B7k2L(B
                    607: \EG result
                    608:
                    609: @item interval
                    610: \JP $B@)8B;~4V(B ($BIC(B)
                    611: \EG interval (second)
                    612:
                    613: @item expr
                    614: \JP $B7W;;$9$k<0(B
                    615: \EG expression to be computed
                    616:
                    617: @item val
                    618: \JP $B%?%$%^$K$h$kCfCG;~$NLa$jCM(B
                    619: \EG a value to be returned when the timer is expired
                    620: @end table
                    621:
                    622: @itemize @bullet
                    623:
                    624: \BJP
                    625: @item
                    626: @code{timer()} $B$O(B, $B;~4V$r;XDj$7$F7W;;$r<B9T$9$k(B. $B;XDj;~4VFb$K7W;;$,40N;(B
                    627: $B$7$?>l9g$=$NCM$rJV$9(B. $B;XDj;~4VFb$K7W;;$,40N;$7$J$+$C$?>l9g(B, $BBh(B 3 $B0z?t(B
                    628: $B$rJV$9(B.
                    629:
                    630: @item
                    631: $BBh(B 3 $B0z?t$NCM$O(B, $B7W;;$,40N;$7$?>l9g$NCM$H6hJL$G$-$kI,MW$,$"$k(B.
                    632: \E
                    633:
                    634: \BEG
                    635: @item
                    636: @code{timer()} computes an expression under the interval timer.
                    637: If the computation finishes within the specified interval, it
                    638: returns the result of the computation. Otherwise it returns the third
                    639: argument.
                    640:
                    641: @item
                    642: The third argument should be distinguishable from the result on success.
                    643: \E
                    644:
                    645: @end itemize
                    646:
                    647: @example
                    648: [0] load("cyclic");
                    649: 1
                    650: [10] timer(10,dp_gr_main(cyclic(7),[c0,c1,c2,c3,c4,c5,c6],1,1,0),0);
                    651: interval timer expired (VTALRM)
                    652: 0
                    653: [11]
                    654: @end example
1.1       noro      655:
1.3       noro      656: \JP @node heap,,, $B$=$NB>(B
                    657: \EG @node heap,,, Miscellaneouses
1.1       noro      658: @subsection @code{heap}
                    659: @findex heap
                    660:
                    661: @table @t
                    662: @item heap()
1.3       noro      663: \JP :: $B8=:_$N%R!<%W$NBg$-$5$rJV$9(B. ($BC10L(B:$B%P%$%H(B)
                    664: \EG :: Heap area size currently in use.
1.1       noro      665: @end table
                    666:
                    667: @table @var
                    668: @item return
1.3       noro      669: \JP $B<+A3?t(B
                    670: \EG non-negative integer
1.1       noro      671: @end table
                    672:
                    673: @itemize @bullet
1.3       noro      674: \BJP
1.1       noro      675: @item
                    676: $B8=:_$N%R!<%W$NBg$-$5(B($BC10L(B : $B%P%$%H(B) $B$rJV$9(B. $B%R!<%W$H$O(B, @b{Asir} $B$N(B
                    677: $B$5$^$6$^$J?t<0$d(B, $B%f!<%6%W%m%0%i%`$J$I$,$*$+$l$k%a%b%j$NNN0h$G(B, $B%,!<%Y%8(B
                    678: $B%3%l%/%?$K$h$j4IM}$5$l$F$$$k(B. $B%W%m%0%i%`$NF0:nCf$O(B, $B%R!<%W$NBg$-$5$O(B
                    679: $BC1D4Hs8:>/$G$"$j(B, $B<B%a%b%j$NNL$r$3$($FBg$-$/$J$C$?>l9g$K$O(B, OS $B$K$h$k(B
                    680: $B%9%o%C%W%(%j%"$X$NFI$_=q$-$,$[$H$s$I$N7W;;;~4V$r@j$a$k$3$H$K$J$k(B.
                    681: @item
                    682: $B<B%a%b%j$,>/$J$$>l9g$K$O(B, $B5/F0;~$N(B @code{-adj} $B%*%W%7%g%s$K$h$j(B,
                    683: GC $B<gBN$N@_Dj$r9T$C$F$*$/I,MW$,$"$k(B.
1.3       noro      684: \E
                    685: \BEG
                    686: @item
                    687: Command @code{heap()} returns an integer which is the byte size
                    688: of current @b{Asir} heap area.
                    689:
                    690: Heap is a memory area where various data for expressions and
                    691: user programs of @b{Asir} and is managed by the garbage collector.
                    692: While @b{Asir} is running, size of the heap is monotonously
                    693: non-decreasing against the time elapsed.  If it happens to exceed the
                    694: real memory size, most (real world) time is consumed for swapping between
                    695: real memory and disk memory.
                    696: @item
                    697: For a platform with little real memory, it is recommended to set up
                    698: @b{Asir} configuration tuned for GC functions by @code{-adj} option
                    699: at the activation of @b{Asir}. (@xref{Command line options}.)
                    700: \E
1.1       noro      701: @end itemize
                    702:
                    703: @example
                    704: % asir -adj 16
                    705: [0] load("fctrdata")$
                    706: 0
                    707: [97] cputime(1)$
                    708: 0msec
                    709: [98] heap();
                    710: 524288
                    711: 0msec
                    712: [99] fctr(Wang[8])$
                    713: 3.190sec + gc : 3.420sec
                    714: [100] heap();
                    715: 1118208
                    716: 0msec
                    717: [101] quit;
                    718: % asir
                    719: [0] load("fctrdata")$
                    720: 0
                    721: [97] cputime(1)$
                    722: 0msec
                    723: [98] heap();
                    724: 827392
                    725: 0msec
                    726: [99] fctr(Wang[8])$
                    727: 3.000sec + gc : 1.180sec
                    728: [100] heap();
                    729: 1626112
                    730: 0msec
                    731: [101] quit;
                    732: @end example
                    733:
                    734: @table @t
1.3       noro      735: \JP @item $B;2>H(B
                    736: \EG @item References
                    737: \JP @fref{$B%3%^%s%I%i%$%s%*%W%7%g%s(B}.
                    738: \EG @fref{Command line options}.
1.1       noro      739: @end table
                    740:
1.3       noro      741: \JP @node version,,, $B$=$NB>(B
                    742: \EG @node version,,, Miscellaneouses
1.1       noro      743: @subsection @code{version}
                    744: @findex version
                    745:
                    746: @table @t
                    747: @item version()
1.3       noro      748: \JP :: @b{Asir} $B$N%P!<%8%g%s$rJV$9(B.
                    749: \EG :: Version identification number of  @b{Asir}.
1.1       noro      750: @end table
                    751:
                    752: @table @var
                    753: @item return
1.3       noro      754: \JP $B<+A3?t(B
                    755: \EG integer
1.1       noro      756: @end table
                    757:
                    758: @itemize @bullet
1.3       noro      759: \BJP
1.1       noro      760: @item
1.3       noro      761: @b{Asir} $B$N%P!<%8%g%s$r<+A3?t$GJV$9(B.
                    762: \E
                    763: \BEG
                    764: Command @code{version()} returns the version identification number
                    765: , an integer of @b{Asir} in use.
                    766: \E
1.1       noro      767: @end itemize
                    768:
                    769: @example
                    770: [0] version();
1.3       noro      771: 991214
1.1       noro      772: @end example
                    773:
1.3       noro      774: \JP @node shell,,, $B$=$NB>(B
                    775: \EG @node shell,,, Miscellaneouses
1.1       noro      776: @subsection @code{shell}
                    777: @findex shell
                    778:
                    779: @table @t
                    780: @item shell(@var{command})
1.3       noro      781: \JP :: @var{command} $B$r%7%'%k%3%^%s%I$H$7$F<B9T$9$k(B.
                    782: \EG :: Execute shell commands described by a string @var{command}.
1.1       noro      783: @end table
                    784:
                    785: @table @var
                    786: @item return
1.3       noro      787: \JP $B<+A3?t(B
                    788: \EG integer
1.1       noro      789: @item command
1.3       noro      790: \JP $BJ8;zNs(B
                    791: \EG string
1.1       noro      792: @end table
                    793:
                    794: @itemize @bullet
1.3       noro      795: \BJP
1.1       noro      796: @item
                    797: @var{command} $B$r(B C $B$N(B @code{system()} $BH!?t$K$h$j%7%'%k%3%^%s%I$H$7$F<B9T$9$k(B.
                    798: $B%7%'%k$N=*N;%9%F!<%?%9$rJV$9(B.
1.3       noro      799: \E
                    800: \BEG
                    801: Execute shell commands described by a string @var{command}
                    802: by a C function @code{system()}.  This returns the exit status of shell
                    803: as its return value.
                    804: \E
1.1       noro      805: @end itemize
                    806:
                    807: @example
                    808: [0] shell("ls");
1.12      noro      809: alg           da            katsura       ralg          suit
                    810: algt          defs.h        kimura        ratint        test
                    811: alpi          edet          kimura3       robot         texput.log
                    812: asir.o        fee           mfee          sasa          wang
                    813: asir_symtab   gr            mksym         shira         wang_data
                    814: base          gr.h          mp            snf1          wt
                    815: bgk           help          msubst        solve
                    816: chou          hom           p             sp
                    817: const         ifplot        proot         strum
                    818: cyclic        is            r             sugar
1.1       noro      819: 0
                    820: [1]
                    821: @end example
                    822:
1.3       noro      823: \JP @node map,,, $B$=$NB>(B
                    824: \EG @node map,,, Miscellaneouses
1.1       noro      825: @subsection @code{map}
                    826: @findex map
                    827:
                    828: @table @t
                    829: @item map(@var{function},@var{arg0},@var{arg1},...)
1.3       noro      830: \JP :: $B%j%9%H(B, $BG[Ns$N3FMWAG$KH!?t$rE,MQ$9$k(B.
                    831: \EG :: Applies a function to each member of a list or an array.
1.1       noro      832: @end table
                    833:
                    834: @table @var
                    835: @item return
1.3       noro      836: \JP @var{arg0} $B$HF1$87?$N%*%V%8%'%/%H(B
                    837: \EG an object of the same type as @var{arg0}.
1.1       noro      838: @item function
1.3       noro      839: \JP $BH!?tL>(B
                    840: \EG the name of a function
1.1       noro      841: @item arg0
1.3       noro      842: \JP $B%j%9%H(B, $B%Y%/%H%k(B, $B9TNs(B
                    843: \EG list, vector or matrix
1.11      noro      844: @item arg1  ...
1.3       noro      845: \JP $BG$0U(B ($B;D$j$N0z?t(B)
                    846: \EG arbitrary (the rest of arguments)
1.1       noro      847: @end table
                    848:
                    849: @itemize @bullet
1.3       noro      850: \BJP
1.1       noro      851: @item
                    852: @var{arg0} $B$N3FMWAG$r:G=i$N0z?t(B, @var{arg1} $B0J2<$N;D$j$N0z?t$H$7$F(B
                    853: $BH!?t(B @var{function} $B$r8F$S=P$7(B, @var{arg0} $B$NBP1~$9$kMWAG$N0LCV$K(B
                    854: $BH!?t8F$S=P$7$N7k2L$,F~$C$?F1$87?$N%*%V%8%'%/%H$r@8@.$7$FJV$9(B.
                    855: @item
                    856: @var{function} $B$O(B, $B%@%V%k%/%)!<%H$N$J$$H!?tL>$rMQ$$$k(B.
                    857: @item
                    858: @var{function} $B$K%W%m%0%i%`JQ?t$O;H$($J$$(B.
                    859: @item
                    860: @var{arg0} $B$,%j%9%H(B, $B%Y%/%H%k(B, $B9TNs0J30$N>l9g(B, $BC1$K(B @var{arg0},
                    861: @var{arg1}, ... $B$r0z?t$H$7$F(B @var{function} $B$r8F$S=P$7$=$N(B
                    862: $B7k2L$rJV$9(B.
1.3       noro      863: \E
                    864: \BEG
                    865: @item
                    866: Returns an object of the same type as @var{arg0}. Each member of the
                    867: returned object is the return value of a function call where the first
                    868: argument is the member of @var{arg0} corresponding to the member in
                    869: the returned object and the rest of the argument are @var{arg1},
                    870: @dots{}.
                    871: @item
                    872: @var{function} is a function name itself without @samp{"}.
                    873: @item
                    874: A program variable cannot be used as @var{function}.
                    875: @item
                    876: If @var{arg0} is neither list nor array this function simply
                    877: returns the value of @var{function}(@var{arg0},@var{arg1},@dots{}).
                    878: \E
1.1       noro      879: @end itemize
                    880:
                    881: @example
                    882: [82] def afo(X) @{ return X^3; @}
                    883: [83] map(afo,[1,2,3]);
                    884: [1,8,27]
                    885: @end example
                    886:
1.3       noro      887: \JP @node flist,,, $B$=$NB>(B
                    888: \EG @node flist,,, Miscellaneouses
1.1       noro      889: @subsection @code{flist}
                    890: @findex flist
                    891:
                    892: @table @t
                    893: @item flist()
1.3       noro      894: \JP :: $B8=:_Dj5A$5$l$F$$$kH!?tL>$rJ8;zNs%j%9%H$H$7$FJV$9(B.
                    895: \EG :: Returns the list of function names currently defined.
1.1       noro      896: @end table
                    897:
                    898: @table @var
                    899: @item return
1.3       noro      900: \JP $BJ8;zNs$N%j%9%H(B
                    901: \EG list of character strings
1.1       noro      902: @end table
                    903:
                    904: @itemize @bullet
1.3       noro      905: \BJP
1.1       noro      906: @item
                    907: $B8=:_Dj5A$5$l$F$$$kAH$_9~$_H!?t(B, $B%f!<%6Dj5AH!?t$NH!?tL>$rJ8;zNs%j%9%H(B
                    908: $B$H$7$FJV$9(B.
                    909: @item
                    910: $B%7%9%F%`H!?t$N8e$K%f!<%6Dj5AH!?t$,B3$/(B.
1.3       noro      911: \E
                    912: \BEG
                    913: @item
                    914: Returns the list of names of built-in functions and user defined functions
                    915: currently defined. The return value is a list of character strings.
                    916: @item
                    917: The names of built-in functions are followed by those of user defined
                    918: functions.
                    919: \E
1.1       noro      920: @end itemize
                    921:
                    922: @example
                    923: [77] flist();
                    924: [defpoly,newalg,mainalg,algtorat,rattoalg,getalg,alg,algv,...]
                    925: @end example
                    926:
1.3       noro      927: \JP @node delete_history,,, $B$=$NB>(B
                    928: \EG @node delete_history,,, Miscellaneouses
1.1       noro      929: @subsection @code{delete_history}
                    930: @findex delete_history
                    931:
                    932: @table @t
                    933: @item delete_history([@var{index}])
1.3       noro      934: \JP :: $B%R%9%H%j$r>C5n$9$k(B.
                    935: \EG :: Deletes the history.
1.1       noro      936: @end table
                    937:
                    938: @table @var
                    939: @item return
                    940: 0
                    941: @item index
1.3       noro      942: \JP $B>C5n$7$?$$%R%9%H%j$NHV9f(B
                    943: \EG Index of history to be deleted.
1.1       noro      944: @end table
                    945:
                    946: @itemize @bullet
1.3       noro      947: \BJP
1.1       noro      948: @item
                    949: $B0z?t$,$J$$$H$-(B, $B$3$l$^$G7W;;$7$?%R%9%H%j$rA4$F>C5n$9$k(B.
                    950: @item
                    951: $B0z?t$,$"$k$H$-(B, $B$=$NHV9f$N7k2L$N$_>C5n$9$k(B.
                    952: @item
                    953: $B$3$3$G%R%9%H%j$H$O(B, $BHV9f$D$-$N%W%m%s%W%H$KBP$7$F$NF~NO$rI>2A$7$FF@$i$l$?<0(B
                    954: $B$G(B, $B$3$N<0$O(B @code{@@@var{number}} $B$K$h$j<h$j=P$9$3$H$,$G$-$k(B. $B$3$N$3$H$O(B,
                    955: $B%,!<%Y%C%8%3%l%/%7%g%s$N:]$K$b$3$N<0$,@8$-;D$k$3$H$r0UL#$9$k(B.
                    956: @item
                    957: $BBg$-$J<0$,%R%9%H%j$H$7$F;D$C$?>l9g(B, $B0J9_$N%a%b%j4IM}$K;Y>c$rMh$9>l9g$,B?$$(B
                    958: $B$?$a(B, @code{bsave()} $B$J$I$G%U%!%$%k$K%;!<%V$7$F(B, @code{delete_history()}
                    959: $B$K$h$j%R%9%H%j$r>C5n$7$F$*$/$N$,M-8z$G$"$k(B.
1.3       noro      960: \E
                    961: \BEG
                    962: @item
                    963: Deletes all the histories without an argument.
                    964: @item
                    965: Deletes the history with index @var{index} if specified.
                    966: @item
                    967: A history is an expression which has been obtained by evaluating an input
                    968: given for a prompt with an index. It can be taken out by @code{@@@var{index}},
                    969: which means that the expression survives garbage collections.
                    970: @item
                    971: A large history may do harm in the subsequent memory management and
                    972: deleting the history by @code{delete_history()}, after saving it in a file
                    973: by @code{bsave()}, is often effective.
                    974: \E
1.1       noro      975: @end itemize
                    976:
                    977: @example
                    978: [0] (x+y+z)^100$
                    979: [1] @@0;
                    980: ...
                    981: [2] delete_history(0);
                    982: [3] @@0;
                    983: 0
                    984: @end example
                    985:
1.3       noro      986: \JP @node get_rootdir,,, $B$=$NB>(B
                    987: \EG @node get_rootdir,,, Miscellaneouses
1.1       noro      988: @subsection @code{get_rootdir}
                    989: @findex get_rootdir
                    990:
                    991: @table @t
                    992: @item get_rootdir()
1.3       noro      993: \JP :: Asir $B$N%k!<%H%G%#%l%/%H%jL>$r<h$j=P$9(B
                    994: \EG :: Gets the name of @b{Asir} root directory.
1.1       noro      995: @end table
                    996:
                    997: @table @var
                    998: @item return
1.3       noro      999: \JP $BJ8;zNs(B
                   1000: \EG string
1.1       noro     1001: @end table
                   1002:
                   1003: @itemize @bullet
1.3       noro     1004: \BJP
1.1       noro     1005: @item
                   1006: UNIX $BHG$N>l9g(B, $B4D6-JQ?t(B @code{ASIR_LIBDIR} $B$,Dj5A$5$l$F$$$k>l9g$K$O$=$NCM(B, $B$5$l$F$$$J$$>l9g(B
                   1007: $B$K$O(B @samp{/usr/local/lib/asir} $B$rJV$9(B.
                   1008: @item
                   1009: Windows $BHG$N>l9g(B, @samp{asirgui.exe} $B$N$"$k%G%#%l%/%H%j(B (@samp{bin} $B$H$$$&L>A0$N$O$:$G$"$k(B)
                   1010: $B$N?F%G%#%l%/%H%j$,JV$5$l$k(B.
                   1011: @item
                   1012: $B$3$N4X?t$,JV$9%G%#%l%/%H%jL>$r4p=`$H$7$?AjBP%Q%9L>$r;XDj$9$k$3$H$K$h$j(B, $B%$%s%9%H!<%k(B
                   1013: $B$5$l$?>l=j$K$h$i$J$$%U%!%$%kFI$_9~$_%W%m%0%i%`$r=q$/$3$H$,$G$-$k(B.
1.3       noro     1014: \E
                   1015: \BEG
                   1016: @item
                   1017: On UNIX it returns the value of an environment variable @code{ASIR_LIBDIR}
                   1018: or @samp{/usr/local/lib/asir} if @code{ASIR_LIBDIR} is not set.
                   1019: @item
                   1020: On Windows the name of @b{Asir} root directory is returned.
                   1021: @item
                   1022: By using relative path names from the value of this function,
                   1023: one can write programs which contain file operations independent
                   1024: of the install directory.
                   1025: \E
1.1       noro     1026: @end itemize
1.2       noro     1027:
                   1028:
1.3       noro     1029: \JP @node getopt,,, $B$=$NB>(B
                   1030: \EG @node getopt,,, Miscellaneouses
1.2       noro     1031: @subsection @code{getopt}
                   1032: @findex getopt
                   1033:
                   1034: @table @t
1.9       noro     1035: @item getopt([@var{key}])
1.3       noro     1036: \JP :: $B%*%W%7%g%s$NCM$rJV$9(B.
                   1037: \EG :: Returns the value of an option.
1.2       noro     1038: @end table
                   1039:
                   1040: @table @var
                   1041: @item return
1.3       noro     1042: \JP $B%*%V%8%'%/%H(B
                   1043: \EG object
1.2       noro     1044: @end table
                   1045:
                   1046: @itemize @bullet
1.3       noro     1047: \BJP
1.2       noro     1048: @item
                   1049: $B%f!<%6Dj5A4X?t$O(B, $B8GDj8D?t0z?t$G$7$+@k8@$G$-$J$$(B. $B%f!<%6Dj5A4X?t$G(B
                   1050: $B2DJQ8D0z?t$r<B8=$9$kJ}K!$N0l$D$H$7$F(B, $B%*%W%7%g%s$K$h$k0z?t$N;XDj(B
                   1051: $B$,$"$k(B (@pxref{$B%*%W%7%g%s;XDj(B}). $B;XDj$5$l$?%*%W%7%g%s$r4X?tFb$G(B
                   1052: $B<u$1<h$k$?$a$K$3$N4X?t$rMQ$$$k(B.
                   1053: @item
1.9       noro     1054: $BL50z?t$G8F$S=P$5$l$?>l9g(B, @code{getopt()} $B$O(B
                   1055: @code{[[key1,value1],[key2,value2],...]} $B$J$k%j%9%H$rJV$9(B.
                   1056: $B$3$3$G(B, @code{key} $B$O4X?t8F$S=P$7;~$K;XDj$5$l$?%*%W%7%g%s(B, @code{value}
                   1057: $B$O$=$NCM$G$"$k(B.
                   1058: @item
1.2       noro     1059: $B4X?t8F$S=P$7$N:]$K(B @var{key} $B$,%*%W%7%g%s$H$7$F;XDj$5$l$F$$$k(B
                   1060: $B>l9g$K$O(B, $B$=$NCM$rJV$9(B. $B$b$7;XDj$,$J$$>l9g$K$O(B, VOID $B7?%*%V%8%'%/%H(B
                   1061: ($B7?<1JL;R(B -1) $B$rJV$9(B. @code{getopt()} $B$,JV$7$?CM$N7?$r(B @code{type()}
                   1062: $B$GD4$Y$k$3$H$G(B, $B$=$N%*%W%7%g%s$,;XDj$5$l$?$+$I$&$+D4$Y$k$3$H$,$G$-$k(B.
                   1063: @item
                   1064: $B4X?t8F$S=P$7$K$*$1$k%*%W%7%g%s$N;XDj$O(B, $B@55,$N0z?t$J$i$S$N8e$m$K(B,
                   1065:
                   1066: @example
                   1067: xxx(A,B,C,D|x=X,y=Y,z=Z)
                   1068: @end example
                   1069:
                   1070: $B$H$$$&Iw$K(B, @samp{|} $B$KB3$/(B, @var{key=value} $B$N(B @samp{,} $B$G6h@Z$i$l$?(B
                   1071: $BJB$S$rCV$/$3$H$G9T$&(B.
1.3       noro     1072: \E
                   1073: \BEG
                   1074: @item
                   1075: When a user defined function is called, the number of arguments
                   1076: must be equal to that in the declaration of the function.
                   1077: A function with indefinite number of arguments can be realized
                   1078: by using @var{options} (@pxref{option}).
                   1079: The value of a specified option is retrieved by @code{getopt}.
1.9       noro     1080: @item
                   1081: If @code{getopt()} is called with no argument, then it returns a list
1.12      noro     1082: @code{[[key1,value1],} @code{[key2,value2],@dots{}]}.
                   1083: In the list, each @code{key}
1.9       noro     1084: is an option which was specified when the function executing @code{getopt}
                   1085: was invoked, and @code{value} is the value of the option.
1.3       noro     1086: @item
                   1087: If an option @var{key} is specified upon a function call, @code{getopt}
                   1088: return the value of the option. If such an option is not specified,
                   1089: the it returns an object of VOID type whose object identifier is
                   1090: -1. By examining the type of the returned value with @code{type()},
                   1091: one knows whether the option is set or not.
                   1092: @item
                   1093: Options are specified as follows:
                   1094:
                   1095: @example
                   1096: xxx(A,B,C,D|x=X,y=Y,z=Z)
                   1097: @end example
                   1098:
                   1099: That is, the options are specified by a sequence of @var{key=value} seperated
                   1100: by @samp{,}, after @samp{|}.
                   1101: \E
1.2       noro     1102: @end itemize
                   1103:
                   1104: @table @t
1.3       noro     1105: \JP @item $B;2>H(B
                   1106: \EG @item References
                   1107: \JP @fref{$B%*%W%7%g%s;XDj(B}, @fref{type}.
                   1108: \EG @fref{option}, @fref{type}.
                   1109: @end table
                   1110:
                   1111: \JP @node getenv,,, $B$=$NB>(B
                   1112: \EG @node getenv,,, Miscellaneouses
                   1113: @subsection @code{getenv}
                   1114: @findex getenv
                   1115:
                   1116: @table @t
                   1117: @item getenv(@var{name})
                   1118: \JP :: $B4D6-JQ?t$NCM$rJV$9(B.
                   1119: \EG :: Returns the value of an environment variable.
                   1120: @end table
                   1121:
                   1122: @table @var
                   1123: @item return
                   1124: @itemx name
                   1125: \JP $BJ8;zNs(B
                   1126: \EG string
1.2       noro     1127: @end table
                   1128:
1.3       noro     1129: @itemize @bullet
                   1130: @item
                   1131: \JP $B4D6-JQ?t(B @var{name} $B$NCM$rJV$9(B.
                   1132: \EG Returns the value of an environment variable @var{name}.
                   1133: @end itemize
                   1134:
                   1135: @example
                   1136: [0] getenv("HOME");
                   1137: /home/pcrf/noro
                   1138: @end example
1.1       noro     1139:
                   1140:
                   1141: