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