* Bug 16365 fixed: median(m,'r'|'c') was wrong after 5dc990
[scilab.git] / scilab / modules / fileio / help / ru_RU / listvarinfile.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA -
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2018 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19         xml:lang="ru" xml:id="listvarinfile">
20     <refnamediv>
21         <refname>listvarinfile</refname>
22         <refpurpose>список переменных в файле сохранённых данных</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Синтаксис</title>
26         <synopsis>
27             listvarinfile(filename);
28             [names, typs, dims, vols] = listvarinfile(filename)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Аргументы</title>
33         <variablelist>
34             <varlistentry>
35                 <term>filename</term>
36                 <listitem>
37                     <para>
38                         символьная строка, имя файла (и путь), который следует
39                         проинспектировать.
40                     </para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>nams</term>
45                 <listitem>
46                     <para>
47                         матрица строк, имена переменных, сохранённых в файле <varname>filename</varname>.
48                     </para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>dims</term>
53                 <listitem>
54                     <para>
55                         список, размерности переменных, сохранённых в файле
56                         <varname>filename</varname>.
57                     </para>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>typs</term>
62                 <listitem>
63                     <para>
64                         числовая матрица, типы переменных, сохранённых в файле
65                         <varname>filename</varname>.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>vols</term>
71                 <listitem>
72                     <para>
73                         числовая матрица, размер (в байтах) переменных, сохранённых в файле
74                         <varname>filename</varname>.
75                     </para>
76                 </listitem>
77             </varlistentry>
78         </variablelist>
79     </refsection>
80     <refsection>
81         <title>Описание</title>
82         <para>
83             Эта служебная функция составляет список переменных (наподобие <link linkend="whos">whos</link>),
84             сохранённых в файле данных Scilab'а, созданного с помощью <link linkend="save">save</link>.
85         </para>
86         <para>
87             <note>
88                 рациональные числа и пространства состояний представляются в виде
89                 простых типизированных списков (tlist);
90             </note>
91         </para>
92     </refsection>
93     <refsection>
94         <title>Примеры</title>
95         <programlisting role="example"><![CDATA[
96 // Подготовка данных различных типов:
97 b = rand(2,3) < 0.5;                    // логические значения
98 i = uint64(grand(3,4,2,"uin",0,100));   // гиперматрица кодированных целых чисел
99 c = grand(3,3,"uin",-10,10); c=c+c'*%i; // комплексые числа
100 p = (1-%z).^(0:3);                      // полиномы
101 r = p/(1+%z);                           // рациональные значения
102 sp = sprand(10,15,0.1);                 // разрежённая матрица чисел
103 spb = sp<0.5;                           // разрежённая матрица логических значений
104 t = ["This" "software" ; "is" "Scilab"];// текстовые строки
105 g = [gdf() gda()];                      // графические дескрипторы
106 function Test()                         // сценарий
107     disp("listvarinfile() test for macros")
108 end
109 M = linspace;                           // сценарий
110 L = list(%f, int8(-23),, %i-%z, list("abc",%e)); // простой список
111 C = {"abc" %t ; %z list(1/%z, 4)};      // cell-массив
112 S(4,2).r = %pi;                         // массив структур
113 vars = list("b","i","c","p","r","sp","spb","t","g","Test","M","L","C","S");
114
115 // Архивация данных в бинарном файле:
116 File = TMPDIR + "\listvarinfile.sod";
117 save(File, vars(:))
118
119 // Распечатка содержимого файла:
120 [names,types,dims,vols] = listvarinfile(File);
121 types(find(names=="Test"))
122 dims(find(names=="i"))
123  ]]></programlisting>
124     <screen><![CDATA[
125 --> [names,types,dims,vols] = listvarinfile(File);
126 Name                     Type           Size            Bytes
127 -------------------------------------------------------------
128 C                        cell           2 by 2          76
129 L                        list           4               51
130 M                        macro          1 by 1          0
131 S                        struct         4 by 2          8
132 Test                     macro          1 by 1          0
133 b                        boolean        2 by 3          24
134 c                        double         3 by 3          144
135 g                        handle         1 by 2          0
136 i                        integer        3 by 4 by 2     192
137 p                        polynomial     1 by 4          80
138 r                        tlist          4               162
139 sp                       sparse         10 by 15        232
140 spb                      boolean sparse 10 by 15        624
141 t                        string         2 by 2          40
142
143 --> types(find(names=="Test"))
144  ans  =
145    13.
146
147 --> dims(find(names=="i"))
148  ans  =
149    3.   4.   2.
150 ]]></screen>
151     </refsection>
152     <refsection role="see also">
153         <title>Смотрите также</title>
154         <simplelist type="inline">
155             <member>
156                 <link linkend="save">save</link>
157             </member>
158             <member>
159                 <link linkend="load">load</link>
160             </member>
161             <member>
162                 <link linkend="save_format">save_format</link>
163             </member>
164             <member>
165                 <link linkend="type">type</link>
166             </member>
167             <member>
168                 <link linkend="whos">whos</link>
169             </member>
170             <member>
171                 <link linkend="who">who</link>
172             </member>
173         </simplelist>
174     </refsection>
175     <refsection role="history">
176         <title>История</title>
177         <revhistory>
178             <revision>
179                 <revnumber>6.0</revnumber>
180                 <revdescription>
181                     <itemizedlist>
182                         <listitem>
183                             Теперь гиперматрицы перечисляются с типом их содержимого, вместо
184                             "mlist" и типа 17. Их размеры теперь являются фактическими размерами вместо 3.
185                         </listitem>
186                         <listitem>
187                             Cell-массивы и массивы структур теперь появлются в виде "cell" и "struct"
188                             вместо "mlist". Теперь их размеры являются фактичскими размерами вместо 3.
189                         </listitem>
190                         <listitem>
191                             Массивы графических дескрипторов теперь появляются в виде "handle" и типа 9
192                             вместо "tlist" и типа 16.
193                             Теперь их размеры являются фактичскими размерами вместо 3.
194                         </listitem>
195                         <listitem>
196                             Сценарии теперь появляются в виде "macro" и типа 13 вместо "tlist" и типа 16.
197                         </listitem>
198                         <listitem>
199                             Вещественные и комплексные числа теперь появляются в виде "double" вместо "constant".
200                         </listitem>
201                     </itemizedlist>
202                 </revdescription>
203             </revision>
204         </revhistory>
205     </refsection>
206 </refentry>
207