File: stacksize.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (61 lines) | stat: -rw-r--r-- 2,294 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="stacksize">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>stacksize</refname>
    <refpurpose> set scilab stack size</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>stacksize(n)
stacksize('max')
stacksize('min')
sz=stacksize()</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>n</term>
        <listitem>
          <para>integer, the required stack size given in number of double precision words</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>sz</term>
        <listitem>
          <para>2-vector [total used]</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
    Scilab stores "usual" variables in a stack <literal>stk</literal> (for global variables see <literal>gstacksize</literal>).</para>
    <para><literal>stacksize(n)</literal> allows the user to increase or decrease the size of
    this stack. The maximum allowed size depends on the amount of
    free memory and swap space available at the time.</para>
    <para><literal>stacksize('max')</literal> allows the user to increase the size of
    this stack to the maximum.</para>
    <para><literal>stacksize('min')</literal> allows the user to decrease the size of
    this stack to the minimum.</para>
    <para>
    This function with the <literal>n</literal> argument can now be used everywhere.</para>
    <para><literal>sz=stacksize()</literal> returns a 2-vector which contains  the current
    total and used stack size.</para>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="who">who</link>
      </member>
      <member>
        <link linkend="gstacksize">gstacksize</link>
      </member>
    </simplelist>
  </refsection>
</refentry>