File: predef.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 (58 lines) | stat: -rw-r--r-- 2,527 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
<?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="predef">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>predef</refname>
    <refpurpose> variable protection</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>n=predef()
oldnew=predef(n)
oldnew=predef('all')
oldnew=predef('clear')</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Description</title>
    <para>
    Utility function used for defining "oldest" variables as "protected".
    Protected variables  cannot be killed. They are not saved 
    by the <literal>'save'</literal> command. The "oldest" are those appearing last in
    the <literal>who('get')</literal>.</para>
    <para><literal>predef()</literal> gets the number of protected variables</para>
    <para><literal>predef('a[ll]')</literal> sets all the  variables protected, it also return
    the old and new value of protected variables number.</para>
    <para><literal>predef('c[lear]')</literal> unprotect all but the last 7 variables, it also return
    the old and new value of protected variables number.</para>
    <para><literal>predef(n)</literal> sets the <literal>max(n,7)</literal> last defined variables as protected, it also return
    the old and new value of protected variables number.</para>
  </refsection>
  <refsection>
    <title>Remarks:</title>
    <para>Variable <literal>ans</literal> created automatically when expressions are not assigned is never protected by <literal>predef('all')</literal>.</para>
    <para>
			A number of protected variables are set in the start-up file <literal>SCI/etc/scilab.start</literal>.
			User may in particular set its own predefined variables in user's startup files 
			<literal>SCIHOME/.scilab</literal> and <literal>SCIHOME/scilab.ini</literal>
		</para>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="clear">clear</link>
      </member>
      <member>
        <link linkend="save">save</link>
      </member>
      <member>
        <link linkend="ans">ans</link>
      </member>
      <member>
        <link linkend="startup">startup</link>
      </member>
    </simplelist>
  </refsection>
</refentry>