File: lib.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 (114 lines) | stat: -rw-r--r-- 3,702 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) XXXX-2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<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="lib">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>lib</refname>
    <refpurpose> library definition</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>xlib = lib('lib-dir')</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>lib-dir</term>
        <listitem>
          <para>character string</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para><literal>lib-dir</literal> is a character string defining a directory that contains
    compiled Scilab function (<literal>.bin</literal>) files.</para>
    <para>
    In addition to these files <literal>lib-dir</literal> must have a file called
    <literal>names</literal>, that contains the names of the functions defined in
    <literal>lib-dir</literal>.  On success, all functions in <literal>lib-dir</literal> are
    available from within Scilab.  They are loaded on demand when called
    for the first time.</para>
    <para>
    Binary files can be created from within Scilab with the command
    <literal>save</literal>.</para>
    <para>
    Scilab's standard libraries are defined using <literal>lib</literal> on the
    <literal>SCIDIR/modules/*/macros/*</literal> subdirectories.</para>
    <para>
    A library variable
    usually is saved for later loading, either on-line or from the
    user-specific startup file (see startup).</para>
  </refsection>
  <refsection>
    <title>Restrictions</title>
    <para>
    Scilab tacitly assumes that each xxxx.bin file defines a  variable named <literal>xxxx</literal>.</para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[ 
//define some variables
function z = myplus(x, y), z = x + y,endfunction
function z = yourplus(x, y), x = x - y,endfunction
A=1:10;

//create the *.bin files in libdir
libdir=TMPDIR
save(libdir + '/myplus.bin', myplus);
save(libdir + '/yourplus.bin', yourplus);
save(libdir + '/A.bin', A);

//create the name file
mputl(['myplus';'yourplus';'A'],TMPDIR+'/names');

//build the library containing myplus and yourplus
xlib = lib(libdir+'/')

//erase the variables
clear myplus yourplus A

//Automatic loading and execution
myplus(1,2)

A
 ]]></programlisting>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="library">library</link>
      </member>
      <member>
        <link linkend="genlib">genlib</link>
      </member>
      <member>
        <link linkend="save">save</link>
      </member>
      <member>
        <link linkend="deff">deff</link>
      </member>
      <member>
        <link linkend="exec">exec</link>
      </member>
      <member>
        <link linkend="whereis">whereis</link>
      </member>
    </simplelist>
  </refsection>
</refentry>