* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:id="api_common" xml:lang="en">
+<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"
+ xmlns:scilab="http://www.scilab.org" xml:id="api_common" xml:lang="en">
<refnamediv>
<refname>API common functions</refname>
<para>This page lists all the functions to get information about Scilab native objects.</para>
</para>
</refsection>
<refsection>
- <literallayout>
+ <literal>
int <varname>scilab_isDouble</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isBoolean</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isString</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isInt</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isPoly</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isList</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isTList</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isMList</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isHandle</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isStruct</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isCell</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isPointer</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
- </literallayout>
+ </literal>
+ <para/>
<para>
Return 1 if variable <varname>var</varname> has the right type.
</para>
<para>Return 1 for matrix with 2 dimensions and dimensions have the same size.</para>
</refsection>
<refsection id="api_common_scilab_isVector">
- <literallayout>
+ <literal>
int <varname>scilab_isVector</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isNVector</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var, int n)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isRowVector</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isColVector</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
- </literallayout>
+ </literal>
+ <para/>
<para>
Use to check if variable <varname>var</varname> is a vector. <varname>n</varname> is the dimension to check, <code>scilab_isRowVector</code> is equivalente to <code>scilab_isNVector(env, var, 1)</code>
</para>
* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:id="api_integer" xml:lang="en">
+<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"
+ xmlns:scilab="http://www.scilab.org" xml:id="api_integer" xml:lang="en">
<refnamediv>
<refname>API integer functions</refname>
<para>This page lists all the functions to manipulate Scilab native objects containing integers</para>
</para>
</refsection>
<refsection id="api_integer_scilab_isInt">
- <literallayout>
+ <literal>
int <varname>scilab_isInt8</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isInt16</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isInt32</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isInt64</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isUnsignedInt8</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isUnsignedInt16</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isUnsignedInt32</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
+ </literal>
+ <para/>
+ <literal>
int <varname>scilab_isUnsignedInt64</varname>(
<link linkend="api_types_scilabEnv">
<command>scilabEnv</command>
<command>scilabVar</command>
</link>
var)
- </literallayout>
+ </literal>
<para>
Return 1 if variable <varname>val</varname> is an integer otherwise 0. Precision is specified in function name.
</para>
</refsection>
<refsection id="api_integer_scilab_createInteger">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, char val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, short val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, long long val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, unsigned char val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, unsigned short val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, unsigned int val)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, unsigned long long val)
- </literallayout>
+ </literal>
<para>
Create a scalar integer from <varname>val</varname>. Precision is specified in function name.
</para>
Create an integer matrix with <varname>dim</varname> dimensions (<varname>dims</varname>[0], <varname>dims</varname>[1], ..., <varname>dims</varname>[<varname>dim</varname>-1]).
</para>
<para>
- <varname>prec</varname> parameter give precision of integer :
+ The <varname>prec</varname> parameter specifies the integer precision :
+ <table>
+ <tr>
+ <td>
+ <table>
+ <tr><td><emphasis role="bold">SCI_INT8</emphasis></td><td>: integer 8-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_INT16</emphasis></td><td>: Integer 16-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_INT32</emphasis></td><td>: Integer 32-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_INT64</emphasis></td><td>: Integer 64-bits</td></tr>
+ </table>
+ </td>
+ <td>
+ </td>
+ <td>
+ <table>
+ <tr><td><emphasis role="bold">SCI_UINT8</emphasis></td><td>: Unsigned integer 8-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_UINT16</emphasis></td><td>: Unsigned integer 16-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_UINT32</emphasis></td><td>: Unsigned integer 32-bits</td></tr>
+ <tr><td><emphasis role="bold">SCI_UINT64</emphasis></td><td>: Unsigned integer 64-bits</td></tr>
+ </table>
+ </td>
+ </tr>
+ </table>
</para>
- <variablelist>
- <varlistentry>
- <term>SCI_INT8</term>
- <listitem>
- <para>integer 8-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_INT16</term>
- <listitem>
- <para>Integer 16-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_INT32</term>
- <listitem>
- <para>Integer 32-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_INT64</term>
- <listitem>
- <para>Integer 64-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_UINT8</term>
- <listitem>
- <para>Unsigned integer 8-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_UINT16</term>
- <listitem>
- <para>Unsigned integer 16-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_UINT32</term>
- <listitem>
- <para>Unsigned integer 32-bits</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SCI_UINT64</term>
- <listitem>
- <para>Unsigned integer 64-bits</para>
- </listitem>
- </varlistentry>
- </variablelist>
</refsection>
<refsection id="api_integer_scilab_createIntegerXXMatrix">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int prec, int dim, const int* dims)
- </literallayout>
+ </literal>
<para>
Create an integer matrix with <varname>dim</varname> dimensions (<varname>dims</varname>[0], <varname>dims</varname>[1], ..., <varname>dims</varname>[<varname>dim</varname>-1]). Precision is specified in function name.
</para>
</para>
</refsection>
<refsection id="api_integer_scilab_createIntegerXXMatrix2d">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabVar">
<command>scilabVar</command>
</link>
<command>scilabEnv</command>
</link>
env, int row, int col)
- </literallayout>
+ </literal>
<para>
Create an integer matrix with 2 dimensions (<varname>row</varname>, <varname>col</varname>). Precision is specified in function name.
</para>
</refsection>
<refsection id="api_integer_scilab_getInteger">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, char* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, short* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, int* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, long long* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned char* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned short* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned int* vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned long long* vals)
- </literallayout>
+ </literal>
<para>Get integer value from an scalar integer variable. Precision is specified in function name.</para>
<para>
precision of output must match with precision of <varname>var</varname>.
</para>
</refsection>
<refsection id="api_integer_scilab_getIntegerArray">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, void** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, char** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, short** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, int** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, long long** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned char** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned short** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned int** vals)
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, unsigned long long** vals)
- </literallayout>
+ </literal>
<para>
Get pointer on internal array of integer of <varname>var</varname>.
</para>
</refsection>
<refsection id="api_integer_scilab_setIntegerArray">
- <literallayout>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const void* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const char* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const short* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const int* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const long long* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const unsigned char* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const unsigned short* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const unsigned int* vals);
+ </literal>
+ <para/>
+ <literal>
<link linkend="api_types_scilabStatus">
<command>scilabStatus</command>
</link>
<command>scilabVar</command>
</link>
var, const unsigned long long* vals);
- </literallayout>
+ </literal>
<para>
Set values of integer variable <varname>var</varname>.
</para>
* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="rowinout">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="rowinout">
<refnamediv>
<refname>rowinout</refname>
<refpurpose>inner-outer factorization</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[Inn,X,Gbar]=rowinout(G)</synopsis>
+ <synopsis>[Inn, X, Gbar] = rowinout(G)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<para>
<literal>G</literal> admits the following inner-outer factorization:
</para>
- <programlisting role=""><![CDATA[
+ <screen><![CDATA[
G = [ Inn ] | Gbar |
| 0 |
- ]]></programlisting>
+]]></screen>
<para>
where <literal>Inn</literal> is square and inner (all pass and stable) and <literal>Gbar</literal>
square and outer i.e:
<para>
Note that:
</para>
- <programlisting role=""><![CDATA[
+ <screen><![CDATA[
[ Gbar ]
X*G = [ - ]
[ 0 ]
- ]]></programlisting>
+]]></screen>
<para>
- is a row compression of <literal>G</literal> where <literal>X</literal> = <literal>Inn</literal> inverse is all-pass i.e:
- </para>
- <programlisting role=""><![CDATA[
- T
-X (-s) X(s) = Identity
- ]]></programlisting>
- <para>
- (for the continuous time case).
+ is a row compression of <literal>G</literal> where <literal>X</literal> = <literal>Inn</literal>
+ inverse is all-pass i.e: <literal>X<superscript>t</superscript>(-s).X(s) = Identity</literal>
+ (for the continuous time case).
</para>
</refsection>
<refsection role="see also">
* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="rowinout">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ja" xml:id="rowinout">
<refnamediv>
<refname>rowinout</refname>
<refpurpose>インナ-アウタ分解</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>呼び出し手順</title>
- <synopsis>[Inn,X,Gbar]=rowinout(G)</synopsis>
+ <synopsis>[Inn, X, Gbar] = rowinout(G)</synopsis>
</refsynopsisdiv>
<refsection>
<title>パラメータ</title>
<para>
<literal>G</literal> は以下のアウタ-インナ分解を許容します:
</para>
- <programlisting role=""><![CDATA[
+ <screen><![CDATA[
G = [ Inn ] | Gbar |
| 0 |
- ]]></programlisting>
+]]></screen>
<para>
ただし <literal>Inn</literal> は正方行列の
インナ (全通過で安定),
<para>
注意:
</para>
- <programlisting role=""><![CDATA[
+ <screen><![CDATA[
[ Gbar ]
X*G = [ - ]
[ 0 ]
- ]]></programlisting>
+]]></screen>
<para>
は <literal>G</literal> の行圧縮です.
ただし, <literal>X</literal> = <literal>Inn</literal>
の逆行列は全通過特性を有します.すなわち:
- </para>
- <programlisting role=""><![CDATA[
- T
-X (-s) X(s) = Identity
- ]]></programlisting>
- <para>
+ <literal>X<superscript>t</superscript>(-s).X(s) = Identity</literal>
(連続時間系の場合).
</para>
</refsection>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fromc">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="fromc">
<refnamediv>
<refname>fromc</refname>
<refpurpose>Checks if current Scilab is called from an external C program (by StartScilab).</refpurpose>
<member>
<link linkend="fromjava">fromjava</link>
</member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
+ <link linkend="getscilabmode">getscilabmode</link>
+ </member>
</simplelist>
</refsection>
</refentry>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fromjava">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="fromjava">
<refnamediv>
<refname>fromjava</refname>
<refpurpose>Checks if current Scilab is called from javasci</refpurpose>
<member>
<link linkend="fromc">fromc</link>
</member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
+ <link linkend="getscilabmode">getscilabmode</link>
+ </member>
</simplelist>
</refsection>
</refentry>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getscilabmode">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="getscilabmode">
<refnamediv>
<refname>getscilabmode</refname>
<refpurpose>returns scilab mode</refpurpose>
<title>See also</title>
<simplelist type="inline">
<member>
+ <link linkend="fromc">fromc</link>
+ </member>
+ <member>
+ <link linkend="fromjava">fromjava</link>
+ </member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
<link linkend="scilab">scilab</link>
</member>
</simplelist>
<title>See also</title>
<simplelist type="inline">
<member>
+ <link linkend="tempname">tempname</link>
+ </member>
+ <member>
<link linkend="home">home</link>
</member>
<member>
<title>Voir aussi</title>
<simplelist type="inline">
<member>
+ <link linkend="tempname">tempname</link>
+ </member>
+ <member>
<link linkend="home">home</link>
</member>
<member>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getscilabmode">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ja" xml:id="getscilabmode">
<refnamediv>
<refname>getscilabmode</refname>
<refpurpose>Scilabモードを取得</refpurpose>
<title>参照</title>
<simplelist type="inline">
<member>
+ <link linkend="fromc">fromc</link>
+ </member>
+ <member>
+ <link linkend="fromjava">fromjava</link>
+ </member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
<link linkend="scilab">scilab</link>
</member>
</simplelist>
<title>参照</title>
<simplelist type="inline">
<member>
+ <link linkend="tempname">tempname</link>
+ </member>
+ <member>
<link linkend="home">home</link>
</member>
<member>
<?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:ns4="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="getscilabmode" xml:lang="pt">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="getscilabmode" xml:lang="pt">
<refnamediv>
<refname>getscilabmode</refname>
<refpurpose>retorna o modo do Scilab</refpurpose>
<title>Ver Também</title>
<simplelist type="inline">
<member>
+ <link linkend="fromc">fromc</link>
+ </member>
+ <member>
+ <link linkend="fromjava">fromjava</link>
+ </member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
<link linkend="scilab">scilab</link>
</member>
</simplelist>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="getscilabmode">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ru" xml:id="getscilabmode">
<refnamediv>
<refname>getscilabmode</refname>
<refpurpose>возвращает режим работы Scilab</refpurpose>
<title>Смотрите также</title>
<simplelist type="inline">
<member>
+ <link linkend="fromc">fromc</link>
+ </member>
+ <member>
+ <link linkend="fromjava">fromjava</link>
+ </member>
+ <member>
+ <link linkend="istssession">istssession</link>
+ </member>
+ <member>
<link linkend="scilab">scilab</link>
</member>
</simplelist>
<para>
Временные директории создаются в виде поддиректорий системной временной директории
и получают имя <literal>SCI_TMP_</literal><unique>, где
- <unique> -- некоторый номер, формируемый при запуске Scilab для того, чтобы
+ <unique> - некоторый номер, формируемый при запуске Scilab для того, чтобы
имя было уникальным. Под GNU/Linux, UNIX и Mac OS X права доступа к директории ограничены
для пользователя Scilab'а.
</para>
<title>Смотрите также</title>
<simplelist type="inline">
<member>
+ <link linkend="tempname">tempname</link>
+ </member>
+ <member>
<link linkend="home">home</link>
</member>
<member>
execution (<literal>LONG TIME EXECUTION</literal>) flag.
</para>
</refsection>
+ <refsection role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="debug">debug</link>
+ </member>
+ <member>
+ <link linkend="covStart">covStart</link>
+ </member>
+ <member>
+ <link linkend="profile">profile</link>
+ </member>
+ <member>
+ <link linkend="slint">slint</link>
+ </member>
+ <member>
+ <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx">
+ List of MS Windows exit codes
+ </ulink>
+ </member>
+ </simplelist>
+ </refsection>
+
<refsection>
<title>History</title>
<revhistory>
<literal>LONG TIME EXECUTION</literal>.
</para>
</refsection>
+ <refsection role="see also">
+ <title>Voir aussi</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="debug">debug</link>
+ </member>
+ <member>
+ <link linkend="covStart">covStart</link>
+ </member>
+ <member>
+ <link linkend="profile">profile</link>
+ </member>
+ <member>
+ <link linkend="slint">slint</link>
+ </member>
+ <member>
+ <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx">
+ Liste des codes de résultat d'exécution de MS Windows
+ </ulink>
+ </member>
+ </simplelist>
+ </refsection>
<refsection>
<title>Historique</title>
<revhistory>
execution (<literal>LONG TIME EXECUTION</literal>) flag.
</para>
</refsection>
+ <refsection role="see also">
+ <title>参照</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="debug">debug</link>
+ </member>
+ <member>
+ <link linkend="covStart">covStart</link>
+ </member>
+ <member>
+ <link linkend="profile">profile</link>
+ </member>
+ <member>
+ <link linkend="slint">slint</link>
+ </member>
+ <member>
+ <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx">
+ List of MS Windows exit codes
+ </ulink>
+ </member>
+ </simplelist>
+ </refsection>
<refsection>
<title>履歴</title>
<revhistory>
xmlns:scilab="http://www.scilab.org" xml:id="primes" xml:lang="en">
<refnamediv>
<refname>primes</refname>
- <refpurpose>primes function</refpurpose>
+ <refpurpose>lists of primes up to a given number</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[y]=primes(x)</synopsis>
+ <synopsis>y = primes(x)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<title>Description</title>
<para>
Given a real <literal>x</literal>, <literal>primes(x)</literal>
- returns in a vector <literal>y</literal> all the primes numbers included
- between 1 and <literal>x</literal>. If <literal>x<2</literal> then
+ returns in a vector <literal>y</literal> all the prime numbers in
+ <literal>[2, x]</literal>. If <literal>x<2</literal> then
<literal>primes(x)</literal> returns an empty matrix.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
-x=35
-y=primes(x)
- ]]></programlisting>
+primes(35)
+ ]]></programlisting>
+ <screen><![CDATA[
+--> primes(35)
+ ans =
+ 2. 3. 5. 7. 11. 13. 17. 19. 23. 29. 31.
+]]></screen>
</refsection>
<refsection role="see also">
<title>See also</title>
<title>呼び出し手順</title>
- <synopsis>[y]=primes(x)</synopsis>
+ <synopsis>y = primes(x)</synopsis>
</refsynopsisdiv>
<title>例</title>
<programlisting role="example"><![CDATA[
-x=35
-y=primes(x)
- ]]></programlisting>
+primes(35)
+ ]]></programlisting>
+ <screen><![CDATA[
+--> primes(35)
+ ans =
+ 2. 3. 5. 7. 11. 13. 17. 19. 23. 29. 31.
+]]></screen>
</refsection>
<refsection>
<title>Exemplos</title>
<programlisting role="example"><![CDATA[
-x=35
-y=primes(x)
- ]]></programlisting>
+primes(35)
+ ]]></programlisting>
+ <screen><![CDATA[
+--> primes(35)
+ ans =
+ 2. 3. 5. 7. 11. 13. 17. 19. 23. 29. 31.
+]]></screen>
</refsection>
<refsection role="see also">
<title>Ver Também</title>
* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:id="primes" xml:lang="ru">
+<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"
+ xmlns:scilab="http://www.scilab.org" xml:id="primes" xml:lang="ru">
<refnamediv>
<refname>primes</refname>
<refpurpose>функция простых чисел</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Синтаксис</title>
- <synopsis>[y]=primes(x)</synopsis>
+ <synopsis>y = primes(x)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Аргументы</title>
<refsection>
<title>Описание</title>
<para>
- Для заданного вещественного числа <literal>x</literal> функция <literal>primes(x)</literal> возвращает в векторе <literal>y</literal> все простые числа, входящие в интервал между 1 и <literal>x</literal> (включительно). Если <literal>x<2 </literal>, то <literal>primes(x)</literal> возвращает пустую матрицу.
+ Для заданного вещественного числа <literal>x</literal> функция
+ <literal>primes(x)</literal> возвращает в векторе <literal>y</literal> все простые
+ числа, входящие в интервал между 1 и <literal>x</literal> (включительно).
+ Если <literal>x<2 </literal>, то <literal>primes(x)</literal> возвращает пустую матрицу.
</para>
</refsection>
<refsection>
<title>Примеры</title>
<programlisting role="example"><![CDATA[
-x=35
-y=primes(x)
- ]]></programlisting>
+primes(35)
+ ]]></programlisting>
+ <screen><![CDATA[
+--> primes(35)
+ ans =
+ 2. 3. 5. 7. 11. 13. 17. 19. 23. 29. 31.
+]]></screen>
</refsection>
<refsection role="see also">
<title>Смотрите также</title>
*
*
-->
-<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="jcompile">
+<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="jcompile">
<refnamediv>
<refname>jcompile</refname>
<refpurpose>Compile Java code or file</refpurpose>
<refsection>
<title>Description</title>
<para>
- Compile Java source code and load the corresponding class. If the package tools.jar, distributed with JDK, is not in the classpath, the Eclipse Compiler for Java (ECJ) will be used.
+ Compile Java source code and load the corresponding class. If the package tools.jar
+ distributed with JDK is not in the classpath, the Eclipse Compiler for Java (ECJ)
+ will be used.
</para>
<para>If the argument is a file, jcompile will compile the Java code.</para>
+ <note>
+ *.class files generated by the compilation are stored in the TMPDIR/JIMS/bin
+ directory.
+ </note>
</refsection>
<refsection>
<title>Examples</title>
<member>
<link linkend="jimport">jimport</link>
</member>
+ <member>
+ <link linkend="jallowClassReloading">jallowClassReloading</link>
+ </member>
+ <member>
+ <link linkend="jdeff">jdeff</link>
+ </member>
+ <member>
+ <link linkend="javasci">javasci</link>
+ </member>
+ <member>
+ <link linkend="compile_and_run_javasci_v2">javasci v2</link>
+ </member>
+ <member>
+ <link linkend="javaclasspath">javaclasspath</link>
+ </member>
</simplelist>
</refsection>
<refsection>
*
-->
-<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="ja" xml:id="jcompile">
+<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="ja" xml:id="jcompile">
<refnamediv>
引数がファイルの場合, jcompile はJavaコードをコンパイルします.
</para>
+ <note>
+ *.class files generated by the compilation are stored in the TMPDIR/JIMS/bin
+ directory.
+ </note>
</refsection>
<title>参照</title>
<simplelist type="inline">
-
<member>
-
<link linkend="jimport">jimport</link>
-
</member>
-
+ <member>
+ <link linkend="jallowClassReloading">jallowClassReloading</link>
+ </member>
+ <member>
+ <link linkend="jdeff">jdeff</link>
+ </member>
+ <member>
+ <link linkend="javasci">javasci</link>
+ </member>
+ <member>
+ <link linkend="compile_and_run_javasci_v2">javasci v2</link>
+ </member>
+ <member>
+ <link linkend="javaclasspath">javaclasspath</link>
+ </member>
</simplelist>
</refsection>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+*
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
+*
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+*
+*
+-->
+<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="ru" xml:id="jcompile">
+ <refnamediv>
+ <refname>jcompile</refname>
+ <refpurpose>Компилирует код или файл Java</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Синтаксис</title>
+ <synopsis>
+ class = jcompile(className, code);
+ class = jcompile(javaFiles);
+ </synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Аргументы</title>
+ <variablelist>
+ <varlistentry>
+ <term>className</term>
+ <listitem>
+ <para>Строка, указывающая имя класса.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>code</term>
+ <listitem>
+ <para>Строка или столбец строковых значений, содержащих код Java.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>javaFiles</term>
+ <listitem>
+ <para>Путь до файлов Java.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>class</term>
+ <listitem>
+ <para>Типизированный список типа _JClass</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Описание</title>
+ <para>
+ Компилирует исходный код Java и загружает соответствующий класс.
+ Если пакет <literal>tools.jar</literal>, распространяемый с JDK, не находится в пути
+ класса, то будет использоваться Eclipse Compiler for Java (ECJ).
+ </para>
+ <para>
+ Если аргумент файл, то <literal>jcompile</literal> будет компилировать код Java.
+ </para>
+ <note>
+ Файлы <literal>*.class</literal>, генерируемые при компиляции, хранятся в директории
+ <literal>TMPDIR/JIMS/bin</literal>.
+ </note>
+ </refsection>
+ <refsection>
+ <title>Примеры</title>
+ <programlisting role="example"><![CDATA[
+ hw = jcompile("HelloWorld", ["public class HelloWorld {"
+ "public static String getHello() {"
+ "return ""Hello World !!"";"
+ "}"
+ "}"]);
+
+ hello = hw.getHello()
+
+ jremove hello hw
+ ]]></programlisting>
+ <programlisting role="example"><![CDATA[
+fd = mopen(TMPDIR+'/HelloWorld.java','wt');
+mputl(["public class HelloWorld {"
+ "public static String getHello() {"
+ "return ""Hello World !!"";"
+ "}"
+ "}"],fd);
+mclose(fd);
+
+jcompile(TMPDIR+"/HelloWorld.java")
+ ]]></programlisting>
+ <programlisting role="example"><![CDATA[
+directory=SCI+"/modules/external_objects_java/examples/com/foo/";
+// Compile of all them
+jcompile(ls(directory + "/*.java"))
+ ]]></programlisting>
+ </refsection>
+ <refsection role="see also">
+ <title>Смотрите также</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="jimport">jimport</link>
+ </member>
+ <member>
+ <link linkend="jallowClassReloading">jallowClassReloading</link>
+ </member>
+ <member>
+ <link linkend="jdeff">jdeff</link>
+ </member>
+ <member>
+ <link linkend="javasci">javasci</link>
+ </member>
+ <member>
+ <link linkend="compile_and_run_javasci_v2">javasci v2</link>
+ </member>
+ <member>
+ <link linkend="javaclasspath">javaclasspath</link>
+ </member>
+ </simplelist>
+ </refsection>
+ <refsection>
+ <title>История</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.5.0</revnumber>
+ <revremark>
+ Функция введена. Основана на модуле 'JIMS'. Главным отличием в поведении по
+ сравнению с модулем JIMS в том, что
+ <link linkend="jautoUnwrap">jautoUnwrap</link> включена по умолчанию.
+ </revremark>
+ </revision>
+ </revhistory>
+ </refsection>
+</refentry>
only the surface's mesh.
</listitem>
<listitem>
- <literal>color_mode < 0</literal> displays facets bodies and
+ <literal>color_mode > 0</literal> displays facets bodies and
edges.
</listitem>
<listitem>
- <literal>color_mode > 0</literal> hides the mesh and displays
+ <literal>color_mode < 0</literal> hides the mesh and displays
only facets bodies.
</listitem>
</itemizedlist>
<term>Cformat</term>
<listitem>
<para>
- word providing a C-format formatting the display of graduated values along the colorbar. The formatting syntaxes are described in
- <link linkend="printf_conversion">this page</link>.
+ word providing a C-format formatting the display of graduated values
+ along the colorbar. The formatting syntaxes are described in the
+ <link linkend="printf_conversion">printf_conversion</link> page.
</para>
</listitem>
</varlistentry>
<tr>
<th>on</th><td align="center">on</td>
<td align="center">off</td>
- <td>X, Y sont Z are isométriques</td>
+ <td>X, Y et Z sont isométriques</td>
</tr>
<tr>
<th>off</th><td align="center">off</td>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="show_window">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="fr" xml:id="show_window">
<refnamediv>
<refname>show_window</refname>
- <refpurpose>met la fenêtre une au premier plan</refpurpose>
+ <refpurpose>amène une fenêtre graphique au premier plan</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Séquence d'appel</title>
- <synopsis>show_window([figure])</synopsis>
+ <synopsis>
+ show_window()
+ show_window(figure)
+ </synopsis>
</refsynopsisdiv>
<refsection>
<title>Paramètres</title>
<varlistentry>
<term>figure</term>
<listitem>
- <para>identifiant ou handle de la figure à mettre au premier plan.</para>
+ <para>identifiant ou handle de la fenêtre à mettre au premier plan.</para>
</listitem>
</varlistentry>
</variablelist>
<refsection>
<title>Description</title>
<para>
- Avec un paramètre,<literal>show_window</literal>met la fenêtre spécifiée au premier plan,
+ Avec un paramètre, <literal>show_window</literal >met la fenêtre spécifiée au premier plan,
qu'elle soit iconifiée ou non. Sinon, met la fenêtre courante au premier plan.
- Une fenêtre est crée si aucune n'existait auparavant.
+ Une fenêtre est créée si aucune n'existait auparavant.
</para>
</refsection>
</refentry>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getvalue">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="getvalue">
<refnamediv>
<refname>getvalue</refname>
<refpurpose>xwindow dialog for data acquisition</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)</synopsis>
+ <synopsis>[ok, x1,..,x14] = getvalue(desc, labels, typ, ini)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<varlistentry>
<term>desc</term>
<listitem>
- <para>column vector of strings, dialog general comment</para>
+ <para>
+ column vector of strings, dialog general comment. Any "<" character
+ must be replaced with "&lt;".
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>labels</term>
<listitem>
<para>
- n column vector of strings, <literal>labels(i)</literal> is the label of the ith required value
+ n column vector of strings, <literal>labels(i)</literal> is the label of
+ the ith required value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>typ_i</term>
<listitem>
- <para>defines the type of the ith value, may have the following values:</para>
- <variablelist>
- <varlistentry>
- <term>"mat" </term>
- <listitem>
- <para>for constant matrix</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"col" </term>
- <listitem>
- <para>for constant column vector</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"row" </term>
- <listitem>
- <para>for constant row vector</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"vec" </term>
- <listitem>
- <para>for constant vector</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"intvec" </term>
- <listitem>
- <para>for constant vector with integer values i.e int(x) == x</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"str" </term>
- <listitem>
- <para>for string</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"lis" </term>
- <listitem>
- <para>for list</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <para>defines the type of the ith value. By default, inputs are
+ interpreted as decimal numbers. Columns of (rows of) values must
+ be separated with ";". typ_i may have the following values:</para>
+ <table>
+ <tr><th>"mat"</th><td>matrix</td></tr>
+ <tr><th>"col"</th><td>column vector</td></tr>
+ <tr><th>"row"</th><td>row vector</td></tr>
+ <tr><th>"vec"</th><td>vector (free orientation)</td></tr>
+ <tr><th>"intvec"</th><td>scalar, vector or matrix of integers.</td></tr>
+ <tr><th>"str"</th><td>scalar, vector or matrix of texts, delimited with ".."</td></tr>
+ <tr><th>"lis"</th><td>list: not implemented.</td></tr>
+ </table>
</listitem>
</varlistentry>
<varlistentry>
<term>dim_i</term>
<listitem>
- <para>defines the size of the ith value it must be an integer or a 2-vector of integer, -1 stands for undefined dimension</para>
+ <para>
+ defines the size of the ith value it must be an integer or
+ a 2-vector of integer, -1 stands for undefined dimension.
+ </para>
</listitem>
</varlistentry>
</variablelist>
<term>ini</term>
<listitem>
<para>
- n column vector of strings, <literal>ini(i)</literal> gives the suggested response for the ith required value
+ n column vector of strings, <literal>ini(i)</literal> gives the suggested
+ response for the ith required value
</para>
</listitem>
</varlistentry>
<term>xi</term>
<listitem>
<para>
- contains the ith value if ok=%t. If left hand side has one more <literal>xi</literal> than required values the last <literal>xi</literal> contains the vector of answered strings.
+ contains the ith value if ok=%t. If left hand side has one more
+ <literal>xi</literal> than required values the last <literal>xi</literal>
+ contains the vector of answered strings.
</para>
</listitem>
</varlistentry>
This function encapsulate <literal>x_mdialog</literal> function with error checking,
evaluation of numerical response, ...
</para>
- </refsection>
- <refsection>
- <title>Remarks</title>
- <para>
- All valid expressions can be used as answers; for matrices and vectors <literal>getvalues</literal> automatically adds [ ] around the given answer before numeric evaluation.
- </para>
+ <note>
+ <para>
+ All valid expressions can be used as inputs. For matrices and vectors,
+ <literal>getvalues()</literal> automatically adds [ ] around each group of input
+ before their evaluation.
+ </para>
+ </note>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
-labels=["magnitude";"frequency";"phase "];
-[ok,mag,Freq,ph]=getvalue("define sine signal",labels,...
- list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
+labels=["magnitude" ; "frequency" ; "phase "];
+[ok,mag,Freq,ph] = getvalue("define sine signal",labels,...
+ list("vec",1,"vec",1,"vec",1), ["0.85";"10^2";"%pi/3"])
]]></programlisting>
</refsection>
<refsection role="see also">
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="getvalue">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="fr" xml:id="getvalue">
<refnamediv>
<refname>getvalue</refname>
<refpurpose>boîte de dialogue de saisie de paramètres </refpurpose>
<varlistentry>
<term>desc </term>
<listitem>
- <para>vecteur colonne de chaînes de caractères,
+ <para>
+ vecteur colonne de texte : présentation de la liste des paramètres.
+ Tout caractère "<" doit être remplacé par "&lt;"
</para>
</listitem>
</varlistentry>
<term>labels </term>
<listitem>
<para>
- vecteur colonne de n chaînes de caractères, <literal>labels(i)</literal> est l'entête du i-ème paramètre
+ vecteur colonne de n textes : <literal>labels(i)</literal> l'intitulé
+ du i-ème paramètre.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>typ_i </term>
<listitem>
- <para>définit le type de la ième valeur. typ_i peut prendre l'une des valeurs :
+ <para>
+ définit le type de la ième valeur. Par défaut, les saisies
+ sont interprêtées comme des nombres décimaux. Les valeurs
+ groupées en colonne doivent être séparées par ";".
+ typ_i peut prendre l'une des valeurs suivantes :
</para>
- <variablelist>
- <varlistentry>
- <term>"mat" </term>
- <listitem>
- <para>matrice
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"col" </term>
- <listitem>
- <para>vecteur colonne
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"row" </term>
- <listitem>
- <para>vecteur ligne
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"vec" </term>
- <listitem>
- <para>vecteur
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"str" </term>
- <listitem>
- <para>chaîne de caractères
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"lis" </term>
- <listitem>
- <para>liste
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <table>
+ <tr><th>"mat"</th><td>matrice</td></tr>
+ <tr><th>"col"</th><td>vecteur colonne (valeurs séparées par ";")</td></tr>
+ <tr><th>"row"</th><td>vecteur ligne</td></tr>
+ <tr><th>"vec"</th><td>vecteur (orientation libre)</td></tr>
+ <tr><th>"intvec"</th><td>scalaire, vecteur ou matrice de nombres entiers.</td></tr>
+ <tr><th>"str"</th><td>scalaire, vecteur ou matrice de textes, délimités par ".."</td></tr>
+ <tr><th>"lis"</th><td>liste (non implémenté)</td></tr>
+ </table>
</listitem>
</varlistentry>
<varlistentry>
<term>dim_i </term>
<listitem>
- <para>définit les dimensions de la i-ème valeur. Ce doit être un entier
- ou un vecteur de deux entiers. -1 signifie que les dimensions ne sont
- pas définies.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ini </term>
- <listitem>
<para>
- vecteur colonne de n chaînes de caractères, <literal>ini(i)</literal>
- donne la valeur par défaut du i-ème paramètre
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ok </term>
- <listitem>
- <para>booléen, %t (vrai) si le bouton "Ok" a été pressé, %f
- (faux) pour le bouton "Cancel"
+ définit les dimensions de la i-ème valeur. Ce doit être un entier
+ ou un vecteur de deux entiers. -1 signifie que les dimensions
+ sont libres / non définies.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>xi </term>
- <listitem>
- <para>contient le i-ème paramètre si ok=%t. Si la liste des arguments de
- sortie contient un <literal>xi</literal> de plus que nécessaire, la valeur
- du dernier <literal>xi</literal> contient le vecteur des chaînes de
- caractères correspondant aux paramètres choisis.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- </variablelist>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ini </term>
+ <listitem>
+ <para>
+ vecteur colonne de n chaînes de caractères, <literal>ini(i)</literal>
+ donne la valeur par défaut du i-ème paramètre
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ok </term>
+ <listitem>
+ <para>booléen, %t (vrai) si le bouton "Ok" a été pressé, %f
+ (faux) pour le bouton "Cancel"
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xi </term>
+ <listitem>
+ <para>contient le i-ème paramètre si ok=%t. Si la liste des arguments de
+ sortie contient un <literal>xi</literal> de plus que nécessaire, la valeur
+ du dernier <literal>xi</literal> contient le vecteur des chaînes de
+ caractères correspondant aux paramètres choisis.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
- Cette fonction est une interface vers la fonction <literal>x_mdialog</literal>
+ Cette fonction est une interface vers la fonction <literal>x_mdialog</literal>,
avec contrôle d'erreur, vérification de taille et de type des
paramètres, évaluation des expressions Scilab, etc.
</para>
- </refsection>
- <refsection>
- <title>REMARQUES</title>
- <para>
- Toute expression Scilab valide peut être utilisée pour entrer un
- paramètre; pour les matrices et les vecteurs <literal>getvalues</literal>
- ajoute [ ] autour des valeurs rentrées avant leur évaluation.
- </para>
+ <note>
+ <para>
+ Toute expression Scilab valide peut être utilisée pour entrer un paramètre.
+ Pour les matrices et les vecteurs, <literal>getvalues()</literal>
+ ajoute [ ] autour de chaque groupe de valeurs saisies, avant leur évaluation.
+ </para>
+ </note>
</refsection>
<refsection>
<title>Exemples</title>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getvalue">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ja" xml:id="getvalue">
<refnamediv>
<refname>getvalue</refname>
<refpurpose>データ取得用のxwindowダイアログ</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>呼び出し手順</title>
- <synopsis>[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)</synopsis>
+ <synopsis>[ok,x1,..,x14] = getvalue(desc, labels, typ, ini)</synopsis>
</refsynopsisdiv>
<refsection>
<title>引数</title>
<varlistentry>
<term>desc</term>
<listitem>
- <para>文字列の列ベクトル, ダイアログ用のコメント</para>
+ <para>
+ 文字列の列ベクトル, ダイアログ用のコメント. Any "<" character must be
+ replaced with "&lt;".
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term>typ_i</term>
<listitem>
- <para>i番目の値の型を定義します.
- 以下の値のどれかとなります:
+ <para>i番目の値の型を定義します. 以下の値のどれかとなります:
</para>
- <variablelist>
- <varlistentry>
- <term>"mat" </term>
- <listitem>
- <para>:定数行列の場合</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"col" </term>
- <listitem>
- <para>:定数列ベクトルの場合</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"row" </term>
- <listitem>
- <para>:定数行ベクトルの場合</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"vec" </term>
- <listitem>
- <para>:定数ベクトルの場合</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"intvec" </term>
- <listitem>
- <para>:整数値を有する定数ベクトル,
- すなわち int(x) == x の場合
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"str" </term>
- <listitem>
- <para>:文字列の場合</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"lis" </term>
- <listitem>
- <para>:リストの場合</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <table>
+ <tr><th>"mat"</th><td>:定数行列の場合</td></tr>
+ <tr><th>"col"</th><td>:定数列ベクトルの場合</td></tr>
+ <tr><th>"row"</th><td>:定数行ベクトルの場合</td></tr>
+ <tr><th>"vec"</th><td>:定数ベクトルの場合</td></tr>
+ <tr><th>"intvec"</th><td>:整数値を有する定数ベクトル, すなわち int(x) == x の場合</td></tr>
+ <tr><th>"str"</th><td>:文字列の場合</td></tr>
+ <tr><th>"lis"</th><td>:リストの場合 (not implemented)</td></tr>
+ </table>
</listitem>
</varlistentry>
<varlistentry>
数値応答の評価,などを指定して
<literal>x_mdialog</literal>をカプセル化したものです.
</para>
- </refsection>
- <refsection>
- <title>注意</title>
- <para>
- 有効な式を答として使用できます;
- 行列およびベクトルの場合,
- <literal>getvalues</literal>は数値評価の前に指定した答に
- 自動的に [ ]を追加します.
- </para>
+ <note>
+ <para>
+ 有効な式を答として使用できます. 行列およびベクトルの場合,
+ <literal>getvalues()</literal>は数値評価の前に指定した答に
+ 自動的に [ ]を追加します.
+ </para>
+ </note>
</refsection>
<refsection>
<title>例</title>
--- /dev/null
+<?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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ru" xml:id="getvalue">
+ <refnamediv>
+ <refname>getvalue</refname>
+ <refpurpose>диалог xwindow для получения данных</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Синтаксис</title>
+ <synopsis>[ok, x1,..,x14] = getvalue(desc, labels, typ, ini)</synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Аргументы</title>
+ <variablelist>
+ <varlistentry>
+ <term>desc</term>
+ <listitem>
+ <para>
+ вектор-столбец строковых значений, общий комментарий диалога.
+ Любой "<" символ должен быть заменён на "&lt;".
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>labels</term>
+ <listitem>
+ <para>
+ n-вектор-столбец строковых значений, <literal>labels(i)</literal> - это
+ метка <literal>i</literal>-го требуемого значения.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>typ</term>
+ <listitem>
+ <para>
+ <literal>list(typ_1,dim_1,..,typ_n,dim_n)</literal>
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>typ_i</term>
+ <listitem>
+ <para>
+ определяем тип <literal>i</literal>-го значения. По умолчанию
+ входные значения интерпретируются десятичными числами.
+ Столбцы (строки) значений должны быть разделены <literal>";"</literal>.
+ <varname>typ_i</varname> может иметь следующие значения:
+ </para>
+ <table>
+ <tr><th>"mat"</th><td>матрица</td></tr>
+ <tr><th>"col"</th><td>вектор-столбец</td></tr>
+ <tr><th>"row"</th><td>вектор-строка</td></tr>
+ <tr><th>"vec"</th><td>вектор (свободная ориентация)</td></tr>
+ <tr><th>"intvec"</th><td>скаляр, вектор или матрица целых чисел.</td></tr>
+ <tr><th>"str"</th><td>скаляр, вектор или матрица текстов, разделённых с помощью <literal>".."</literal></td></tr>
+ <tr><th>"lis"</th><td>список: не реализовано.</td></tr>
+ </table>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>dim_i</term>
+ <listitem>
+ <para>
+ определяет размер <literal>i</literal>-го значения, который
+ должен быть целым числом или двухэлементным вектором целых
+ чисел, <literal>-1</literal> стоит для неопределённого
+ размера.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ini</term>
+ <listitem>
+ <para>
+ n-вектор-столбец строковых значений, <literal>ini(i)</literal> даёт
+ подсказанный ответ для <literal>i</literal>-го запрошенного значения
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ok</term>
+ <listitem>
+ <para>
+ логическое значение, <literal>%t</literal>, если нажата кнопка
+ <literal>ok</literal>, <literal>%f</literal>, если нажата кнопка
+ <literal>cancel</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xi</term>
+ <listitem>
+ <para>
+ содержит <literal>i</literal>-тое значение, если
+ <literal>ok=%t</literal>. Если левая сторона имеет больше
+ <literal>xi</literal>, чем требуемых значений, то последний
+ <literal>xi</literal> содержит вектор ответных строковых значений.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Описание</title>
+ <para>
+ Эта функция заключает в себе функцию <literal>x_mdialog</literal> с проверкой ошибок,
+ вычислением числового ответа, ...
+ </para>
+ <note>
+ <para>
+ Все корректные выражения могут использоваться в качестве входных. Для матриц и
+ векторов <literal>getvalues()</literal> автоматически добавляет <literal>[ ]</literal>
+ вокруг каждой группы входных значений перед их вычислением.
+ </para>
+ </note>
+ </refsection>
+ <refsection>
+ <title>Примеры</title>
+ <programlisting role="example"><![CDATA[
+labels=["magnitude" ; "frequency" ; "phase "];
+[ok,mag,Freq,ph] = getvalue("define sine signal",labels,...
+ list("vec",1,"vec",1,"vec",1), ["0.85";"10^2";"%pi/3"])
+ ]]></programlisting>
+ </refsection>
+ <refsection role="see also">
+ <title>Смотрите также</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="x_mdialog">x_mdialog</link>
+ </member>
+ <member>
+ <link linkend="x_matrix">x_matrix</link>
+ </member>
+ <member>
+ <link linkend="x_dialog">x_dialog</link>
+ </member>
+ </simplelist>
+ </refsection>
+</refentry>
LineSpec_2.png=a06fa74995bbeb13d6486a51c45e05a3\r
LineSpec_3.png=0944c239bd89a7e1f5d21705c19c1fba\r
LineSpec_4.png=57732b0000bb78016145a6d579836134\r
+M_SWITCH_1.png=bddadf304806390eec7355e8068307b6\r
Matplot1_1.png=d6a47166ab86e17add7e33932c1c75e0\r
Matplot_1.png=d64708ebf99438b7fc27b1c4e1926050\r
Matplot_2.png=b7b8694b84bef82f90933032af005ad9\r
RAMP_1.png=c23fa5d3551bbd0d62ed522a383f858b\r
REGISTER_1.png=0b10b9eb56f4f302b40722fc37f90152\r
SAWTOOTH_f_1.png=10ee1db52ca7bf5c9a88f6af721493a6\r
+SCALE_CSCOPE_1.png=99e0ba70bb8d2c34aec7555986b6b518\r
SRFLIPFLOP_1.png=bf5bf1af128d883fe210b34b77108187\r
SRFLIPFLOP_fr_FR_1.png=66fae8781f8aff2688d19345715c229d\r
STEP_FUNCTION_1.png=a0f3c8ffdd4693291dc1c322c9a02fc5\r
Sfgrayplot_en_US_4.png=5ed6f3ce5c25c81f046e7359d9bc6e7d\r
Sfgrayplot_fr_FR_4.png=5ed6f3ce5c25c81f046e7359d9bc6e7d\r
Sfgrayplot_ja_JP_4.png=5ed6f3ce5c25c81f046e7359d9bc6e7d\r
-Sfgrayplot_pt_BR_4.png=5ed6f3ce5c25c81f046e7359d9bc6e7d\r
+Sfgrayplot_pt_BR_4.png=c985dda5076316ab30dfb721aa632eb8\r
Sfgrayplot_ru_RU_4.png=379972a821d7aa2a6cd9e7c0cd0c30aa\r
Sgrayplot_1.png=a030fe22e004d0b65f1c81ba29dbab54\r
Sgrayplot_2.png=e692f0b328fbc704e6d55565f5ba9b2d\r
_LaTeX_cdfgam.xml_1.png=0fde32f1e0edeb1f6426f9add9e8640a\r
_LaTeX_cdfnor.xml_1.png=b86b06522195bfcbfd8f4536dfa11330\r
_LaTeX_ceil.xml_ru_RU_1.png=701fa44621fd283e3f2c5468958859d8\r
+_LaTeX_corr.xml_1.png=51c8f81c08ebb3f4e16d3c478bba98ae\r
_LaTeX_cov.xml_1.png=1c3e8061d5b85a1b05a8f1c390f6f94d\r
_LaTeX_cross.xml_1.png=9653e9a5372afaed5d4a1ca1554ecac7\r
_LaTeX_csc.xml_1.png=95c11e401eed01b86b588b99436708ae\r
_LaTeX_hank.xml_1.png=fc6c604bc8c86af20a8f0673047332db\r
_LaTeX_histc.xml_1.png=f1c5acc5939d55326dfab4af50e13f97\r
_LaTeX_histplot.xml_1.png=f1c5acc5939d55326dfab4af50e13f97\r
+_LaTeX_implicitplot.xml_1.png=43ca5ad9e1f094a31392f860ef481e5c\r
_LaTeX_interp.xml_1.png=b99c07a3557a83033fdeedd84352b082\r
_LaTeX_interp.xml_10.png=e257b3b19cc16006687169337c38dc2a\r
_LaTeX_interp.xml_11.png=b99c07a3557a83033fdeedd84352b082\r
hsv2rgb_1.png=7d20c259e94301d9763fbddb7bff4784\r
hsvcolormap_1.png=11918d88bcc793200af0b9f1b58b0554\r
iir_1.png=e675c2755f68ddc4611c849895b63012\r
+implicitplot_1.png=d2d7b1b26a127ab8775517c742824770\r
+implicitplot_2.png=5371e2b77a74a8b2b2d139379e41c0a5\r
+implicitplot_3.png=5201f1980df1b1ba7afb7b3a92b68611\r
+implicitplot_4.png=74aeae6ec05b661c78c12c90d50b3aec\r
intdec_1.png=da3896e7d2e8468dd33edf57ccbe4480\r
interp1_1.png=0e9a3f4319b2818ce4921b9bc3008d80\r
interp2d_1.png=f4af61bc3faf493d778169ec7decc7ae\r
math_rendering_features_in_graphic_1.png=b1259d51258d72193bd32a47c8f96ca4\r
math_rendering_features_in_graphic_2.png=c93a1a79cbe217871185826f83fdd7bb\r
mese_1.png=c4ce712eded4fbbd49bb86b02e14afe9\r
+mesh2d_1.png=1fa605c61245e3610f300101926fa60f\r
mesh_1.png=a17150f02dbe853486f73801c9afcd11\r
meshgrid_1.png=9568cd9a7f4be8fde70668a8c5fbfd28\r
move_1.png=c4599a8693c9c099ac9c7f1a5dee3e91\r
<para>file opening mode. Formed by three digits abc:</para>
<table border="0">
<tr valign="top">
- <th colspan="2">Fortran files</th>
+ <td colspan="2">><emphasis role="bold">Fortran files</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
<td>0 stands for "new", 1 for "old", 2 for "scratch" and 3 for "unknown"</td>
</tr>
<tr valign="top">
- <th colspan="2">C files</th>
+ <td colspan="2"><emphasis role="bold">C files</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
</para>
<table border="0">
<tr valign="top">
- <th colspan="2">Fortranファイル</th>
+ <td colspan="2"><emphasis role="bold">Fortranファイル</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
<td>0 は "new", 1 は "old", 2 は "scratch" および 3 は "unknown"を意味します</td>
</tr>
<tr valign="top">
- <th colspan="2">Cファイル</th>
+ <td colspan="2"><emphasis role="bold">Cファイル</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
</para>
<table border="0">
<tr valign="top">
- <th colspan="2">Arquivos Fortran</th>
+ <td colspan="2"><emphasis role="bold">Arquivos Fortran</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
</td>
</tr>
<tr valign="top">
- <th colspan="2">Arquivos C</th>
+ <td colspan="2"><emphasis role="bold">Arquivos C</emphasis></td>
</tr>
<tr valign="top">
<th>a</th>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) XXXX-2008 - INRIA
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2018 - Samuel GOUGEON
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="file" xml:lang="ru">
+ <refnamediv>
+ <refname>file</refname>
+ <refpurpose>управление файлами</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Синтаксис</title>
+ <synopsis>
+ [unit, err] = file("open", file-name [,status] [,access [,recl]] [,format])
+ file("close", unit)
+ file("rewind", unit)
+ file("backspace", unit)
+ file("last", unit)
+ [units, typ, nams, mod, swap] = file()
+ [units, typ, nams, mod, swap] = file(unit)
+ </synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Аргументы</title>
+ <variablelist>
+ <varlistentry>
+ <term>file-name</term>
+ <listitem>
+ <para>строковое значение, имя файла, который нужно открыть</para>
+ <warning>
+ Эта функция не может открывать файлы, чьи пути имеют не-ascii
+ UTF-символы (диакритические знаки и т.д.). В этом случае следует
+ использовать <literal>mopen()</literal>.
+ </warning>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>status</term>
+ <listitem>
+ <para>строковое значение, статус файла, который следует открыть</para>
+ <variablelist>
+ <varlistentry>
+ <term>"new"</term>
+ <listitem>
+ <para>файл не существует, новый файл (по умолчанию);</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"old"</term>
+ <listitem>
+ <para>файл уже существует;</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"unknown"</term>
+ <listitem>
+ <para>неизвестный статус;</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"scratch"</term>
+ <listitem>
+ <para>файл должен будет удалён в конце сессии.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>access</term>
+ <listitem>
+ <para>строковое значение, тип доступа к файлу:</para>
+ <variablelist>
+ <varlistentry>
+ <term>"sequential"</term>
+ <listitem>
+ <para>последовательный доступ (по умолчанию);</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"direct"</term>
+ <listitem>
+ <para>прямой доступ.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>format</term>
+ <listitem>
+ <para>строковое значение, формат файла:</para>
+ <variablelist>
+ <varlistentry>
+ <term>"formatted"</term>
+ <listitem>
+ <para>для форматированных файлов (по умолчанию);</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"unformatted"</term>
+ <listitem>
+ <para>двоичная запись.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>recl</term>
+ <listitem>
+ <para>целочисленное значение, это размер записи в байтах, в случае
+ <literal>access="direct"</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>unit</term>
+ <listitem>
+ <para>
+ целочисленное значение, указатель на логический модуль открытого файла
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>units</term>
+ <listitem>
+ <para>
+ вектор целочисленных значений, указатель на логический модуль открытого
+ файла. Модули 5 и 6 (%io) зарезервированы системой для входных и выходных
+ устройств.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>typs</term>
+ <listitem>
+ <para>
+ Символьный вектор-строка, тип (C или Fortran) открытых файлов.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nams</term>
+ <listitem>
+ <para>Символьный вектор-строка, имена путей открытых файлов.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>mod</term>
+ <listitem>
+ <para>режим открытия файла. Сформированный тремя элементами abc:</para>
+ <table border="0">
+ <tr valign="top">
+ <td colspan="2">><emphasis role="bold">Файлы Fortran</emphasis></td>
+ </tr>
+ <tr valign="top">
+ <th>a</th>
+ <td>0 стоит для форматированных, а 1 - для неформатированных (двоичных)</td>
+ </tr>
+ <tr valign="top">
+ <th>b</th>
+ <td>0 стоит для последовательного доступа, а 1 - для прямого доступа</td>
+ </tr>
+ <tr valign="top">
+ <th>c</th>
+ <td>0 стоит для "new", 1 - для "old", 2 - для "scratch" и 3 - для "unknown"</td>
+ </tr>
+ <tr valign="top">
+ <td colspan="2"><emphasis role="bold">C-файлы</emphasis></td>
+ </tr>
+ <tr valign="top">
+ <th>a</th>
+ <td>1 стоит для "r" (чтение), 2 стоит для "w" (запись) и 3 - для "a" (дополнение)</td>
+ </tr>
+ <tr valign="top">
+ <th>b</th>
+ <td>равен 1, если файл открыт в режиме "+" (обновление)</td>
+ </tr>
+ <tr valign="top">
+ <th>c</th>
+ <td>равен 1, если файл открыт в режиме "b" (двоичный)</td>
+ </tr>
+ </table>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>swap</term>
+ <listitem>
+ <para>
+ переключатель автоматического обмена. <literal>swap=1</literal>, если
+ автоматический обмен включён. Для Fortran-файлов <varname>swap</varname>
+ всегда 0.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>err</term>
+ <listitem>
+ <para>
+ целочисленный код, возвращаемый, если открытие файла провалилось.
+ Если <varname>err</varname> пропущен, то выдаётся сообщение об ошибке.
+ </para>
+ <table>
+ <tr valign="top"><th>65</th><td>Файл уже используется</td></tr>
+ <tr valign="top"><th>66</th><td>Открыто слишком много файлов!</td></tr>
+ <tr valign="top"><th>67</th><td>Неизвестный формат файла</td></tr>
+ <tr valign="top"><th>240</th>
+ <td>Файл уже существует или запрещена запись в директорию.</td></tr>
+ <tr valign="top"><th>241</th><td>Файл не существует или чтение запрещено.</td></tr>
+ </table>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Описание</title>
+ <para>
+ <literal>file(…)</literal> выбирает логический модуль <varname>unit</varname> и
+ управляет файлом <varname>file-name</varname>.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>[unit [,err]]=file("open", file-name [,status] [,access [,recl]][,format])
+ </term>
+ <listitem>
+ <para>
+ позволяет открыть файл с особыми параметрами и получить номер связанного
+ модуля <varname>unit</varname>. Этот номер модуля можно использовать для
+ дальнейших действий с этим файлом или в качестве дескриптора файла при
+ вызове функций <function>read</function>, <function>write</function>,
+ <function>readb</function>, <function>writb</function>,
+ <function>save</function>, <function>load</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ file("close", unit)
+ </term>
+ <listitem>
+ <para>
+ позволяет закрыть файл или передвинуть текущий указатель файла.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ file("rewind", unit)
+ </term>
+ <listitem>
+ <para>
+ кладёт указатель в начало файла.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ file("backspace", unit)
+ </term>
+ <listitem>
+ <para>
+ кладёт указатель в начало последней записи.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ file("last", unit)
+ </term>
+ <listitem>
+ <para>
+ кладёт указатель после последней записи.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ file()
+ </term>
+ <listitem>
+ <para>
+ возвращает дескрипторы открытых файлов.
+ </para>
+ <para>
+ Чтобы проверить, открыт ли файл, чей модуль равен <literal>id</literal>,
+ можно использовать <literal>file(id)~=[]</literal>.
+ </para>
+ <para>
+ Чтобы закрыть все открытые пользователем файлы (типа C или Fortran),
+ можно использовать <literal>file("close",file())</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Примеры</title>
+ <programlisting role="example"><![CDATA[
+u=file("open",TMPDIR+"/foo","unknown")
+for k=1:4
+ a=rand(1,4)
+ write(u,a)
+end
+file("rewind",u)
+x=read(u,2,4)
+file("close",u)
+//
+u1=file("open",TMPDIR+"/foo","unknown")
+u2=mopen(TMPDIR+"/foo1","wb")
+[units,typs,nams]=file()
+file("close",u1);
+mclose(u2);
+ ]]></programlisting>
+ </refsection>
+ <refsection role="see also">
+ <title>Смотрите также</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="isfile">isfile</link>
+ </member>
+ <member>
+ <link linkend="read">read</link>
+ </member>
+ <member>
+ <link linkend="readb">readb</link>
+ </member>
+ <member>
+ <link linkend="write">write</link>
+ </member>
+ <member>
+ <link linkend="writb">writb</link>
+ </member>
+ <member>
+ <link linkend="mopen">mopen</link>
+ </member>
+ <member>
+ <link linkend="save">save</link>
+ </member>
+ <member>
+ <link linkend="load">load</link>
+ </member>
+ <member>
+ <link linkend="uigetfile">uigetfile</link>
+ </member>
+ </simplelist>
+ </refsection>
+ <refsection role="history">
+ <title>История</title>
+ <revhistory>
+ <revision>
+ <revnumber>6.0.0</revnumber>
+ <revdescription>
+ Внесена stderr в выход file() в виде units(1)=0, typ(1)="STD" и
+ nams(1)="stderr".
+ </revdescription>
+ </revision>
+ </revhistory>
+ </refsection>
+</refentry>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="corr">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="corr">
<refnamediv>
<refname>corr</refname>
<refpurpose>correlation, covariance</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[cov,Mean]=corr(x,[y],nlags)
- [cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)
+ <synopsis>
+ [cov,Mean] = corr(x,[y],nlags)
+ [cov,Mean] = corr('fft',xmacro,[ymacro],n,sect)
- [w,xu]=corr('updt',x1,[y1],w0)
- [w,xu]=corr('updt',x2,[y2],w,xu)
+ [w,xu] = corr('updt',x1,[y1],w0)
+ [w,xu] = corr('updt',x2,[y2],w,xu)
...
- [wk]=corr('updt',xk,[yk],w,xu)
+ wk = corr('updt',xk,[yk],w,xu)
</synopsis>
</refsynopsisdiv>
<refsection>
<refsection>
<title>Description</title>
<para>
- Computes
- </para>
- <programlisting role=""><![CDATA[
- n - m
- ====
- \ 1
-cov(m) = > (x(k) - xmean) (y(m+k) - ymean) * ---
- / n
- ====
- k = 1
- ]]></programlisting>
- <para>
- for m=0,..,<literal>nlag-1</literal> and two vectors <literal>x=[x(1),..,x(n)]</literal>
- <literal>y=[y(1),..,y(n)]</literal>
+ <literal>corr(x,y,…)</literal> computes
+ <latex alt="cov(m)=sum_{k=1}^{n-m} (x(k)-mean(x))(y(m+k)-mean(y)) / n">
+ cov(m)=\sum_{k=1}^{n-m} \left(x(k)-mean(x)\right)\left(y(m+k)-mean(y)\right) / n
+ </latex>
+ for <literal>m = 0, …, nlag-1</literal>.
</para>
<para>
Note that if x and y sequences are differents corr(x,y,...) is
<term>Long sequences</term>
<listitem>
<para>
- <literal>[cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)</literal> Here <literal>xmacro</literal> is either
+ <literal>[cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)</literal>.
+ Here <literal>xmacro</literal> is either
</para>
<itemizedlist>
<listitem>
<para>
a fortran subroutine or C procedure which performs the same
calculation. (See the source code of <literal>dgetx</literal> for an
- example). <literal>n</literal> = total size of the
- sequence. <literal>sect</literal> = size of sections of the
- sequence. <literal>sect</literal> must be a power of
- 2. <literal>cov</literal> has dimension
- <literal>sect</literal>. Calculation is performed by FFT.
+ example).
</para>
</listitem>
</itemizedlist>
+ <para>
+ <literal>n</literal> = total size of the sequence.
+ <literal>sect</literal> = size of sections of the sequence.
+ <literal>sect</literal> must be a power of 2.
+ <literal>cov</literal> has dimension <literal>sect</literal>.
+ Calculation is performed by FFT.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<title>See also</title>
<simplelist type="inline">
<member>
- <link linkend="fft">fft</link>
+ <link linkend="xcorr">xcorr</link>
+ </member>
+ <member>
+ <link linkend="xcov">xcov</link>
+ </member>
+ <member>
+ <link linkend="correl">correl</link>
+ </member>
+ <member>
+ <link linkend="cov">cov</link>
+ </member>
+ <member>
+ <link linkend="covar">covar</link>
</member>
</simplelist>
</refsection>
<?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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="corr">
-
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ja" xml:id="corr">
<refnamediv>
-
<refname>corr</refname>
-
<refpurpose>相関 , 共分散</refpurpose>
-
</refnamediv>
-
<refsynopsisdiv>
-
<title>呼び出し手順</title>
-
- <synopsis>[cov,Mean]=corr(x,[y],nlags)
-
- [cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)
-
-
-
- [w,xu]=corr('updt',x1,[y1],w0)
-
- [w,xu]=corr('updt',x2,[y2],w,xu)
-
+ <synopsis>
+ [cov,Mean] = corr(x,[y],nlags)
+ [cov,Mean] = corr('fft',xmacro,[ymacro],n,sect)
+ [w,xu] = corr('updt',x1,[y1],w0)
+ [w,xu] = corr('updt',x2,[y2],w,xu)
...
-
- [wk]=corr('updt',xk,[yk],w,xu)
-
+ wk = corr('updt',xk,[yk],w,xu)
</synopsis>
-
</refsynopsisdiv>
-
<refsection>
-
<title>引数</title>
-
<variablelist>
-
<varlistentry>
-
<term>x</term>
-
<listitem>
-
<para>実数ベクトル</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>y</term>
-
<listitem>
-
<para>実数ベクトル, デフォルト値 x.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>nlags</term>
-
<listitem>
-
<para>i整数, 指定した相関係数の数.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>xmacro</term>
-
<listitem>
-
<para>scilab 外部ルーチン (下記参照).</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>ymacro</term>
-
<listitem>
-
<para>scilab 外部ルーチン (下記参照), デフォルト値: xmacro</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>n</term>
-
<listitem>
-
<para>整数, シーケンス全体の大きさ (下記参照).</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>sect</term>
-
<listitem>
-
<para>シーケンスのセクションの大きさ (下記参照).</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>xi</term>
-
<listitem>
-
<para>実数ベクトル</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>yi</term>
-
<listitem>
-
<para>実数ベクトル,デフォルト値: xi.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>cov</term>
-
<listitem>
-
<para>実数ベクトル, 相関係数</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>Mean</term>
-
<listitem>
-
<para>実数または実数ベクトル, x (および y)の平均</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
-
</refsection>
-
<refsection>
-
<title>説明</title>
-
- <para>
-
- 以下を計算します.
-
- </para>
-
- <programlisting role=""><![CDATA[
- n - m
- ====
- \ 1
-cov(m) = > (x(k) - xmean) (y(m+k) - ymean) * ---
- / n
- ====
- k = 1
- ]]></programlisting>
-
<para>
-
- ただし, m=0,..,<literal>nlag-1</literal> で,2つのベクトルは
-
- <literal>x=[x(1),..,x(n)]</literal>,
-
- <literal>y=[y(1),..,y(n)]</literal>です.
-
+ <literal>corr(x,y,…)</literal> computes
+ <latex alt="cov(m)=sum_{k=1}^{n-m} (x(k)-mean(x))(y(m+k)-mean(y)) / n">
+ cov(m)=\sum_{k=1}^{n-m} \left(x(k)-mean(x)\right)\left(y(m+k)-mean(y)\right) / n
+ </latex>
+ for <literal>m = 0, …, nlag-1</literal>.
</para>
-
<para>
-
シーケンス x および y が異なる場合, corr(x,y,...)はcorr(y,x,...)
-
と異なることに注意してください.
-
</para>
-
<variablelist>
-
<varlistentry>
-
<term>短いシーケンス</term>
-
<listitem>
-
<para>
-
<literal>[cov,Mean]=corr(x,[y],nlags)</literal> は,
-
最初の nlags 個の相関係数および Mean = <literal>mean(x)</literal>
-
(<literal>y</literal> が引数として指定された場合,<literal>[x,y]</literal> の平均)
-
を返します.
-
シーケンス <literal>x</literal> (または <literal>y</literal>) は実数,
-
<literal>x</literal>と<literal>y</literal>は同じ次元 n と仮定されます.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>長いシーケンス</term>
-
<listitem>
-
<para>
-
<literal>[cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)</literal>
-
ここで,<literal>xmacro</literal> は以下のどちらかです
-
</para>
-
<itemizedlist>
-
<listitem>
-
<para>
-
<literal>[xx]=xmacro(sect,istart)</literal> という型の関数で,
-
<literal>istart</literal> から
-
<literal>istart+sect-1</literal>までの添字を有するシーケンスの
-
一部を含む
-
<literal>nsect</literal>次のベクトル<literal>xx</literal>を返します.
-
</para>
-
</listitem>
-
<listitem>
-
<para>
-
FortranサブルーチンまたはCプロシージャで,
-
同じ計算を行ないます(例えば,<literal>dgetx</literal>の
-
ソースコードを参照ください).
-
- <literal>n</literal> = シーケンスの総数.
-
- <literal>sect</literal> = シーケンスのセクションの大きさ.
-
- <literal>sect</literal> は 2の累乗とする必要があります.
-
- <literal>cov</literal> は
-
- <literal>sect</literal>次です.
-
- 計算は FFT により行われます.
-
</para>
-
</listitem>
-
</itemizedlist>
-
+ <para>
+ <literal>n</literal> = シーケンスの総数.
+ <literal>sect</literal> = シーケンスのセクションの大きさ.
+ <literal>sect</literal> は 2の累乗とする必要があります.
+ <literal>cov</literal> は
+ <literal>sect</literal>次です.
+ 計算は FFT により行われます.
+ </para>
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>更新法</term>
-
<listitem>
-
<programlisting role=""><![CDATA[
[w,xu]=corr('updt',x1,[y1],w0)
[w,xu]=corr('updt',x2,[y2],w,xu)
...
wk=corr('updt',xk,[yk],w,xu)
]]></programlisting>
-
<para>
-
この呼び出し手順では,計算結果が<literal>corr</literal>をコールする度に
-
更新されます.
-
</para>
-
<programlisting role=""><![CDATA[
w0 = 0*ones(1,2*nlags);
nlags = power of 2.
]]></programlisting>
-
<para>
-
<literal>x1,x2,...</literal> は,
-
<literal>x=[x1,x2,...]</literal>で,<literal>xi</literal>の大きさが
-
2の累乗となるような<literal>x</literal> の一部です.
-
<literal>nlags</literal>個の係数を得るには,
-
最後の fft を <literal>c=fft(w,1)/n</literal>;
-
<literal>cov=c(1nlags)</literal>を実行する必要があります
-
(<literal>n</literal> は <literal>x (y)</literal>の大きさ).
-
注意:
-
この呼び出し手順は <literal>xmean = ymean = 0</literal> を仮定します.
-
</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
-
</refsection>
-
<refsection>
-
<title>例</title>
-
<programlisting role="example"><![CDATA[
x=%pi/10:%pi/10:102.4*%pi;
rand('seed');rand('normal');
for j=1:2,for k=1:2,c=[c;corr(y(k,:),y(j,:),64)];end;end;
c=matrix(c,2,128);cov=[];
for j=1:64,cov=[cov;c(:,(j-1)*2+1:2*j)];end;
-rand('unif')
-rand('normal');x=rand(1,256);y=-x;
+rand('normal');
+x=rand(1,256);y=-x;
deff('[z]=xx(inc,is)','z=x(is:is+inc-1)');
deff('[z]=yy(inc,is)','z=y(is:is+inc-1)');
[c,mxy]=corr(x,y,32);
-x=x-mxy(1)*ones(x);y=y-mxy(2)*ones(y); //centring
+x=x-mxy(1)*ones(x); y=y-mxy(2)*ones(y); //centering
c1=corr(x,y,32);c2=corr(x,32);
norm(c1+c2,1)
[c3,m3]=corr('fft',xx,yy,256,32);
[c4,m4]=corr('fft',xx,256,32);
norm(m3,1),norm(m4,1)
norm(c3-c1,1),norm(c4-c2,1)
-x1=x(1:128);x2=x(129:256);
-y1=y(1:128);y2=y(129:256);
+x1=x(1:128); x2=x(129:256);
+y1=y(1:128); y2=y(129:256);
w0=0*ones(1:64); //32 coeffs
-[w1,xu]=corr('u',x1,y1,w0);w2=corr('u',x2,y2,w1,xu);
+[w1,xu]=corr('u',x1,y1,w0);
+w2=corr('u',x2,y2,w1,xu);
zz=real(fft(w2,1))/256;c5=zz(1:32);
norm(c5-c1,1)
-[w1,xu]=corr('u',x1,w0);w2=corr('u',x2,w1,xu);
+[w1,xu]=corr('u',x1,w0);
+w2=corr('u',x2,w1,xu);
zz=real(fft(w2,1))/256;c6=zz(1:32);
norm(c6-c2,1)
rand('unif')
[cc1,mm1]=corr(x,2^3);
[cc,mm]=corr('fft',xmacro,100,2^3);
[cc2,mm2]=corr('fft','corexx',100,2^3);
-[max(abs(cc-cc1)),max(abs(mm-mm1)),max(abs(cc-cc2)),max(abs(mm-mm2))]
+[max(abs(cc-cc1)), max(abs(mm-mm1)), max(abs(cc-cc2)), max(abs(mm-mm2))]
deff('[y]=ymacro(sec,ist)','y=cos(ist:(ist+sec-1))');
y=ymacro(100,1);
[cc1,mm1]=corr(x,y,2^3);
[cc,mm]=corr('fft',xmacro,ymacro,100,2^3);
[cc2,mm2]=corr('fft','corexx','corexy',100,2^3);
-[max(abs(cc-cc1)),max(abs(mm-mm1)),max(abs(cc-cc2)),max(abs(mm-mm2))]
+[max(abs(cc-cc1)), max(abs(mm-mm1)), max(abs(cc-cc2)), max(abs(mm-mm2))]
]]></programlisting>
-
</refsection>
-
<refsection role="see also">
-
<title>参照</title>
-
<simplelist type="inline">
-
<member>
-
- <link linkend="fft">fft</link>
-
+ <link linkend="xcorr">xcorr</link>
+ </member>
+ <member>
+ <link linkend="xcov">xcov</link>
+ </member>
+ <member>
+ <link linkend="correl">correl</link>
+ </member>
+ <member>
+ <link linkend="cov">cov</link>
+ </member>
+ <member>
+ <link linkend="covar">covar</link>
</member>
-
</simplelist>
-
</refsection>
-
</refentry>
-
--- /dev/null
+<?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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ru" xml:id="corr">
+ <refnamediv>
+ <refname>corr</refname>
+ <refpurpose>корреляция, ковариация</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Синтаксис</title>
+ <synopsis>
+ [cov,Mean] = corr(x,[y],nlags)
+ [cov,Mean] = corr('fft',xmacro,[ymacro],n,sect)
+
+ [w,xu] = corr('updt',x1,[y1],w0)
+ [w,xu] = corr('updt',x2,[y2],w,xu)
+ ...
+ wk = corr('updt',xk,[yk],w,xu)
+ </synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Аргументы</title>
+ <variablelist>
+ <varlistentry>
+ <term>x</term>
+ <listitem>
+ <para>вещественный вектор/</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>y</term>
+ <listitem>
+ <para>вещественный вектор, значение по умолчанию x.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>nlags</term>
+ <listitem>
+ <para>целое число, желаемое количество коэффициентов корреляции.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xmacro</term>
+ <listitem>
+ <para>внешняя программа scilab (см. ниже).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ymacro</term>
+ <listitem>
+ <para>внешняя программа scilab (см. ниже), значение по умолчанию xmacro.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>n</term>
+ <listitem>
+ <para>целое число, общий размер последовательности (см. ниже).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>sect</term>
+ <listitem>
+ <para>размер секций последовательности (см. ниже).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xi</term>
+ <listitem>
+ <para>вещественный вектор.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>yi</term>
+ <listitem>
+ <para>вещественный вектор, значение по умолчанию xi.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cov</term>
+ <listitem>
+ <para>вещественный вектор, коэффициенты корреляции</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mean</term>
+ <listitem>
+ <para>вещественное число или вектор, всреднее значение x и, если указано, y</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Описание</title>
+ <para>
+ <literal>corr(x,y,…)</literal> вычисляет
+ <latex alt="cov(m)=sum_{k=1}^{n-m} (x(k)-mean(x))(y(m+k)-mean(y)) / n">
+ cov(m)=\sum_{k=1}^{n-m} \left(x(k)-mean(x)\right)\left(y(m+k)-mean(y)\right) / n
+ </latex>,
+ где <literal>m = 0, …, nlag-1</literal>.
+ </para>
+ <para>
+ Обратите внимание, что, если последовательности <varname>x</varname> и
+ <varname>y</varname> разные, то <literal>corr(x,y,…)</literal> отличается
+ от <literal>corr(y,x,…)</literal>.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Короткие последовательности</term>
+ <listitem>
+ <para>
+ <literal>[cov,Mean]=corr(x,[y],nlags)</literal> возвращает первые
+ <varname>nlags</varname> коэффициентов корреляции и <literal>Mean = mean(x)</literal>
+ (среднее арифметическое <literal>[x,y]</literal>, если
+ <varname>y</varname> является аргументом.
+ Последовательность <varname>x</varname> (соответственно
+ <varname>y</varname>) предполагается вещественной, и <varname>x</varname>
+ и <literal>y</literal> одинакового размера <literal>n</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Длинные последовательности</term>
+ <listitem>
+ <para>
+ <literal>[cov,Mean]=corr('fft',xmacro,[ymacro],n,sect)</literal>, где <varname>xmacro</varname> - это:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ функция типа <literal>[xx]=xmacro(sect,istart)</literal>, которая
+ возвращает вектор <literal>xx</literal> размером <literal>nsect</literal>,
+ содержащий часть последовательности с индексами от
+ <literal>istart</literal> до <literal>istart+sect-1</literal>;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ fortran-подпрограмма или C-процедура, которая выполняет то же вычисление (для примера см. исходный код <literal>dgetx</literal>).
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <literal>n</literal> - общий размер последовательности.
+ <literal>sect</literal> - размер секций последовательности.
+ <literal>sect</literal> должен быть кратным степени 2.
+ <literal>cov</literal> имеет размерность <literal>sect</literal>.
+ Вычисление производится с помощью БПФ.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Обновляющий метод</term>
+ <listitem>
+ <programlisting role="no-scilab-exec"><![CDATA[
+[w,xu]=corr('updt',x1,[y1],w0)
+[w,xu]=corr('updt',x2,[y2],w,xu)
+ ...
+wk=corr('updt',xk,[yk],w,xu)
+ ]]></programlisting>
+ <para>
+ С этим синтаксисом вычисление обновляется при каждом вызове <literal>corr</literal>.
+ </para>
+ <programlisting role="no-scilab-exec"><![CDATA[
+w0 = 0*ones(1,2*nlags);
+nlags = power of 2.
+ ]]></programlisting>
+ <para>
+ <literal>x1,x2,...</literal> - это части <literal>x</literal> такие, что
+ <literal>x=[x1,x2,...]</literal> и размеры <literal>xi</literal> кратны
+ степени 2. Чтобы получить <varname>nlags</varname> коэффициентов, должно
+ быть выполенно заключительное БПФ <literal>c=fft(w,1)/n</literal>;
+ <literal>cov=c(1nlags)</literal>
+ (<literal>n</literal> - это размер <literal>x</literal> (<literal>y</literal>)). Предупреждение: этот синтаксис предполагает, что <literal>xmean = ymean = 0</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Примеры</title>
+ <programlisting role="example"><![CDATA[
+x=%pi/10:%pi/10:102.4*%pi;
+rand('seed');rand('normal');
+y=[.8*sin(x)+.8*sin(2*x)+rand(x);.8*sin(x)+.8*sin(1.99*x)+rand(x)];
+c=[];
+for j=1:2,for k=1:2,c=[c;corr(y(k,:),y(j,:),64)];end;end;
+c=matrix(c,2,128);cov=[];
+for j=1:64,cov=[cov;c(:,(j-1)*2+1:2*j)];end;
+rand('unif')
+
+rand('normal');x=rand(1,256);y=-x;
+deff('[z]=xx(inc,is)','z=x(is:is+inc-1)');
+deff('[z]=yy(inc,is)','z=y(is:is+inc-1)');
+[c,mxy]=corr(x,y,32);
+x=x-mxy(1)*ones(x);y=y-mxy(2)*ones(y); //центровка
+c1=corr(x,y,32);c2=corr(x,32);
+norm(c1+c2,1)
+[c3,m3]=corr('fft',xx,yy,256,32);
+norm(c1-c3,1)
+[c4,m4]=corr('fft',xx,256,32);
+norm(m3,1),norm(m4,1)
+norm(c3-c1,1),norm(c4-c2,1)
+x1=x(1:128);x2=x(129:256);
+y1=y(1:128);y2=y(129:256);
+w0=0*ones(1:64); //32 coeffs
+[w1,xu]=corr('u',x1,y1,w0);w2=corr('u',x2,y2,w1,xu);
+zz=real(fft(w2,1))/256;c5=zz(1:32);
+norm(c5-c1,1)
+[w1,xu]=corr('u',x1,w0);w2=corr('u',x2,w1,xu);
+zz=real(fft(w2,1))/256;c6=zz(1:32);
+norm(c6-c2,1)
+rand('unif')
+
+// тест для внешней программы Fortran или C
+//
+deff('[y]=xmacro(sec,ist)','y=sin(ist:(ist+sec-1))');
+x=xmacro(100,1);
+[cc1,mm1]=corr(x,2^3);
+[cc,mm]=corr('fft',xmacro,100,2^3);
+[cc2,mm2]=corr('fft','corexx',100,2^3);
+[max(abs(cc-cc1)),max(abs(mm-mm1)),max(abs(cc-cc2)),max(abs(mm-mm2))]
+
+deff('[y]=ymacro(sec,ist)','y=cos(ist:(ist+sec-1))');
+y=ymacro(100,1);
+[cc1,mm1]=corr(x,y,2^3);
+[cc,mm]=corr('fft',xmacro,ymacro,100,2^3);
+[cc2,mm2]=corr('fft','corexx','corexy',100,2^3);
+[max(abs(cc-cc1)),max(abs(mm-mm1)),max(abs(cc-cc2)),max(abs(mm-mm2))]
+ ]]></programlisting>
+ </refsection>
+ <refsection role="see also">
+ <title>Смотрите также</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="xcorr">xcorr</link>
+ </member>
+ <member>
+ <link linkend="xcov">xcov</link>
+ </member>
+ <member>
+ <link linkend="correl">correl</link>
+ </member>
+ <member>
+ <link linkend="cov">cov</link>
+ </member>
+ <member>
+ <link linkend="covar">covar</link>
+ </member>
+ </simplelist>
+ </refsection>
+</refentry>
* along with this program.
*
-->
-<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="istssession">
+<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" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="istssession">
<refnamediv>
<refname>istssession</refname>
<refpurpose>Determines if scilab is launched from a ms terminal service session (Windows only)</refpurpose>
end
]]></programlisting>
</refsection>
+ <refsection role="see also">
+ <title>See also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="fromc">fromc</link>
+ </member>
+ <member>
+ <link linkend="fromjava">fromjava</link>
+ </member>
+ <member>
+ <link linkend="getscilabmode">getscilabmode</link>
+ </member>
+ </simplelist>
+ </refsection>
</refentry>
<title>Description</title>
<para>
Inductor is an electrical component that can store energy in
- electrical circuits. The relationship between the voltage across
- the ports of an inductor of inductance and the current passing
- through it is given by:
+ electrical circuits. The relationship between the voltage <emphasis>v</emphasis> across
+ the ports of an inductor of inductance <emphasis>L</emphasis> and the current's
+ intensity <emphasis>I</emphasis> passing through it is :
</para>
<latex align="center" alt="v = L.dI/dt"><![CDATA[$$
v = L \times \frac{\mathrm d I}{\mathrm d t}
<title>Description</title>
<para>
L'inductance est un composant de circuit électrique qui peut stocker de l'énergie.
- La relation entre la tension aux bornes de l'inductance et le courant la traversant
- est donnée par :
+ La relation entre la tension <emphasis>v</emphasis> aux bornes de l'inductance
+ <emphasis>L</emphasis> et l'intensité <emphasis>I</emphasis> du courant la traversant
+ est :
</para>
<latex align="center" alt="v = L.dI/dt"><![CDATA[$$
v = L \times \frac{\mathrm d I}{\mathrm d t}
$$]]></latex>
<para>
- Les inductances peuvent aussi être utilisées pour discriminer les signaux de haute et basse fréquences,
- ce qui les rend utiles dans les filtres électroniques. Une inductance a une grande impédance pour
- les signaux de haute fréquence.
+ Les inductances peuvent aussi être utilisées pour discriminer les signaux de haute
+ et basse fréquences, ce qui les rend utiles dans les filtres électroniques.
+ Une inductance a une grande impédance pour les signaux de haute fréquence.
</para>
</refsection>
<refsection id="Dialogbox_Inductor">
can be one of the following:
<itemizedlist>
<listitem>
- unique string: path to the XML source file (where preferences are
- registered). By default,
+ unique string: path to the XML source file. By default, the main
+ preferences file
<literal>SCIHOME+'/XConfiguration.xml'</literal> is considered.
</listitem>
<listitem>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2014 - Scilab Enterprises - Calixte DENIZET
+ * Copyright (C) 2017 - Samuel GOUGEON
+ *
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
+<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"
+ xmlns:scilab="http://www.scilab.org" xml:id="xmlGetValues" xml:lang="ru">
+ <refnamediv>
+ <refname>xmlGetValues</refname>
+ <refpurpose>
+ Проводит синтаксическую проверку и получает значения атрибутов выбранных тегов в
+ XML-файле настроек
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Синтаксис</title>
+ <synopsis>
+ Values = xmlGetValues(path2tag, attributes)
+ Values = xmlGetValues(path2tag, attributes, XMLsource)
+ </synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Аргументы</title>
+ <variablelist>
+ <varlistentry>
+ <term>path2tag</term>
+ <listitem>
+ <para>
+ уникальная строка: в файле исходного XML-кода, путь, указывающий на выбранный тег,
+ чьи атрибуты нужно прочитать. Путь является списком вложенных тегов, стоящих спереди
+ от требуемого так, что <literal>"/a/b/c/d"</literal>, или, эквивалентно,
+ <literal>"//b/c/d"</literal>. Регистр учитывается.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>attributes</term>
+ <listitem>
+ <para>
+ вектор или матрица строк: имена атрибуты выбранного тега, чьи значения нужно прочитать.
+ Порядок атрибутов не имеет значения относительно их фактического порядка в теге.
+ <note>
+ <itemizedlist>
+ <listitem>
+ Имена атрибутов чувствительны к регистру.
+ </listitem>
+ <listitem>
+ На самом деле имена указанного атрибута могут быть
+ определены несколько раз.
+ </listitem>
+ </itemizedlist>
+ </note>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>XMLsource</term>
+ <listitem>
+ <para>
+ указывает на XML-документ из которого нужно извлечь информацию.
+ Это может быть одно из следующих:
+ <itemizedlist>
+ <listitem>
+ уникальная строка: путь до исходного XML-файла. По умолчанию
+ рассматривается файл главных настроек
+ <literal>SCIHOME+'/XConfiguration.xml'</literal>.
+ </listitem>
+ <listitem>
+ XML-указатель типа <literal>XMLdoc</literal>, возвращаемой
+ ранее в качестве внешней инструкции <code>xmlRead(XMLsource)</code>,
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Values</term>
+ <listitem>
+ <para>
+ матрица строковых значений: значения выбранных атрибутов выбранного тега:
+ <itemizedlist>
+ <listitem>
+ Если набор выбранных атрибутов <varname>attributes</varname>
+ указан в виде матрицы с несколькими строками, то используется
+ только первое появление выбранного тега, и <varname>Values(i,j)</varname> - это
+ значение его атрибутов <varname>attributes(i,j)</varname>.
+ </listitem>
+ <listitem>
+ В противном случае, если имена атрибутов <varname>attributes</varname>
+ указаны в виде вектора-строки, то рассматриваются
+ <emphasis role="italic">все появления</emphasis> выбранного тега:
+ результаты возвращаются с одной строкой на появление, и одним
+ столбцом на атрибут. Таким образом, <varname>Values(i,j)</varname> - это
+ значение атрибутов <varname>attributes(j)</varname> для
+ <literal>i</literal>-той встречи тега в документе.
+ </listitem>
+ </itemizedlist>
+ Если ожидаются какие-либо конечные значения в виде чисел, а не литералов
+ (текста), то <code>evstr()</code> может быть применён к ним для получения
+ ожидаемых чисел.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Описание</title>
+ <para>
+ Когда XML-указатель, возвращённый с помощью <code>xmlRead(..)</code>, указан
+ в качестве <varname>XMLsource</varname>, то <function>xmlGetValues()</function>
+ исползует его напрямую для проверки синтаксиса XML-документа настроек, открытого
+ ранее с помощью <code>xmlRead(..)</code>. Это полезно, когда синтаксис одного и того
+ же документа нужно проверить множеством вызовов <function>xmlGetValues()</function>,
+ обычно для обращения к разным XML-тегам. В этом случае не следует забывать
+ закрыть XML-документ после всей обработки.
+ </para>
+ <para>
+ Когда путь до XML-файла настроек указан в качестве <varname>XMLsource</varname>,
+ то <function>xmlGetValues()</function> открывает файл, строит его DOM-дерево,
+ проверяет синтаксис дерева для выбранного тега и атрибутов, и, наконец, удаляет
+ дерево и закрывает файл перед тем, как вернуть результаты. Это то, что происходит
+ по умолчанию в соответствии с файлом настроек Xconfiguration.xml, когда нет явного
+ указания <varname>XMLsource</varname>.
+ </para>
+ <para>
+ Аргумент <varname>path2tag</varname> должен быть корректным путём "XPath",
+ соответствующим <ulink url="https://www.w3.org/TR/1999/REC-xpath-19991116/">рекомендациям W3C</ulink>.
+ Далее приведены примеры. Если путь исползует промежуточный или конечный тег, который
+ не существует, или, если один из ряда атрибутов не существует, то выдаётся ошибка.
+ </para>
+ </refsection>
+ <refsection>
+ <title>Примеры</title>
+ <emphasis role="bold">Пример 1:</emphasis>
+ <para>
+ Ваши интернет- и прокси-настройки для Scilab хранятся по умолчанию в файле настроек
+ <literal>SCIHOME+'/XConfiguration.xml'</literal>. Рассмотрим следующий отрывок файла:
+ <programlisting role="xml"><![CDATA[
+ <?xml version="1.0" encoding="utf-8" standalone="no"?>
+ <interface height="600" path="1/" version="0.17" width="800">
+ <general title="_(General)">
+ ...
+ </general>
+ <web title="_(Web)">
+ <body>
+ <web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
+ <proxy enabled="false" host="" password="" port="" user=""/>
+ <previous-proxy enabled="false" host="" password="" port="" user=""/>
+ </body>
+ </web>
+ ...
+ </interface>
+ ]]></programlisting>
+ </para>
+ <para>
+ Чтобы получить информацию прокси-параметров (тег proxy), требуемый код должен быть:
+ <programlisting role="scilab"><![CDATA[
+ proxy = xmlGetValues("//web/body/proxy", ["enabled", "host", "port"]);
+ ]]></programlisting>
+ </para>
+ <para>
+ <emphasis role="bold">Пример 2:</emphasis>
+ </para>
+ <para>
+ <function>xmlGetValues()</function> может также использоваться для получения значений
+ тега, имеющих множество появлений в файле <literal>XMLsource</literal>. Например,
+ ваши настройки в редакторе Scinotes Scilab'а хэранятся в файле
+ <literal>SCIHOME\scinotesConfiguration.xml</literal>. Список последних файлов,
+ открытых в Scinotes в следующей части и пути:
+ <programlisting role="xml"><![CDATA[
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<Setting version="0.42">
+ <!-- SCINOTES configuration -->
+ <Profile name="scinotes">
+ <!-- .../... -->
+ <!-- Recent Opened Files Section -->
+ <recentFiles>
+ <document path="C:\Path\to\my\first\working\dir\ged_move_entity.sci"/>
+ <document path="C:\Path\to\my\first\working\dir\ged_loop.sci"/>
+ <document path="C:\Path\to\my\first\working\dir\test_legend_move.sce"/>
+ <document path="C:\Path\to\another\working\dir2\clf.sci"/>
+ </recentFiles>
+ <!-- .../... -->
+ </Profile>
+</Setting>
+ ]]></programlisting>
+ </para>
+ <para>
+ Тогда следующий год извлечёт, вернёт и выведет на экран столбец недавних файлов:
+ <programlisting role="example"><![CDATA[
+ scinotesFile = SCIHOME + "/scinotesConfiguration.xml";
+ recent = xmlGetValues("//Setting/Profile/recentFiles/document", "path", scinotesFile);
+ mprintf("%s\n", recent)
+ ]]></programlisting>
+ <screen><![CDATA[
+C:\Path\to\my\first\working\dir\ged_move_entity.sci
+C:\Path\to\my\first\working\dir\ged_loop.sci
+C:\Path\to\my\first\working\dir\test_legend_move.sce
+C:\Path\to\another\working\dir2\clf.sci
+]]></screen>
+ </para>
+ </refsection>
+ <refsection role="see also">
+ <title>Смотрите также</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="setPreferencesValue">setPreferencesValue</link>
+ </member>
+ <member>
+ <link linkend="xmlXPath">xmlXPath</link>
+ </member>
+ <member>
+ <ulink url="https://www.w3.org/TR/1999/REC-xpath-19991116/">язык XML-пути</ulink>
+ </member>
+ <member>
+ <link linkend="xmlRead">xmlRead</link>
+ </member>
+ <member>
+ <link linkend="xmlDelete">xmlDelete</link>
+ </member>
+ <member>
+ <link linkend="atomsGetConfig">atomsGetConfig</link>
+ </member>
+ <member>
+ <link linkend="printsetupbox">printsetupbox</link>
+ </member>
+ <member>
+ <link linkend="csvDefault">csvDefault</link>
+ </member>
+ </simplelist>
+ </refsection>
+ <refsection role="history">
+ <title>История</title>
+ <revhistory>
+ <revision>
+ <revnumber>6.0.2</revnumber>
+ <revdescription>
+ Введена xmlGetValues(), которая раньше была getPreferencesValue().
+ </revdescription>
+ </revision>
+ </revhistory>
+ </refsection>
+</refentry>
projects / scilab.git / commitdiff
