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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?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.1-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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="load" xml:lang="en">
<refnamediv>
<refname>load</refname>
<refpurpose>Load a saved variable or a serie of variables</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>load(filename [,x1,...,xn])</synopsis>
<synopsis>load(fd [,x1,...,xn])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>filename</term>
<listitem>
<para>character string containing the path of the file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>fd</term>
<listitem>
<para>a file descriptor given by a call to mopen</para>
</listitem>
</varlistentry>
<varlistentry>
<term>xi</term>
<listitem>
<para>arbitrary Scilab variable name(s) given as strings.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
The <literal>load</literal> command can be used to reload in the
Scilab session variables previously saved in a file with the
<literal>
<link linkend="save">save</link>
</literal>
command. If the file contains graphic handle
variables, the corresponding <link linkend="graphics_entities">graphics_entities</link> are drawn.
</para>
<para>
<literal>load(filename)</literal> loads the variables saved in file
given by its path <literal>filename</literal>.
</para>
<para>
<literal>load(fd)</literal> loads the variables saved in file given
by its descriptor <literal>fd</literal>. <emphasis role="bold">This prototype is obsolete and will be removed in Scilab 6.</emphasis>
</para>
<para>
<literal>load(filename,'x','y')</literal> loads only variables <literal>x,y</literal>.
</para>
<para>
<literal>load(fd,'x','y')</literal> loads only variables <literal>x,y</literal>. <emphasis role="bold">This prototype is obsolete and will be removed in Scilab 6.</emphasis>.
</para>
<para>
The change of format between the family 5 and 6 of Scilab has been decided because the 5 format is undocumented, not specified and hard to read. SOD (Scilab 6 default format) is fully documented and easy to read through HDF5 libraries or applications.
</para>
<para>Note that the written file is portable to other operating systems
and architectures (little and big endian).
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Binary format readable up to Scilab 5 family
a=eye(2,2);b=ones(a);
save('vals.dat',a,b);
clear a
clear b
load('vals.dat','a','b');
// Binary format readable by Scilab 5.4.X and Scilab 6 family
a=eye(2,2);b=ones(a);
save("val.sod", "a", "b");
clear a
clear b
load("val.sod", "a", "b");
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="save">save</link>
</member>
<member>
<link linkend="read">read</link>
</member>
<member>
<link linkend="listvarinfile">listvarinfile</link>
</member>
<member>
<link linkend="save_format">save_format</link>
</member>
<member>
<link linkend="exec">exec</link>
</member>
<member>
<link linkend="mopen">mopen</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>History</title>
<revhistory>
<revision>
<revnumber>5.0.0</revnumber>
<revremark>
All <link linkend="uimenu">uimenu</link> or <link linkend="uicontrol">uicontrol</link> handles are also loaded by this function.
</revremark>
</revision>
<revision>
<revnumber>5.4.0</revnumber>
<revdescription>
<itemizedlist>
<listitem>
The load function is able to handle both Scilab 5 and SOD (Scilab 6 format) by default.
</listitem>
<listitem>The Scilab 5.X format is deprecated and will be removed with Scilab 6.</listitem>
<listitem>Using load with a file descriptor as first input argument is deprecated and will be removed with Scilab 6.</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</refsection>
</refentry>
|
