<?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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="save_format" xml:lang="en">
- <refnamediv>
- <refname>save_format</refname>
- <refpurpose>format of files produced by "save"</refpurpose>
- </refnamediv>
- <refsection>
- <title>Description</title>
- <para>
- Variables are saved by Scilab with the <link linkend="save">save</link> function in the following format:
- </para>
- <para>each variable record is appended consecutively to the file. The
- variable record begins with 6 long integer holding the variable name in
- encoded format (see the Remarks section below),
- </para>
- <para>After that comes the variable type (long integer), then, depending
- on it, for:
- </para>
- <variablelist>
- <varlistentry>
- <term>Floating matrices (type 1)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>real/complex flag it (a long integer in {0,1}),</para>
- <para>data (n*m*(it+1) doubles)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Polynomials (type 2) and Size implicit indices (type 129)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>real/complex flag it (long integer in {0,1}),</para>
- <para>formal variable name (16 bytes),</para>
- <para>index_table (m*n+1 long integers);</para>
- <para>data ((N-1)*(it+1) doubles) , where N is the value of the last
- entry of the index_table
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Booleans (type 4)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer);</para>
- <para>data (n*m long integers)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Floating sparse matrices (type 5)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>real/complex_flag it (a long integer in {0,1}),</para>
- <para>total_number_of_non_zero_elements nel (a long integer),</para>
- <para>number_of_non_zero_elements_per_row (m long integers),</para>
- <para>column_index_non_zero_elements (nel long integers),</para>
- <para>non_zero_values (nel*(it+1) doubles)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Boolean sparse matrices (type 6)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>unused it (a long integer),</para>
- <para>total_number_of_non_zero_elements nel (a long integer),</para>
- <para>number_of_non_zero_elements_per_row (m long integers),</para>
- <para>column_index_non_zero_elements (nel long integers)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Matlab sparse matrix (type 7)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>real/complex_flag it (a long integer in {0,1}),</para>
- <para>total_number_of_non_zero_elements nel (a long integer),</para>
- <para>number_of_non_zero_elements_per_column (n long
- integers),
- </para>
- <para>row_index_non_zero_elements (nel long integers),</para>
- <para>non_zero_values (nel*(it+1) doubles)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Integer matrices (type 8)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>integer_type (a long integer): 1,2,4, or 11,12,14 for signed
- and unsigned 1,2,4 bytes integers;
- </para>
- <para>data (n*m bytes for integer_type 1 or 11, n*m short integers
- for integer_type 2 or 12, n*m long integers for integer_type 4 or
- 14)
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>handles (type 9)</term>
- <listitem>
- <para>version (4 bytes)</para>
- <para>row_size m (a byte),</para>
- <para>column_size n (a byte),</para>
- <para>data (m*n serialization_records)</para>
- <para>A serialization_record is a flat representation of the C data
- structure associated with the corresponding graphic object. Each
- graphic object is defined by a (recursive) set of properties (see
- the <link linkend="get">get</link>) function).
- </para>
- <variablelist>
+ <refnamediv>
+ <refname>save_format</refname>
+ <refpurpose>format of files produced by "save"</refpurpose>
+ </refnamediv>
+ <refsection>
+ <title>Description</title>
+ <para>
+ Variables are saved by Scilab with the <link linkend="save">save</link> function in the following format:
+ </para>
+ <para>
+ each variable record is appended consecutively to the file. The variable record begins with 6 <literal>long integer</literal> holding the variable name in encoded format (see the Remarks section below), after that comes the variable type (<literal>long integer</literal>), then, depending on it, for:
+ </para>
+ <variablelist>
<varlistentry>
- <term>The saved serialization_record of a graphic object is
- structured as follow
- </term>
- <listitem>
- <para>type_length n (a byte)</para>
- <para>type (n bytes, the ascii codes of the type name)</para>
- <para>property_values record (variable length)</para>
- </listitem>
+ <term>Floating matrices (type 1)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ real/complex flag <varname>it</varname> (a <literal>long integer</literal> in {0,1}),
+ </para>
+ <para>
+ data (n*m*(it+1) <literal>double</literal>s)
+ </para>
+ </listitem>
</varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Strings (type 10)</term>
- <listitem>
- <para>row_size m (a long integer),</para>
- <para>column_size n (a long integer),</para>
- <para>index_table (n*m+1 long integers);</para>
- <para>data (N long integers, the Scilab encoding of the characters
- (see <link linkend="code2str">code2str</link>), where N is the value
- of the last entry of the index_table
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Uncompiled functions (type 11)</term>
- <listitem>
- <para>nout (long integer),</para>
- <para>lhs_names (6*nout long integers, see the Remarks section
- below),
- </para>
- <para>nin (long integer),</para>
- <para>rhs_names (6*nin long integers, see the Remarks section
- below);
- </para>
- <para>code_length N (a long integer),</para>
- <para>code (N long integers)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Compiled functions (type 13)</term>
- <listitem>
- <para>nout (long integer),</para>
- <para>lhs_names (6*nout long integers, see the Remarks section
- below),
- </para>
- <para>nin (long integer),</para>
- <para>rhs_names (6*nin long integers, see the Remarks section
- below),
- </para>
- <para>pseudo_code_length N (a long integer),</para>
- <para>pseudo_code (N long integers)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Libraries (type 14)</term>
- <listitem>
- <para>path_length np (a long integer),</para>
- <para>path_name (np long integers: the path character codes
- sequence, (see <link linkend="code2str">code2str</link>)),
- </para>
- <para>number of names nn (long integer),</para>
- <para>names (6*nn long integers, see the Remarks section
- below);
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Lists (type 15), tlists (type 16), mlists (type 17)</term>
- <listitem>
- <para>number of fields n (a long integer),</para>
- <para>index (n+1 long integers);</para>
- <para>variables_sequence (n variables, each one written according to
- its format)
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Pointers (type 128)</term>
- <listitem>
- <para>Not handled</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <variablelist>
- <varlistentry>
- <term>Function pointers (type 130)</term>
- <listitem>
- <para>
- function_ptr (a long integer,(see <link linkend="funptr">funptr</link>))
- </para>
- <para>function_name_code (6 long integers,see the Remarks section
- below);
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- <refsection>
- <title>Remarks</title>
- <para>Numbers (long interger, short integers, double) are stored using the
- little endian convention.
- </para>
- <para>The variable names are stored as a sequence of 6 long integers, with
- a specific encoding. see the cvname.f file for details.
- </para>
- </refsection>
- <refsection role="see also">
- <title>See Also</title>
- <simplelist type="inline">
- <member>
- <link linkend="save">save</link>
- </member>
- <member>
- <link linkend="load">load</link>
- </member>
- <member>
- <link linkend="listvarinfile">listvarinfile</link>
- </member>
- <member>
- <link linkend="type">type</link>
- </member>
- <member>
- <link linkend="typeof">typeof</link>
- </member>
- </simplelist>
- </refsection>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Polynomials (type 2) and Size implicit indices (type 129)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ real/complex flag <varname>it</varname> (long integer in {0,1}),
+ </para>
+ <para>
+ formal variable name (16 bytes),
+ </para>
+ <para>
+ <varname>index_table</varname> (m*n+1 <literal>long integer</literal>s),
+ </para>
+ <para>
+ data ((N-1)*(it+1) <literal>double</literal>s), where <varname>N</varname> is the
+ value of the last entry of the <varname>index_table</varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Booleans (type 4)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ data (n*m <literal>long integer</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Floating sparse matrices (type 5)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ real/complex_flag <varname>it</varname> (a <literal>long integer</literal> in {0,1}),
+ </para>
+ <para>
+ <varname>total_number_of_non_zero_elements</varname> <varname>nel</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>number_of_non_zero_elements_per_row</varname> (m <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>column_index_non_zero_elements</varname> (nel <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>non_zero_values</varname> (nel*(it+1) <literal>double</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Boolean sparse matrices (type 6)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ unused <varname>it</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>total_number_of_non_zero_elements</varname> <varname>nel</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>number_of_non_zero_elements_per_row</varname> (m <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>column_index_non_zero_elements</varname> (nel <literal>long integer</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Matlab sparse matrix (type 7)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ real/complex_flag <varname>it</varname> (a <literal>long integer</literal> in {0,1}),
+ </para>
+ <para>
+ <varname>total_number_of_non_zero_elements</varname> <varname>nel</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>number_of_non_zero_elements_per_column</varname> (n <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>row_index_non_zero_elements</varname> (nel <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>non_zero_values</varname> (nel*(it+1) <literal>double</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Integer matrices (type 8)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>integer_type</varname> (a <literal>long integer</literal>): 1,2,4, or 11,12,14 for signed and unsigned 1,2,4 bytes integers,
+ </para>
+ <para>
+ data (n*m bytes for <varname>integer_type</varname> 1 or 11, n*m <literal>short integer</literal>s for <varname>integer_type</varname> 2 or 12, n*m <literal>long integer</literal>s for <varname>integer_type</varname> 4 or
+ 14).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>handles (type 9)</term>
+ <listitem>
+ <para>version (4 bytes)</para>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a byte),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a byte),
+ </para>
+ <para>
+ data (m*n <varname>serialization_record</varname>s)
+ </para>
+ <para>
+ A <varname>serialization_record</varname> is a flat
+ representation of the C data structure associated with the
+ corresponding graphic object. Each graphic object is defined by
+ a (recursive) set of properties (see the <link linkend="get">get</link> function).
+ </para>
+ <para>
+ The saved <varname>serialization_record</varname> of a graphic object is structured as follow.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>serialization_record</term>
+ <listitem>
+ <para>
+ <varname>type_length</varname> <varname>n</varname> (a byte),
+ </para>
+ <para>
+ type (n bytes, the ascii codes of the type name),
+ </para>
+ <para>
+ <varname>property_values</varname> record (variable length).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Strings (type 10)</term>
+ <listitem>
+ <para>
+ <varname>row_size</varname> <varname>m</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>column_size</varname> <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>index_table</varname> (n*m+1 <literal>long integer</literal>s),
+ </para>
+ <para>
+ data (N <literal>long integer</literal>s, the Scilab encoding of the characters (see <link linkend="code2str">code2str</link>), where <varname>N</varname> is the value of the last entry of the <varname>index_table</varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Uncompiled functions (type 11)</term>
+ <listitem>
+ <para>
+ <varname>nout</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>lhs_names</varname> (6*nout <literal>long integer</literal>s, see the Remarks section below),
+ </para>
+ <para>
+ <varname>nin</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>rhs_names</varname> (6*nin <literal>long integer</literal>s, see the Remarks section below),
+ </para>
+ <para>
+ <varname>code_length</varname> <varname>N</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>code</varname> (N <literal>long integer</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Compiled functions (type 13)</term>
+ <listitem>
+ <para>
+ <varname>nout</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>lhs_names</varname> (6*nout <literal>long integer</literal>s, see the Remarks section below),
+ </para>
+ <para>
+ <varname>nin</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>rhs_names</varname> (6*nin <literal>long integer</literal>s, see the Remarks section below),
+ </para>
+ <para>
+ <varname>pseudo_code_length</varname> <varname>N</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>pseudo_code</varname> (N <literal>long integer</literal>s).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Libraries (type 14)</term>
+ <listitem>
+ <para>
+ <varname>path_length</varname> np (a <literal>long integer</literal>),
+ </para>
+ <para>
+ <varname>path_name</varname> (np <literal>long integer</literal>s: the path character codes sequence, (see <link linkend="code2str">code2str</link>)),
+ </para>
+ <para>
+ number of names nn (a <literal>long integer</literal>),
+ </para>
+ <para>
+ names (6*nn <literal>long integer</literal>s, see the Remarks section
+ below).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Lists (type 15), tlists (type 16), mlists (type 17)</term>
+ <listitem>
+ <para>
+ number of fields <varname>n</varname> (a <literal>long integer</literal>),
+ </para>
+ <para>
+ index (n+1 <literal>long integer</literal>s),
+ </para>
+ <para>
+ <varname>variables_sequence</varname> (n variables, each one written according to its format).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Pointers (type 128)</term>
+ <listitem>
+ <para>Not handled</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>Function pointers (type 130)</term>
+ <listitem>
+ <para>
+ <varname>function_ptr</varname> (a <literal>long integer</literal>, (see <link linkend="funptr">funptr</link>)),
+ </para>
+ <para>
+ <varname>function_name_code</varname> (6 <literal>long integer</literal>s, see the
+ Remarks section below).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Remarks</title>
+ <para>
+ Numbers (a <literal>long interger</literal>, <literal>short integer</literal>s, <literal>double</literal>) are stored using the
+ little endian convention.
+ </para>
+ <para>
+ The variable names are stored as a sequence of 6 <literal>long integer</literal>s, with
+ a specific encoding. See the <literal>cvname.f</literal> file for
+ details.
+ </para>
+ </refsection>
+ <refsection role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="save">save</link>
+ </member>
+ <member>
+ <link linkend="load">load</link>
+ </member>
+ <member>
+ <link linkend="listvarinfile">listvarinfile</link>
+ </member>
+ <member>
+ <link linkend="type">type</link>
+ </member>
+ <member>
+ <link linkend="typeof">typeof</link>
+ </member>
+ </simplelist>
+ </refsection>
</refentry>
*
-->
<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="scanf">
- <refnamediv>
- <refname>scanf</refname>
- <refpurpose> Converts formatted input on standard input</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <title>Calling Sequence</title>
- <synopsis>[v_1,...v_n]=scanf (format);</synopsis>
- </refsynopsisdiv>
- <refsection>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term>format</term>
- <listitem>
- <para>Specifies the format conversion.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- <refsection>
- <title>Description</title>
- <para>
- The scanf functions get character data on standard input (%io(1)), interpret it according
- to a format, and returns the converted results.
- </para>
- <para>
- The format parameter contains conversion specifications
- used to interpret the input.
- </para>
- <para>
- The format parameter can contain
- white-space characters (blanks, tabs, newline, or formfeed)
- that, except in the following two cases, read the input up to the
- next nonwhite-space character. Unless there is a match in the control
- string, trailing white space (including a newline character) is not
- read.
- </para>
- <itemizedlist>
- <listitem>
- <para>Any character except % (percent sign), which must match the next character of the input stream.</para>
- </listitem>
- <listitem>
+ <refnamediv>
+ <refname>scanf</refname>
+ <refpurpose>converts formatted input on standard input</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>[v_1, ..., v_n]=scanf(format);</synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Arguments</title>
+ <variablelist>
+ <varlistentry>
+ <term>format</term>
+ <listitem>
+ <para>specifies the format conversion.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>v_1, ..., v_n</term>
+ <listitem>
+ <para>converted results.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Description</title>
<para>
- A conversion specification that directs the conversion of the next input field. see <link linkend="scanf_conversion">scanf_conversion</link> for details.
+ The <function>scanf</function> function get character data on standard input (<code>%io(1)</code>), interprets it according
+ to a <varname>format</varname>, and returns the converted results <varname>v_1</varname>, ..., <varname>v_n</varname>.
</para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection role="see also">
- <title>See Also</title>
- <simplelist type="inline">
- <member>
- <link linkend="printf">printf</link>
- </member>
- <member>
- <link linkend="read">read</link>
- </member>
- <member>
- <link linkend="fscanf">fscanf</link>
- </member>
- <member>
- <link linkend="sscanf">sscanf</link>
- </member>
- <member>
- <link linkend="scanf_conversion">scanf_conversion</link>
- </member>
- </simplelist>
- </refsection>
+ <para>
+ The <varname>format</varname> parameter contains conversion specifications
+ used to interpret the input.
+ </para>
+ <para>
+ The <varname>format</varname> parameter can contain
+ white-space characters (blanks, tabs, newline, or formfeed)
+ that, except in the following two cases, read the input up to the
+ next nonwhite-space character. Unless there is a match in the control
+ string, trailing white-space (including a newline character) is not
+ read.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Any character except <literal>%</literal> (percent sign), which must match the next character of the input stream.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A conversion specification that directs the conversion of the next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </refsection>
+ <refsection role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="read">read</link>
+ </member>
+ <member>
+ <link linkend="fscanf">fscanf</link>
+ </member>
+ <member>
+ <link linkend="scanf_conversion">scanf_conversion</link>
+ </member>
+ </simplelist>
+ </refsection>
</refentry>
*
-->
<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="scanf_conversion">
- <refnamediv>
- <refname>scanf_conversion</refname>
- <refpurpose> scanf, sscanf, fscanf conversion specifications</refpurpose>
- </refnamediv>
- <refsection>
- <title>Description</title>
- <para>
- Each conversion specification in the format parameter
- contains the following elements:
- </para>
- <variablelist>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>The character % (percent sign)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>The optional assignment suppression character *</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>An optional numeric maximum field width</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>A conversion code</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- The conversion specification has the following syntax:
- </para>
- <para>
- <literal>[*][width][size]convcode</literal>.
- </para>
- <para>
- The results from the conversion are placed in v_i arguments
- unless you specify assignment suppression with * (asterisk). Assignment
- suppression provides a way to describe an input field that is to be
- skipped. The input field is a string of nonwhite-space characters.
- It extends to the next inappropriate character or until the field
- width, if specified, is exhausted.
- </para>
- <para>
- The conversion code indicates how to interpret the input field.
- You should not specify the v_i parameter for a
- suppressed field. You can use the following conversion codes:
- </para>
- <variablelist>
- <varlistentry>
- <term>%</term>
- <listitem>
- <para>Accepts a single % (percent sign) input at this point; no assignment is done.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>d, i</term>
- <listitem>
- <para>Accepts a decimal integer;</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>u</term>
- <listitem>
- <para>Accepts an unsigned decimal integer;</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>o</term>
- <listitem>
- <para>Accepts an octal integer;</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>x</term>
- <listitem>
- <para>Accepts a hexadecimal integer;</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>e,f,g</term>
- <listitem>
- <para>Accepts a floating-point number. The next field is converted accordingly and stored through the corresponding parameter, which should be a pointer to a float. The input format for floating-point numbers is a string of digits, with the following optional characteristics:</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>It can be a signed value.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>It can be an exponential value, containing a decimal point followed by an exponent field, which consists of an E or an e followed by an (optionally signed) integer.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>+</term>
- <listitem>
- <para>It can be one of the special values INF, NaN,</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>s</term>
- <listitem>
- <para>Accepts a string of characters.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>c</term>
- <listitem>
- <para>character value is expected. The normal skip over white space is suppressed.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>%lg</term>
- <listitem>
- <para> get value as a double.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- <refsection role="see also">
- <title>See Also</title>
- <simplelist type="inline">
- <member>
- <link linkend="scanf">scanf</link>
- </member>
- <member>
- <link linkend="scanf">scanf</link>
- </member>
- <member>
- <link linkend="fscanf">fscanf</link>
- </member>
- </simplelist>
- </refsection>
+ <refnamediv>
+ <refname>scanf_conversion</refname>
+ <refpurpose> mscanf, msscanf, mfscanf conversion specifications</refpurpose>
+ </refnamediv>
+ <refsection>
+ <title>Description</title>
+ <para>
+ Each conversion specification in the <varname>format</varname> parameter contains the following elements:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ the character <literal>%</literal> (percent sign);
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the optional assignment suppression character <literal>*</literal> (asterisk);
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ an optional numeric maximum field width;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ a conversion code.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The conversion specification has the following syntax:
+ </para>
+ <para>
+ <literal>[*][width][size]convcode</literal>.
+ </para>
+ <para>
+ The results from the conversion are placed in <varname>v_i</varname> arguments unless you specify assignment suppression with <literal>*</literal> (asterisk). Assignment suppression provides a way to describe an input field that is to be skipped. The input field is a string of nonwhite-space characters. It extends to the next inappropriate character or until the field width, if specified, is exhausted.
+ </para>
+ <para>
+ The conversion code indicates how to interpret the input field.
+ You should not specify the <varname>v_i</varname> parameter for a
+ suppressed field. You can use the following conversion codes:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>%</term>
+ <listitem>
+ <para>
+ accepts a single <literal>%</literal> (percent sign) input at this point; no assignment is done.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>d, i</term>
+ <listitem>
+ <para>accepts a decimal integer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>u</term>
+ <listitem>
+ <para>accepts an unsigned decimal integer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>o</term>
+ <listitem>
+ <para>accepts an octal integer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>x</term>
+ <listitem>
+ <para>accepts a hexadecimal integer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>e, f, g</term>
+ <listitem>
+ <para>
+ accepts a floating-point number. The next field is converted accordingly and stored through the corresponding parameter, which should be a pointer to a float. The input format for floating-point numbers is a string of digits, with the following optional characteristics:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ it can be a signed value;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ It can be an exponential value, containing a decimal point followed by an exponent field, which consists of an <literal>E</literal> or an <literal>e</literal> followed by an (optionally signed) integer;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ it can be one of the special values <constant>%inf</constant>, <constant>%nan</constant>;
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>s</term>
+ <listitem>
+ <para>accepts a string of characters.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>c</term>
+ <listitem>
+ <para>
+ character value is expected. The normal skip over white-space is suppressed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>%lg</term>
+ <listitem>
+ <para>gets value as a double.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="scanf">mcscanf</link>
+ </member>
+ <member>
+ <link linkend="printf_conversion">printf_conversion</link>
+ </member>
+ </simplelist>
+ </refsection>
</refentry>
*
-->
<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="sscanf">
- <refnamediv>
- <refname>sscanf</refname>
- <refpurpose> Converts formatted input given by a string</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <title>Calling Sequence</title>
- <synopsis>[v_1,...v_n]=sscanf (string,format)</synopsis>
- </refsynopsisdiv>
- <refsection>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term>format</term>
- <listitem>
- <para>Specifies the format conversion.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string</term>
- <listitem>
- <para>Specifies input to be read.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- <refsection>
- <title>Description</title>
- <para>
- This function is obsolete, use preferably the <literal>msscanf</literal>
- function which is more efficient and is more compatible with the C
- <literal>sscanf</literal> procedure.
- </para>
- <para>
- The sscanf functions interpret character string according
- to a format, and returns the converted results.
- </para>
- <para>
- The format parameter contains conversion specifications
- used to interpret the input.
- </para>
- <para>
- The format parameter can contain
- white-space characters (blanks, tabs, newline, or formfeed)
- that, except in the following two cases, read the input up to the
- next nonwhite-space character. Unless there is a match in the control
- string, trailing white space (including a newline character) is not
- read.
- </para>
- <itemizedlist>
- <listitem>
- <para>Any character except % (percent sign), which must match the next character of the input stream.</para>
- </listitem>
- <listitem>
+ <refnamediv>
+ <refname>sscanf</refname>
+ <refpurpose>
+ converts formatted input given by a string (<emphasis role="bold">this function is obsolete)</emphasis>
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>[v_1, ..., v_n]=sscanf(string, format)</synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Arguments</title>
+ <variablelist>
+ <varlistentry>
+ <term>format</term>
+ <listitem>
+ <para>specifies the format conversion.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>string</term>
+ <listitem>
+ <para>specifies input to be read.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>v_1, ..., v_n</term>
+ <listitem>
+ <para>converted results.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Description</title>
<para>
- A conversion specification that directs the conversion of the next input field. see <link linkend="scanf_conversion">scanf_conversion</link> for details.
+ <warning>
+ This function is obsolete, use preferably the
+ <function>msscanf</function> function which is more efficient and
+ is more compatible with the C <function>sscanf</function>
+ procedure.
+ </warning>
</para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection role="see also">
- <title>See Also</title>
- <simplelist type="inline">
- <member>
- <link linkend="mprintf">mprintf</link>
- </member>
- <member>
- <link linkend="msscanf">msscanf</link>
- </member>
- <member>
- <link linkend="mfscanf">mfscanf</link>
- </member>
- <member>
- <link linkend="scanf_conversion">scanf_conversion</link>
- </member>
- </simplelist>
- </refsection>
+ <para>
+ The <function>sscanf</function> function interprets character string
+ according to a <varname>format</varname>, and returns the converted
+ results <varname>v_1</varname>, ..., <varname>v_n</varname>.
+ </para>
+ <para>
+ The <varname>format</varname> parameter contains conversion
+ specifications used to interpret the input.
+ </para>
+ <para>
+ The <varname>format</varname> parameter can contain
+ white-space characters (blanks, tabs, newline, or formfeed)
+ that, except in the following two cases, read the input up to the
+ next nonwhite-space character. Unless there is a match in the control
+ string, trailing white-space (including a newline character) is not
+ read.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Any character except <literal>%</literal> (percent sign), which
+ must match the next character of the input stream.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A conversion specification that directs the conversion of the
+ next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </refsection>
+ <refsection role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="mprintf">mprintf</link>
+ </member>
+ <member>
+ <link linkend="mfscanf">mfscanf</link>
+ </member>
+ <member>
+ <link linkend="scanf_conversion">scanf_conversion</link>
+ </member>
+ </simplelist>
+ </refsection>
</refentry>
projects / scilab.git / commitdiff