← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/core/help/en_US/configuration/stacksize.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/core/help/en_US/configuration/stacksize.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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">
3
 
  <refnamediv>
4
 
    <refname>stacksize</refname>
5
 
    <refpurpose> set scilab stack size</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>stacksize(n)
10
 
      stacksize('max')
11
 
      stacksize('min')
12
 
      sz=stacksize()
13
 
    </synopsis>
14
 
  </refsynopsisdiv>
15
 
  <refsection>
16
 
    <title>Arguments</title>
17
 
    <variablelist>
18
 
      <varlistentry>
19
 
        <term>n</term>
20
 
        <listitem>
21
 
          <para>an integer, the required stack size given in number of double precision words</para>
22
 
        </listitem>
23
 
      </varlistentry>
24
 
      <varlistentry>
25
 
        <term>sz</term>
26
 
        <listitem>
27
 
          <para>a 2-vector [total used]</para>
28
 
        </listitem>
29
 
      </varlistentry>
30
 
    </variablelist>
31
 
  </refsection>
32
 
  <refsection>
33
 
    <title>Description</title>
34
 
    <para>
35
 
      Scilab stores "usual" variables in a stack <literal>stk</literal> (for global variables see  <link linkend="gstacksize">gstacksize</link>).
36
 
    </para>
37
 
    <para>
38
 
      <literal>stacksize(n)</literal> allows the user to increase or decrease the size of
39
 
      this stack. The maximum allowed size depends on the amount of
40
 
      free memory and swap space available at the time.
41
 
    </para>
42
 
    <para>
43
 
      <literal>stacksize('max')</literal> allows the user to increase the size of
44
 
      this stack to the maximum.
45
 
    </para>
46
 
    <para>
47
 
      <literal>stacksize('min')</literal> allows the user to decrease the size of
48
 
      this stack to the minimum.
49
 
    </para>
50
 
    <para>
51
 
      This function with the <literal>n</literal> argument can now be used everywhere.
52
 
    </para>
53
 
    <para>
54
 
      <literal>sz=stacksize()</literal> returns a 2-vector which contains  the current
55
 
      total and used stack size.
56
 
    </para>
57
 
    <para>By default, the size of the stack is 100 000 000.</para>
58
 
    <para>On 64 bit platforms, maximum size of the stack is limited to 268 435 454.</para>
59
 
  </refsection>
60
 
  <refsection role="see also">
61
 
    <title>See Also</title>
62
 
    <simplelist type="inline">
63
 
      <member>
64
 
        <link linkend="who">who</link>
65
 
      </member>
66
 
      <member>
67
 
        <link linkend="gstacksize">gstacksize</link>
68
 
      </member>
69
 
    </simplelist>
70
 
  </refsection>
 
3
    <refnamediv>
 
4
        <refname>stacksize</refname>
 
5
        <refpurpose> set scilab stack size</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>stacksize(n)
 
10
            stacksize('max')
 
11
            stacksize('min')
 
12
            sz=stacksize()
 
13
        </synopsis>
 
14
    </refsynopsisdiv>
 
15
    <refsection>
 
16
        <title>Arguments</title>
 
17
        <variablelist>
 
18
            <varlistentry>
 
19
                <term>n</term>
 
20
                <listitem>
 
21
                    <para>an integer, the required stack size given in number of double precision words</para>
 
22
                </listitem>
 
23
            </varlistentry>
 
24
            <varlistentry>
 
25
                <term>sz</term>
 
26
                <listitem>
 
27
                    <para>a 2-vector [total used]</para>
 
28
                </listitem>
 
29
            </varlistentry>
 
30
        </variablelist>
 
31
    </refsection>
 
32
    <refsection>
 
33
        <title>Description</title>
 
34
        <para>
 
35
            Scilab stores "usual" variables in a stack <literal>stk</literal> (for global variables see  <link linkend="gstacksize">gstacksize</link>).
 
36
        </para>
 
37
        <para>
 
38
            <literal>stacksize(n)</literal> allows the user to increase or decrease the size of
 
39
            this stack. The maximum allowed size depends on the amount of
 
40
            free memory and swap space available at the time.
 
41
        </para>
 
42
        <para>
 
43
            <literal>stacksize('max')</literal> allows the user to increase the size of
 
44
            this stack to the maximum.
 
45
        </para>
 
46
        <para>
 
47
            <literal>stacksize('min')</literal> allows the user to decrease the size of
 
48
            this stack to the minimum.
 
49
        </para>
 
50
        <para>
 
51
            This function with the <literal>n</literal> argument can now be used everywhere.
 
52
        </para>
 
53
        <para>
 
54
            <literal>sz=stacksize()</literal> returns a 2-vector which contains  the current
 
55
            total and used stack size.
 
56
        </para>
 
57
        <para>By default, the size of the stack is 100 000 000.</para>
 
58
        <para>On 64 bit platforms, maximum size of the stack is limited to 268 435 454.</para>
 
59
    </refsection>
 
60
    <refsection role="see also">
 
61
        <title>See Also</title>
 
62
        <simplelist type="inline">
 
63
            <member>
 
64
                <link linkend="who">who</link>
 
65
            </member>
 
66
            <member>
 
67
                <link linkend="gstacksize">gstacksize</link>
 
68
            </member>
 
69
        </simplelist>
 
70
    </refsection>
71
71
</refentry>