diff options
author | Shashank | 2017-05-29 12:40:26 +0530 |
---|---|---|
committer | Shashank | 2017-05-29 12:40:26 +0530 |
commit | 0345245e860375a32c9a437c4a9d9cae807134e9 (patch) | |
tree | ad51ecbfa7bcd3cc5f09834f1bb8c08feaa526a4 /modules/data_structures/help | |
download | scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.gz scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.bz2 scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.zip |
CMSCOPE changed
Diffstat (limited to 'modules/data_structures/help')
117 files changed, 11098 insertions, 0 deletions
diff --git a/modules/data_structures/help/en_US/addchapter.sce b/modules/data_structures/help/en_US/addchapter.sce new file mode 100755 index 000000000..fe44d5579 --- /dev/null +++ b/modules/data_structures/help/en_US/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Data Structures",SCI+"/modules/data_structures/help/en_US",%T); + diff --git a/modules/data_structures/help/en_US/boolean.xml b/modules/data_structures/help/en_US/boolean.xml new file mode 100755 index 000000000..92cb66f82 --- /dev/null +++ b/modules/data_structures/help/en_US/boolean.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="boolean"> + <refnamediv> + <refname>boolean</refname> + <refpurpose>Scilab Objects, boolean variables and operators & | ~ </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + A boolean variable is <constant>%T</constant> (for "true") or <constant>%F</constant> (for "false"). These variables can be used to define matrices of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for elements extraction/insertion and concatenation. + </para> + <para> + <note> + Note that other usual operations (<literal>+</literal>, <literal>*</literal>, <literal>-</literal>, <literal>^</literal>, etc) are undefined for boolean matrices. Three special operators are defined for boolean matrices: + </note> + </para> + <variablelist> + <varlistentry> + <term>~b</term> + <listitem> + <para> + is the element-wise negation of boolean <literal>b</literal> (matrix). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1 & b2</term> + <listitem> + <para> + is the element-wise logical <literal>and</literal> of + <literal>b1</literal> and <literal>b2</literal> + (matrices). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1 | b2</term> + <listitem> + <para> + is the element-wise logical + <literal>or</literal> of <literal>b1</literal> + and <literal>b2</literal> (matrices). + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Boolean variables can be used for indexing matrices or vectors. For instance <code>a([%T,%F,%T],:)</code> returns the submatrix made of rows <literal>1</literal> and <literal>3</literal> of <literal>a</literal>. Boolean sparse matrices are supported. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[1,2]==[1,3] +[1,2]==1 +a=1:5; a(a>2) +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="matrices">matrices</link> + </member> + <member> + <link linkend="or">or</link> + </member> + <member> + <link linkend="and">and</link> + </member> + <member> + <link linkend="not">not</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/cell.xml b/modules/data_structures/help/en_US/cell.xml new file mode 100755 index 000000000..120dc177f --- /dev/null +++ b/modules/data_structures/help/en_US/cell.xml @@ -0,0 +1,164 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="cell" xml:lang="en"> + <refnamediv> + <refname>cell</refname> + <refpurpose>creates a cell array of empty matrices</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + c = cell() + c = cell(m1) + c = cell(m1, m2) + c = cell(m1, m2, ..., mn) + c = cell(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para> + a vector containing the dimensions of the cell to create. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>m1, m2, ..., mn</term> + <listitem> + <para> + dimensions of the cell to create. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>cell</function> returns a cell array of empty matrices. + </para> + <variablelist> + <varlistentry> + <term>cell()</term> + <listitem> + <para> + returns a <literal>(0, 0)</literal> cell array of empty matrices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1)</term> + <listitem> + <para> + returns a <literal>(m1, m1)</literal> cell array of empty matrices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1, m2)</term> + <listitem> + <para> + returns a <literal>(m1, m2) </literal> cell array of empty matrices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1,m2,..,mn)</term> + <listitem> + <para> + creates a <literal>(m1, m2, ..., mn)</literal> cell array of empty matrices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(x)</term> + <listitem> + <para> + returns a cell array of empty matrices with: the first dimension of the cell array is <literal>x(1)</literal>, the second dimension is <literal>x(2)</literal> and so on. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Remarks</title> + <para> + <code>cell(x)</code> is not the same size that <varname>x</varname>. + </para> + <para> + <code>cell()</code> is equivalent to <code>cell(0)</code>. + </para> + <para> + If <literal>A</literal> is a cell array, you can access the contents of an element of <literal>A</literal> by using <code>A(m1, m2, ..., mn).entries</code>. The expression <code>A(1,1) = zeros(2,2)</code> is not valid, the right syntax is + <code>A(1,1).entries = zeros(2,2)</code>. + </para> + <para> + If <literal>A</literal> is a cell array, you can get its dimensions by using <code>A.dims</code> which returns an <literal>int32</literal> value that cannot be used as a subscript for the cell array. In this case, the best way to get the cell array dimensions is <code>size(A)</code>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a=cell(3) +b=cell(3,1) +c=cell([2,3,4]) + +// Assigning cell entries +b=cell(3,1); + +// Assigning the first element of b using the 'entries' field +b(1).entries=1:3 + +// Assigning the second element of b using the 'entries' field +b(2).entries='Scilab' + +// Assigning the third element of b using the 'entries' field +b(3).entries=poly(1:3,'s') + +// Assigning sub-cells +X=cell(3,2); +X(:,1)=b + +// Extracting a sub-cell: result is a cell +b(1) +b(1:2) + +// Extracting a sub-cell value: result is an array +b(1).entries + +// Dimensions of b as an int32 value (cannot be used as an index) +b.dims +// Dimensions of b as a double value +size(b) + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="eye">eye</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/definedfields.xml b/modules/data_structures/help/en_US/definedfields.xml new file mode 100755 index 000000000..8bb0efa50 --- /dev/null +++ b/modules/data_structures/help/en_US/definedfields.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="definedfields"> + <refnamediv> + <refname>definedfields</refname> + <refpurpose>returns an index of list's defined fields</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>k = definedfields(lst)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>lst</term> + <listitem> + <para>a list, tlist or mlist variable.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>k</term> + <listitem> + <para>a vector of index.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + If <varname>lst</varname> is a <literal>list</literal>, a <literal>tlist</literal>, a <literal>mlist</literal> <code>k = definedfields(lst)</code> returns in <varname>k</varname> the indices of the defined list fields. This function is useful because indexing undefined fields produces an error. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +lst=list(1);lst(3)=5 +k=definedfields(lst) + +t=tlist('x');t(5)=4 +definedfields(t) + +m=mlist(['m','a','b']);m.b='sdfgfgd' +definedfields(m) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/fieldnames.xml b/modules/data_structures/help/en_US/fieldnames.xml new file mode 100755 index 000000000..ff371cc65 --- /dev/null +++ b/modules/data_structures/help/en_US/fieldnames.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * Copyright (C) 2010 - Digiteo - Vincent LIARD + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="fieldnames"> + <refnamediv> + <refname>fieldnames</refname> + <refpurpose>get a tlist, mlist or struct fields names</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>f = fieldnames(lst)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>lst</term> + <listitem> + <para>A tlist, mlist or struct variable.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>Strings column vector of fields names.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>fieldnames</function> function returns field names + of a <literal>tlist</literal>, <literal>mlist</literal> or <literal>struct</literal>. <function>fieldnames</function> + does not work on cells. + </para> + <para> + As said in <link linkend="rational">rational</link> or <link linkend="syslin">syslin</link> help pages, internal representation of + some Scilab objects is a tlist (or rlist), so using <function>fieldnames</function> with them will return the generic forms of these objects. + For example, for rationals, the function will return "num","den" and "dt". + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + fieldnames(tlist(['listtype', 'f1', 'f2'], [], [])) + fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4])) + fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006)) + obj.x = 3; + obj.y = 3; + fieldnames(obj) + fieldnames(1/%s) + fieldnames(tf2ss(1/%s)) + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="struct">struct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/getfield.xml b/modules/data_structures/help/en_US/getfield.xml new file mode 100755 index 000000000..f00ef1728 --- /dev/null +++ b/modules/data_structures/help/en_US/getfield.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="getfield"> + <refnamediv> + <refname>getfield</refname> + <refpurpose>list field extraction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[x,...] = getfield(i,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>matrix of any possible types.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para> + <literal>list</literal>, <literal>tlist</literal> or <literal>mlist</literal> variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para> + field index, see <link linkend="extraction">extraction</link> for more details. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function is an equivalent of <literal>[x,...]=l(i)</literal> syntax for field + extraction with the only difference that it also applies to + <literal>mlist</literal> objects. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +[a,b]=getfield([3 2],l) + +a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists +a(1) // the a(1,1,1) entry +getfield(1,a) // the mlist first field + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/hypermat.xml b/modules/data_structures/help/en_US/hypermat.xml new file mode 100755 index 000000000..3fa5f2d2c --- /dev/null +++ b/modules/data_structures/help/en_US/hypermat.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermat"> + <refnamediv> + <refname>hypermat</refname> + <refpurpose>initializes an N dimensional matrix</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>M = hypermat(dims [,v])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para>a vector of hypermatrix dimensions.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>v</term> + <listitem> + <para> + a vector of hypermatrix entries (default value <code>zeros(prod(dims),1)</code>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>hypermat</function> function initializes a hypermatrix whose dimensions are given in the vector <varname>dims</varname> and entries are given in optional argument <varname>v</varname>. + </para> + <para> + <varname>M</varname> data structure contains the vector of matrix dimensions + <code>M('dims')</code> and the vector of entries <code>M('entries')</code> such as + the leftmost subcripts vary first + <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal> + </para> + <para> + <warning> + If you build your own <function>hypermat</function>, you must be careful. The <code>M('dims')</code> entry must be a row vector whereas the <code>M('entries')</code> must be a column vector. + </warning> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +M = hypermat([2 3 2 2],1:24) +disp(size(M('dims'))) +disp(size(M('entries'))) + +M_own = mlist(['hm','dims','entries']); +M_own('dims') = [2 3 2 2]; +M_own('entries') = [1:24]'; +disp(size(M_own('dims'))) +disp(size(M_own('entries'))) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/hypermatrices.xml b/modules/data_structures/help/en_US/hypermatrices.xml new file mode 100755 index 000000000..7f592e1c4 --- /dev/null +++ b/modules/data_structures/help/en_US/hypermatrices.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermatrices"> + <refnamediv> + <refname>hypermatrices</refname> + <refpurpose>a Scilab object, N dimensional matrix in Scilab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Hypermatrix type allows to manipulate multidimensional arrays. + </para> + <para> + They can be defined by extension of 2D matrices as follows + <code>a=[1 2;3 4];a(:,:,2)=rand(2,2)</code> or directly using <function>hypermat</function> function. + </para> + <para> + Entries can be real or complex numbers, polynomials, + rationals, strings, booleans. + </para> + <para> + Hypermatrices are <literal>mlists</literal>: + <code>mlist(['hm','dims','entries'],sz,v)</code> where <literal>sz</literal> is the row + vector of dimensions and <literal>v</literal> the column vector of entries (first + dimension are stored first). + </para> + <para> + <note> + The number of dimension of hypermatrices with right-most sizes equal to + 1 are automatically reduced. An hypermatrix with only two dimensions is + automatically changed to a regular matrix (type 1). + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a(1,1,1,1:2)=[1 2] +a=[1 2;3 4];a(:,:,2)=rand(2,2) +a(1,1,:) + +size(a) + +a(:,:,1) //dimensionality reduction +type(a(:,:,1)) + +[a a] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="hypermat">hypermat</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/iscell.xml b/modules/data_structures/help/en_US/iscell.xml new file mode 100755 index 000000000..f30e1eb7f --- /dev/null +++ b/modules/data_structures/help/en_US/iscell.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscell" xml:lang="en"> + <refnamediv> + <refname>iscell</refname> + <refpurpose>checks if a variable is a cell array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>bool = iscell(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a Scilab variable.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>iscell(x)</code> returns <constant>%t</constant>if + <varname>x</varname> is a cell array and <constant>%f</constant> otherwise. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +iscell(1) + +iscell(cell()) + +c = cell(1,2); +c(1).entries="Scilab"; +c(2).entries=datenum(); +iscell(c) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/iscellstr.xml b/modules/data_structures/help/en_US/iscellstr.xml new file mode 100755 index 000000000..8a305e445 --- /dev/null +++ b/modules/data_structures/help/en_US/iscellstr.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscellstr" xml:lang="en"> + <refnamediv> + <refname>iscellstr</refname> + <refpurpose>checks if a variable is a cell array of strings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>bool = iscellstr(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a Scilab variable.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>iscellstr(x)</code> returns <constant>%t</constant> if <varname>x</varname> is a cell array of + strings (or an empty cell array) and <constant>%f</constant> otherwise. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +iscellstr(1) + +iscellstr(cell()) + +iscellstr(cell(3)) + +strcell = cell(3,1); +strcell(1).entries="Scilab"; +strcell(2).entries="iscellstr"; +strcell(3).entries="help"; +iscellstr(strcell) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/isfield.xml b/modules/data_structures/help/en_US/isfield.xml new file mode 100755 index 000000000..4a0e6a655 --- /dev/null +++ b/modules/data_structures/help/en_US/isfield.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org> + * Copyright (C) 2013 - Samuel GOUGEON : extension to tlist and mlist + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isfield"> + <refnamediv> + <refname>isfield</refname> + <refpurpose>checks if the given fieldname exists in a structure or mlist or tlist</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>bool = isfield(s, fieldname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>a struct array, a tlist or a mlist.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fieldname</term> + <listitem> + <para>a matrix of strings: names of fields to be detected</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para> + a matrix of boolean (same format as <varname>fieldname></varname>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function returns <constant>%t</constant> if the specified structure or tlist or mlist <varname>s</varname> includes the field <varname>fieldname</varname>, regardless of the corresponding value. For a structure, the hidden field <code class="literal">dims</code> is ignored. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +s = struct("field_1",123,"field_2",456,"field_4",789) + +// Single Fieldname Syntax +isfield( s , "field_1" ) + +// Multiple Fieldname Syntax +isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] ) + +// with a tlist: +s = tlist(["test" "t" "n","","p"], "Hello", %pi, "anonymous", (1-%z)^3) +isfield(s, ["b" "t" ""]) // => F T T (anonymous fields can be detected) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="definedfields">definedfields</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5</revnumber> + <revremark> + Extension to any mlist and tlist. + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/isstruct.xml b/modules/data_structures/help/en_US/isstruct.xml new file mode 100755 index 000000000..467583938 --- /dev/null +++ b/modules/data_structures/help/en_US/isstruct.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isstruct" xml:lang="en"> + <refnamediv> + <refname>isstruct</refname> + <refpurpose>checks if a variable is a structure array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>bool = isstruct(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a Scilab variable.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>isstruct(x)</code> returns <constant>%t</constant> if + <varname>x</varname> is a struct array and <constant>%f</constant> otherwise. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +isstruct(1) + +isstruct(cell()) + +isstruct(struct("name","Scilab", "version", getversion())) + +info.name="Scilab"; +info.function="isstruct"; +info.module="help"; +isstruct(info) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/list.xml b/modules/data_structures/help/en_US/list.xml new file mode 100755 index 000000000..91e420ede --- /dev/null +++ b/modules/data_structures/help/en_US/list.xml @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="list"> + <refnamediv> + <refname>list</refname> + <refpurpose>a Scilab object and a list definition function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>list(a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Creates a <literal>list</literal> with elements + <varname>ai</varname>'s which are arbitrary Scilab objects + (<literal>matrix</literal>, + <literal>list</literal>,...). Type of + <literal>list</literal> objects is 15. <code>list()</code> + creates the empty <literal>list</literal> (0 element). + </para> + </refsection> + <refsection> + <title>Operations on lists</title> + <variablelist> + <varlistentry> + <term>extraction</term> + <listitem> + <para> + <literal>[x,y,z,...]=L(v)</literal> where <literal>v</literal> is a vector of indices; + <literal>[x,y,z,...]=L(:)</literal> extracts all the elements. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>insertion at index i</term> + <listitem> + <para> + <code>L(i)=a</code> (note that it is not an + error to use <code>L(i)=a</code> with + <code><![CDATA[i > 1 + size(L)]]></code> but + some list entries are then undefined and their + extraction gives raise to an error). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>append an element in queue</term> + <listitem> + <para> + <code>L($+1)=e</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>append an element in head</term> + <listitem> + <para> + <code>L(0)=e</code>. + <note> + After this + operation <literal>e</literal> is an index 1, + the initial elements being shifted on the + right. + </note> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>deletion</term> + <listitem> + <para> + <code>L(i)=null()</code> removes the <literal>i</literal>-th element of the list <literal>L</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>concatenation of two lists</term> + <listitem> + <para> + <code>L3 = lstcat(L1,L2)</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>number of elements of a list</term> + <listitem> + <para> + you can use either <code>nb_elm = size(L)</code> + or <code>nb_elm = length(L)</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>iterations with a list</term> + <listitem> + <para> + it is possible to use a list <literal>L</literal> with a <link linkend="for">for</link> loop: + <literal>for e=L,...,end</literal> is a loop with <literal>length(L)</literal> + iterations, the loop variable <literal>e</literal> being equal to <literal>L(i)</literal> + at the <literal>i</literal>-th iteration. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Remarks</title> + <para> + Scilab provides also other kinds of list, the <link linkend="tlist">tlist</link> type (typed list) and + the <link linkend="mlist">mlist</link> type which are useful to define a new data type with operator + <link linkend="overloading">overloading</link> facilities (<link linkend="hypermatrices">hypermatrices</link> which are + multidimensional arrays in Scilab are in fact <emphasis>mlist</emphasis>). + </para> + <para> + Matlab <emphasis>struct</emphasis> are also available. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +l = list(1,["a" "b"]) // declaration of a basic list with a double & a vector of two strings +size(l) // Size is 2 +// l(0) - Does not exist! +l(1) // Access to the double value +l(2) // Access to the vector of strings +size(l(2)) // Size is 1,2 + +l(0) = "foo" // Insert at the beginning of the list +// l(0) - still does not exist +l(1) // Is "foo" + +l($+1) = "hello" // Insert at the end +l(2) = "toto" // Override my double +l(3) = rand(1,2) // Override my vector of string + +l(3) = null() // Remove the third element + +lbis = list("gewurtz", "caipirina" ,"debug") // Declare a new list +lter = lstcat(l,lbis) // Merge the two list +size(lter) - size(lbis) - size(l) // must be zero + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="lstcat">lstcat</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="size">size</link> + </member> + <member> + <link linkend="length">length</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/lstcat.xml b/modules/data_structures/help/en_US/lstcat.xml new file mode 100755 index 000000000..220c778c0 --- /dev/null +++ b/modules/data_structures/help/en_US/lstcat.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="lstcat"> + <refnamediv> + <refname>lstcat</refname> + <refpurpose>list concatenation</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>lc = lstcat(l1, ..., ln)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>li</term> + <listitem> + <para>a list or any other type of variable</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lc</term> + <listitem> + <para>a list</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>lc = lstcat(l1, ..., ln)</literal> concatenates components of <varname>li</varname> lists in a + single list <varname>lc</varname>. If the <varname>li</varname> are other type of variables they are simply + added to the resulting list. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +lstcat(list(1,2,3),33,list('foo',%s)) +lstcat(1,2,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/makecell.xml b/modules/data_structures/help/en_US/makecell.xml new file mode 100755 index 000000000..622f87b46 --- /dev/null +++ b/modules/data_structures/help/en_US/makecell.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="makecell"> + <refnamediv> + <refname>makecell</refname> + <refpurpose>Creates a cell array. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>s = makecell(dims,a1,a2,...an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para> + a vector with positive integer elements, the cell array dimension + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>a1,a2,...,an</term> + <listitem> + <para> + Sequence of Scilab variables, <literal>n</literal> must be equal to <literal>prod(dims)</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para> + resulting cell array + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>s= makecell(dims,a1,a2,...an)</literal> creates a cell + array of dimensions given by <literal>dims</literal> with the + given input arguments. The <literal>ai</literal> are stored + along the last dimension first. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +makecell([2,3],1,2,3,'x','y','z') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/matrices.xml b/modules/data_structures/help/en_US/matrices.xml new file mode 100755 index 000000000..c64667070 --- /dev/null +++ b/modules/data_structures/help/en_US/matrices.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2012 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="matrices"> + <refnamediv> + <refname>matrices</refname> + <refpurpose>Scilab objects, matrices in Scilab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matrices are basic objects defined in Scilab. + They can be defined as follows: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +E=[e11,e12,...,e1n; + e21,e22,...,e2n; + .... + em1,em2,...,emn]; + ]]></programlisting> + <para> + Entries <literal>eij</literal> can be real or complex numbers, polynomials, + rationals, strings, booleans. + </para> + <para> + Vectors are seen as matrices with one row or one column. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +E=[1,2;3,4] +E=[%T,%F;1==1,1~=1] +s=poly(0,'s'); +E=[s,s^2;1,1+s] +E=[1/s,0;s,1/(s+1)] +E=['A11','A12';'A21','A22'] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="poly">poly</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="boolean">boolean</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="empty">empty</link> + </member> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + <member> + <link linkend="testmatrix">testmatrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/mlist.xml b/modules/data_structures/help/en_US/mlist.xml new file mode 100755 index 000000000..531ca88c8 --- /dev/null +++ b/modules/data_structures/help/en_US/mlist.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="mlist"> + <refnamediv> + <refname>mlist</refname> + <refpurpose>Scilab object, matrix oriented typed list + definition + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mlist(typ, a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>a vector of character strings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + any Scilab object (<literal>matrix</literal>, <literal>list</literal>, <literal>string</literal>, ...). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <link linkend="mlist">mlist</link> object is very similar to <link linkend="tlist">tlist</link> object. + The only difference concerns the <link linkend="extraction">extraction</link> and <link linkend="insertion">insertion</link> syntax: + if <literal>M</literal> is an <literal>mlist</literal>, for any index <literal>i</literal> which is + not a field name, <literal>M(i)</literal> is no more the <literal>i</literal>-th + field of the list. + </para> + <para> + The semantic of the extraction and insertion syntax should be given by + an <link linkend="overloading">overloading</link> function. + </para> + <para> + The overloading function for extraction syntax <literal>b=a(i1, ..., in)</literal> + has the following calling sequence: <literal>b=%<type_of_a>_e_(i1, ..., in, a)</literal> + </para> + <para>and the syntax + <literal>[x1, ..., xm]=a(i1, ..., in)</literal> has the following calling sequence: + <literal>[x1, ..., xm]=%<type_of_a>_e_(i1, ..., in,a)</literal> + </para> + <para/> + <para> The overloading function associated to the insertion syntax + <literal>a(i1, ..., in)=b</literal> has the following calling sequence: + <literal>a=%<type_of_b>_i_<type_of_a>(i1, ..., in, b, a)</literal>. + </para> + <para/> + <para> + <literal>mlist</literal> fields must then be designed by their names. They can also be + handled using the <function>getfield</function> and <function>setfield</function> + functions. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +//define display +function %V_p(M),disp(M.name+':'+string(M.value)),endfunction + +//define extraction operation +function r=%V_e(varargin) + M=varargin($) + r=mlist(['V','name','value'],M.name(varargin(1:$-1)),M.value(varargin(1:$-1))) +endfunction +M(2,:) // the second row of M +M.value + +//define insertion operations +function M=%V_i_V(varargin) + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N.value + M.name(varargin(1:$-2))=N.name +endfunction +M(1,1)=M(2,2) + +function M=%s_i_V(varargin) //insertion of a regular matrix into a V matrix + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N + M.name(varargin(1:$-2))=emptystr(N) +endfunction +M(1,1)=44 + +//tlist case +M=tlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +M(2) +M(2)='a'+string([1 2;3 4]) + +M('name') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/null.xml b/modules/data_structures/help/en_US/null.xml new file mode 100755 index 000000000..8e5ad8e2c --- /dev/null +++ b/modules/data_structures/help/en_US/null.xml @@ -0,0 +1,35 @@ +<?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="null"> + <refnamediv> + <refname>null</refname> + <refpurpose>delete an element in a list</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>l(i)=null()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Deletion of objects inside a list. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +l=list(1,"foo",3); +l(2)=null() // get list(1,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="clear">clear</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/rlist.xml b/modules/data_structures/help/en_US/rlist.xml new file mode 100755 index 000000000..31f279b38 --- /dev/null +++ b/modules/data_structures/help/en_US/rlist.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="rlist"> + <refnamediv> + <refname>rlist</refname> + <refpurpose>Scilab rational fraction function definition</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[r] = rlist() + [r] = rlist(N, D [,dom]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>N,D</term> + <listitem> + <para>polynomial martices.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dom</term> + <listitem> + <para> + character string, or <literal>[]</literal> or a scalar. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + tlist ("r" list) representing the rational fraction. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>rlist(N, D, dom)</literal> is a shortcut to + <literal>tlist(['r','num','den','dt'], N, D, dom)</literal>. + </para> + <para> + To correspond to the domain time of a linear system, <varname>dom</varname> + must be equal to <literal>'c'</literal>,<literal>'d'</literal>, <literal>[]</literal> or a scalar. + One the one hand, to be similar to functions as <link linkend="syslin">syslin</link>, + and on the other, to use some functions as <link linkend="tf2ss">tf2ss</link>, it + is necessary that <varname>dom</varname> is equal to these values. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +s=poly(0,'s'); +W=[1/s,1/(s+1)] +W'*W +Num=[s,s+2;1,s]; +Den=[s*s,s;s,s*s]; +rlist(Num,Den,[]) + +H1=(1+2*s)/s^2; +S1bis=syslin('c',H1) +r=rlist(H1.num, H1.den, 'c') +r == S1bis + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="tf2ss">tf2ss</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/setfield.xml b/modules/data_structures/help/en_US/setfield.xml new file mode 100755 index 000000000..fe691c1d1 --- /dev/null +++ b/modules/data_structures/help/en_US/setfield.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="setfield"> + <refnamediv> + <refname>setfield</refname> + <refpurpose>list field insertion</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>setfield(i, x, l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a matrix of any possible types.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para> + a <literal>list</literal>, <literal>tlist</literal> or <literal>mlist</literal> variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para> + a field index, see <link linkend="insertion">insertion</link> for more details. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function is an equivalent of <code>l(i)=x</code> syntax for field + extraction with the only difference that it also applies to + <literal>mlist</literal> objects. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +l(1)='Changed' +l(0)='Added' +l(6)=['one more';'added'] + +a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists +setfield(3,1:8,a);a // set the field value to 1:8 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="insertion">insertion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/struct.xml b/modules/data_structures/help/en_US/struct.xml new file mode 100755 index 000000000..682b9ebac --- /dev/null +++ b/modules/data_structures/help/en_US/struct.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="struct"> + <refnamediv> + <refname>struct</refname> + <refpurpose>create a struct</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>st = struct(field1, value1, field2, value2, ...)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>field1, field2, ...</term> + <listitem> + <para>strings representing the fields names.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value1, value2, ...</term> + <listitem> + <para> + all data type (<literal>double</literal>, <literal>char</literal>, <literal>int</literal>, ...), representing the fields values. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function returns a struct with the fields names + <varname>field1</varname>, <varname>field2</varname>, ..., and the fields values + corresponding <varname>value1</varname>, <varname>value2</varname>, ... + </para> + <para> + Note that <literal>type(st)</literal> returns <literal>17</literal>, and <literal>typeof(st)</literal> returns <literal>st</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//create a struct date +date_st=struct('day',25,'month' ,'DEC','year',2006) +//change the month +date_st.month='AUG'; +//change the year +date_st.year=1973; +//change the day +date_st.day=19; +//add a new field +date_st.semaine=32 + +//create a structure test +test=struct('list1',list('testlist',1,2), 'matrix1', [1 2 3; 4 5 6], 'boolean1', %t); +//add a polynom +s=poly(0,'s') +test.pol1=s; +//add a state-space +A=[0,1;0,0]; B=[1;1];C=[1,1]; +test.ss1=syslin('c',A,B,C); +//Show the list +test.list1 +getfield(3,test) +//Show the type +type(test) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/tlist.xml b/modules/data_structures/help/en_US/tlist.xml new file mode 100755 index 000000000..a2f417fd5 --- /dev/null +++ b/modules/data_structures/help/en_US/tlist.xml @@ -0,0 +1,165 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="tlist"> + <refnamediv> + <refname>tlist</refname> + <refpurpose>Scilab object and typed list definition. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>tlist(typ, a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>a character string or vector of character strings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + any Scilab object (<literal>matrix</literal>, <literal>list</literal>, + <literal>string</literal>, ...). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>tlist(typ, a1, ..., an)</literal> creates a <literal>typed-list</literal> with elements <varname>ai</varname>'s. The <varname>typ</varname> argument specifies the list type. Such <literal>typed-list</literal> allows the user to define new operations working on these object through Scilab functions. The only difference between <literal>typed-list</literal> and <literal>list</literal> is the value of the type (16 instead of 15). + </para> + <para> + <code>typ(1)</code> specifies the list type (character string used to define soft coded operations). + </para> + <para> + If specified <code>typ(i)</code> may give the <literal>(i+1)</literal>-th element formal name. + </para> + <para> + Standard Operations on <literal>list</literal> work similarly for <literal>typed-list</literal>: + </para> + <para> + extraction: + </para> + <para> + <literal>[x, y, z, ...]=l(v)</literal> where <literal>v</literal> is a vector of indices; + <literal>[x, y, z]=l(:)</literal> extracts all the elements. + </para> + <para> + insertion: + </para> + <para> + <literal>l(i)=a</literal> + </para> + <para> + deletion: + </para> + <para> + <code>l(i)=null()</code> removes the <literal>i</literal>-th + element of the <literal>tlist</literal> <literal>l</literal>. + <note> + Note that the semantics of <code>l.x=null()</code> is undefined, but a definition can be given through the <link linkend="overloading">overloading</link> mechanism. + </note> + </para> + <para> + display. + </para> + <para> + Moreover if <code>typ(2:n+1)</code> are specified, user may + point elements by their names. + </para> + <para> + We give below examples where <literal>tlist</literal> are used. + </para> + <para> + Linear systems are represented by specific <literal>typed-list</literal> e.g. a + linear system <literal>[A,B,C,D]</literal> is represented by the <literal>tlist</literal> + <code>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</code> + and this specific list may be created by the function <function>syslin</function>. + </para> + <para> + <code>Sys(2)</code>, <code>Sys('A')</code> or <code>Sys.A</code> is the state-matrix and <code>Sys('dt')</code> or <code>Sys.dt</code> is the time domain. + </para> + <para> + A rational matrix <literal>H</literal> is represented by the <literal>typed-list</literal> + <code>H=rlist(Num,Den,[])</code> where <literal>Num</literal> and <literal>Den</literal> are two + polynomial matrices and a continuous time linear system with + transfer matrix <literal>H</literal> may be created by <code>syslin('c',H)</code>. + </para> + <para> + <code>H(2)</code>, <code>H('num')</code> or <code>H.num</code> is the transfer matrix numerator. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// tlist creation +t = tlist(["listtype","field1","field2"], [], []); +t.field1(1) = 10; +t.field1(2) = 20; +t.field2(1) = "Scilab"; +t.field2(2) = "tlist"; +t.field2(3) = "example"; + +// Fields contents display +disp(t.field1) +disp(t.field2) + +// Generic tlist display +disp(t) + +// Overloading display for this type of tlist +function %listtype_p(mytlist) + f = fieldnames(mytlist); + + // typeof(mytlist) <=> f(1) + mprintf("Displaying a tlist of type: %s\n", typeof(mytlist)); + + mprintf("\n"); + + mprintf("-- Field ''%s'' --\n", f(1)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(1)))); + + mprintf("\n"); + + mprintf("-- Field ''%s'' --\n", f(2)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(2)))); +endfunction + +// Display using overloading function +disp(t) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="percent">percent</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/type.xml b/modules/data_structures/help/en_US/type.xml new file mode 100755 index 000000000..25af7d965 --- /dev/null +++ b/modules/data_structures/help/en_US/type.xml @@ -0,0 +1,251 @@ +<?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="type"> + <refnamediv> + <refname>type</refname> + <refpurpose>returns the type of a variable</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[i]=type(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a Scilab object.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>an integer.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>type(x)</code> returns an integer which is the type of <varname>x</varname> as following: + </para> + <variablelist> + <varlistentry> + <term>1</term> + <listitem> + <para>a real or complex matrix of double.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + a <link linkend="poly">polynomial matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + a <link linkend="matrices">boolean matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>5</term> + <listitem> + <para> + a <link linkend="sparse">sparse matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>6</term> + <listitem> + <para> + a <link linkend="sparse">sparse boolean matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para>Matlab sparse matrix</para> + </listitem> + </varlistentry> + <varlistentry> + <term>8</term> + <listitem> + <para> + a matrix of <link linkend="int8">integers</link> stored on 1 (<literal>int8</literal>), 2 (<literal>int16</literal>) or 4 (<literal>int32</literal>) bytes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>9</term> + <listitem> + <para> + a matrix of <link linkend="graphics_entities">graphic handles</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>10</term> + <listitem> + <para> + a matrix of <link linkend="strings">character strings</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>11</term> + <listitem> + <para> + an un-compiled function (Scilab code). A function created with <link linkend="deff">deff</link> with argument <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>13</term> + <listitem> + <para> + a compiled <link linkend="function">function</link> (Scilab code). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>14</term> + <listitem> + <para> + a function <link linkend="library">library</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>15</term> + <listitem> + <para> + a <link linkend="list">list</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>16</term> + <listitem> + <para> + a typed list (<link linkend="tlist">tlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>17</term> + <listitem> + <para> + a matrix oriented typed list (<link linkend="mlist">mlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>128</term> + <listitem> + <para> + a pointer (Use case: <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>129</term> + <listitem> + <para>a size implicit polynomial used for indexing.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>130</term> + <listitem> + <para> + a built-in Scilab function, called also <emphasis role="italic">gateway</emphasis> (C, C++ or Fortran code). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>0</term> + <listitem> + <para>a null variable. It is mainly used internally by + Scilab. If a function has no declared returned argument + like <function>disp</function> when it is called it returns + a null variable. If a function is called with an omitted + argument in the argument list like + <code>foo(a,,b)</code> the missing argument is + assigned to a null variable. + </para> + <para> + <note> + Note that if a null variable is assigned to a name, it is removed. + <code>x=disp(1)</code> deletes <varname>x</varname>. + </note> + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <note> + Please note that, for some variables, <function>type</function> will return <literal>tlist</literal> + or <literal>mlist</literal> due to the internal data structure. This is the case of + <emphasis role="italic">rational</emphasis> and <emphasis role="italic">state-space</emphasis> matrices, + <emphasis role="italic">uitree</emphasis>, <emphasis role="italic">hypermat</emphasis> and <emphasis role="italic">struct</emphasis>. Please considering the use of + <link linkend="typeof">typeof</link> instead. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a=42; +type(a) + +b=%t; +type(b) + +c="foo" +type(c) + +d=sparse([1,2;4,5;3,10],[1,2,3]); +type(d) + +e = tlist(["listtype","field1","field2"], [], []); +type(e) + +f=poly(0,"s"); +type(f) + +g=int8([1 -120 127 312]); +type(g) + +h=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +type(h) + +l = list(1,["a" "b"]); +type(l) + +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']); +type(mymacro) + +deff('[x]=myplus(y,z)','x=y+z','n'); +type(myplus) + +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="inttype">inttype</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/typename.xml b/modules/data_structures/help/en_US/typename.xml new file mode 100755 index 000000000..31c2e611d --- /dev/null +++ b/modules/data_structures/help/en_US/typename.xml @@ -0,0 +1,97 @@ +<?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="typename"> + <refnamediv> + <refname>typename</refname> + <refpurpose>associates a name to variable type</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[types [ [,names]]=typename() + typename(name, type) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>types</term> + <listitem> + <para>an integer column vector: the types codes of each defined data types.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>a column vector of strings: the names associated to type codes.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para>an integer: the type code of new data type.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a string: the name associated to the type code.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function and operator overloading make use of a formal name + associated to data types to form the name of the overloading function + (see <link linkend="overloading">overloading</link>). The <function>typename</function> can be used to handle this + formal names for hard coded data types (the <literal>tlist</literal> or <literal>mlist</literal> + coded data types formal names are defined in an other way, see <link linkend="overloading">overloading</link>). + </para> + <para> + Called without right hand side argument, <function>typename</function> returns + information on defined data types. + </para> + <para> + Called with right hand side argument, <function>typename</function> associates a name + to a data type code. + </para> + <para> + <code>typename('',type)</code> suppress the data type given by its code + <varname>type</varname> out of the table of known data types. + </para> + <para>Number max. of defined types is 50.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[typs,nams]=typename(); +disp("First type (double) : " + string(typs(1)) + " / " + nams(1)); +typename("mytype",1024); +[typs,nams]=typename(); +disp(typs($)) +disp(nams($)) // returns mytype +]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/en_US/typeof.xml b/modules/data_structures/help/en_US/typeof.xml new file mode 100755 index 000000000..21c346e9c --- /dev/null +++ b/modules/data_structures/help/en_US/typeof.xml @@ -0,0 +1,244 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="typeof" xml:lang="en"> + <refnamediv> + <refname>typeof</refname> + <refpurpose>object type</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[t]=typeof(object)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>object</term> + <listitem> + <para>a Scilab object</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>t=typeof(object)</code> returns one of the following + strings: + </para> + <variablelist> + <varlistentry> + <term>"constant"</term> + <listitem> + <para> + if <varname>object</varname> is a real or complex matrix of double. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"polynomial"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="poly">polynomial matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"function"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="function">function</link> (Scilab code). See also <link linkend="deff">deff</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"handle"</term> + <listitem> + <para> + if <varname>object</varname> is an <link linkend="graphics_entities">handle</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"string"</term> + <listitem> + <para> + if <varname>object</varname> is a matrix made of <link linkend="strings">character strings</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="matrices">boolean matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"list"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="list">list</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"rational"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="rational">rational matrix</link> (transfer matrix). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"state-space"</term> + <listitem> + <para> + if <varname>object</varname> is a state-space model (see <link linkend="syslin">syslin</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"sparse"</term> + <listitem> + <para> + if <varname>object</varname> is a (real) <link linkend="sparse">sparse matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean sparse"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="sparse">boolean sparse matrix</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"hypermat"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="hypermatrices">hypermatrix</link> (<literal>N</literal>-dimension array with <literal><![CDATA[N<=3]]></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"st"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="struct">structure</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"ce"</term> + <listitem> + <para> + if <varname>object</varname> is a <link linkend="cell">cell</link> array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"fptr"</term> + <listitem> + <para> + if <varname>object</varname> is a built-in Scilab function, called also <emphasis role="italic">gateway</emphasis> (C, C++ or Fortran code). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"pointer"</term> + <listitem> + <para> + if <varname>object</varname> is a pointer (See an use case: <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"size implicit"</term> + <listitem> + <para> + if <varname>object</varname> is a size implicit polynomial used for indexing. This a purely internal value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"library"</term> + <listitem> + <para> + if <varname>object</varname> is a function <link linkend="library">library</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"int8" or "uint8" or "int16" or "uint16" or "int32" or "uint32"</term> + <listitem> + <para> + if <varname>object</varname> is a matrix of [unsigned] integers stored on 8, 16 or 32 bits. (See <link linkend="int8">int</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <note> + Note that if the <varname>object</varname> is a <link linkend="tlist">tlist</link> or <link linkend="mlist">mlist</link>, <function>typeof</function> will return the first string in the first list entry. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +typeof(1) +typeof(poly(0,'x')) + +typeof(1/poly(0,'x')) +typeof(%t) + +w=sprand(100,100,0.001); +typeof(w) +typeof(w==w) + +deff('y=f(x)','y=2*x'); +typeof(f) + +L=tlist(['V','a','b'],18,'Scilab'); +typeof(L) + +typeof(corelib) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="strings">strings</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="poly">poly</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/addchapter.sce b/modules/data_structures/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..2de3e8b9a --- /dev/null +++ b/modules/data_structures/help/fr_FR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Structures",SCI+"/modules/data_structures/help/fr_FR",%T); + diff --git a/modules/data_structures/help/fr_FR/boolean.xml b/modules/data_structures/help/fr_FR/boolean.xml new file mode 100755 index 000000000..ab4e253a4 --- /dev/null +++ b/modules/data_structures/help/fr_FR/boolean.xml @@ -0,0 +1,73 @@ +<?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="boolean"> + <refnamediv> + <refname>boolean</refname> + <refpurpose>Objets Scilab, variables booléennes et opérateurs & | ~ </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Une variable booléenne est <literal>%T</literal> (pour "vrai"="true") ou <literal>%F</literal> (pour "faux"). + Ces variables permettent de définir des matrices de booléens avec la syntaxe habituelle. Ces matrices booléennes peuvent être manipulées comme des matrices ordinaires pour les opérations d'extraction/insertion et de concaténation. Notez que les autres opérations usuelles (<literal>+, *, -, ^,</literal> etc.) ne sont pas définies pour les matrices booléennes. Les seuls opérateurs valides sont les suivants : + </para> + <variablelist> + <varlistentry> + <term>~b</term> + <listitem> + <para> + est la négation logique élément par élément de la matrice booléenne <literal>b</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1&b2</term> + <listitem> + <para> + est la conjonction (et) logique élément par élément de <literal>b1</literal> et <literal>b2</literal> (matrices). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1|b2</term> + <listitem> + <para> + est la disjonction (ou) logique élément par élément de <literal>b1</literal> et <literal>b2</literal> (matrices). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Les variables booléennes peuvent être utilisées comme indice pour les matrices et les vecteurs.</term> + <listitem> + <para> + Par exemple <literal>a([%T,%F,%T],:)</literal> renvoie la sous-matrice composée des lignes <literal>1</literal> et <literal>3</literal> de <literal>a</literal>. Les matrices booléennes peuvent être creuses. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +[1,2]==[1,3] +[1,2]==1 +a=1:5; a(a>2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="matrices">matrices</link> + </member> + <member> + <link linkend="or">or</link> + </member> + <member> + <link linkend="and">and</link> + </member> + <member> + <link linkend="not">not</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/fieldnames.xml b/modules/data_structures/help/fr_FR/fieldnames.xml new file mode 100755 index 000000000..6ad10a2d1 --- /dev/null +++ b/modules/data_structures/help/fr_FR/fieldnames.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * Copyright (C) 2010 - Digiteo - Vincent LIARD + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="fieldnames"> + <refnamediv> + <refname>fieldnames</refname> + <refpurpose>récupère le nom des champs d'une tlist, d'une mlist ou + d'une struct + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>f = fieldnames(lst)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>lst</term> + <listitem> + <para>Une variable de type tlist, mlist ou struct.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>Un vecteur colonne de chaînes de caractères + représentant les noms des champs. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + La fonction <literal>fieldnames</literal> retourne le nom des + champs d'une tlist, mlist ou + struct. <literal>fieldnames</literal> ne fonctionne pas sur le + type cell. + </para> + <para> + Comme expliqué dans les documentations de <link linkend="rational">rational</link> et + <link linkend="syslin">syslin</link>, certains objets de Scilab sont construits à partir + de tlist (ou rlist). Autrement dit, la fonction <function>fieldnames</function> avec ceux-ci en paramètres + d'entrée va retourner comme résultat la forme générique de ces objets. Par exemple, pour un objet + de type <link linkend="rational">rational</link>, la fonction va renvoyer "num", "den" et "dt". + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"> + fieldnames(tlist(['listtype', 'f1', 'f2'], [], [])) + fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4])) + fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006)) + obj.x = 3; + obj.y = 3; + fieldnames(obj) + fieldnames(1/%s) + fieldnames(tf2ss(1/%s)) + </programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="struct">struct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/getfield.xml b/modules/data_structures/help/fr_FR/getfield.xml new file mode 100755 index 000000000..8d0e65412 --- /dev/null +++ b/modules/data_structures/help/fr_FR/getfield.xml @@ -0,0 +1,63 @@ +<?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="getfield"> + <refnamediv> + <refname>getfield</refname> + <refpurpose>extraction d'un champ d'une liste </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[x,...]=getfield(i,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>x </term> + <listitem> + <para>matrice de tout type + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>l </term> + <listitem> + <para>variable de type list, tlist ou mlist + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i </term> + <listitem> + <para> + indice du champ, voir <literal>extraction</literal> pour plus de détails + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Cette fonction est un équivalent de la syntaxe <literal>[x,...]=l(i)</literal> pour l'extraction de champs avec la seule différence qu'elle s'applique aussi aux objets de type <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +[a,b]=getfield([3 2],l) + +a=hypermat([2,2,2],rand(1:2^3));// les hypermatrices sont stockées dans des mlist +a(1) // le terme a(1,1,1) +getfield(1,a) // le premier champ de la mlist + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/hypermat.xml b/modules/data_structures/help/fr_FR/hypermat.xml new file mode 100755 index 000000000..45a6b1504 --- /dev/null +++ b/modules/data_structures/help/fr_FR/hypermat.xml @@ -0,0 +1,77 @@ +<?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="hypermat"> + <refnamediv> + <refname>hypermat</refname> + <refpurpose>initialisation d'une matrice à N dimensions </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>M=hypermat(dims [,v])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>dims </term> + <listitem> + <para>vecteur des dimensions de l'hypermatrice + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>v </term> + <listitem> + <para> + vecteur des termes de l'hypermatrice (valeur par défaut <literal>zeros(prod(dims),1)</literal>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Initialisation d'une matrice à N dimensions dont les dimensions sont données dans le vecteur dims + et dont les termes sont éventuellement donnés dans un vecteur optionnel <literal>v</literal>. + </para> + <para> + La structure de données M contient un champ <literal>M('dims')</literal> contenant les dimensions de l'hypermatrice et un champ contenant le vecteur des termes <literal>M('entries')</literal>, rangés tel que l'indice + le plus à gauche varie en premier : + <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal> + <para> + Attention: Si vous construisez votre propre <literal>hypermat</literal>, vous devez faire attention. L'entrée M('dims') doit être un vecteur ligne alors que l'entrée M('entries') doit être un vecteur colonne. + </para> + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +M = hypermat([2 3 2 2],1:24) +disp(size(M('dims'))) +disp(size(M('entries'))) + +M_own = mlist(['hm','dims','entries']); +M_own('dims') = [2 3 2 2]; +M_own('entries') = [1:24]'; +disp(size(M_own('dims'))) +disp(size(M_own('entries'))) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/hypermatrices.xml b/modules/data_structures/help/fr_FR/hypermatrices.xml new file mode 100755 index 000000000..5a07657e1 --- /dev/null +++ b/modules/data_structures/help/fr_FR/hypermatrices.xml @@ -0,0 +1,69 @@ +<?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="hypermatrices"> + <refnamediv> + <refname>hypermatrices</refname> + <refpurpose>Objet Scilab, matrices à N dimensions </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Le type Hypermatrice permet de manipuler des tableaux multidimensionnels. + Ce type d'objet peut être défini par extension des matrices 2D comme ceci : + </para> + <para> + a=[1 2;3 4];a(:,:,2)=rand(2,2) + </para> + <para> + ou directement en utilisant la fonction <literal>hypermat</literal>. + </para> + <para> + Les termes peuvent être réels, complexes, polynômiaux, rationnels, booléens + ou de type chaîne de caractères. + </para> + <para> + Les Hypermatrices sont des <literal>mlists</literal> : + <literal>mlist(['hm','dims','entries'],sz,v)</literal> où <literal>sz</literal> est + le vecteur ligne des dimensions et <literal>v</literal> le vecteur colonne des termes (rangés tel que + l'indice le plus à gauche varie en premier). + </para> + <para>NOTES: le nombre de dimensions des hypermatrices dont les dimensions les plus à droite sont egales + à 1 est automatiquement réduit. Une hypermatrice n'ayant que 2 dimensions + est automatiquement transformée en une matrice standard (de type 1). + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +a(1,1,1,1:2)=[1 2] +a=[1 2;3 4];a(:,:,2)=rand(2,2) +a(1,1,:) + +size(a) + +a(:,:,1) //dimensionality reduction +type(a(:,:,1)) + +[a a] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="hypermat">hypermat</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/iscell.xml b/modules/data_structures/help/fr_FR/iscell.xml new file mode 100755 index 000000000..cbd10a97c --- /dev/null +++ b/modules/data_structures/help/fr_FR/iscell.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscell" xml:lang="en"> + <refnamediv> + <refname>iscell</refname> + <refpurpose>Check if a variable is a cell array</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>bool = iscell(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Scilab variable</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>A boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>iscell(x)</literal> returns true if x is a cell array + and false otherwise. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +iscell(1) + +iscell(cell()) + +c = cell(1,2); +c(1).entries="Scilab"; +c(2).entries=datenum(); +iscell(c) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/iscellstr.xml b/modules/data_structures/help/fr_FR/iscellstr.xml new file mode 100755 index 000000000..f98ff325d --- /dev/null +++ b/modules/data_structures/help/fr_FR/iscellstr.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscellstr" xml:lang="fr"> + <refnamediv> + <refname>iscellstr</refname> + <refpurpose>Vérifie si une variable est une cell de chaînes de + caractères + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>bool = iscellstr(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Variable Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>Un booléen</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>iscellstr(x)</literal> retourne vrai si x est une cell de + chaînes de caractères et faux sinon. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +iscellstr(1) + +iscellstr(cell()) + +iscellstr(cell(3)) + +strcell = cell(3,1); +strcell(1).entries="Scilab"; +strcell(2).entries="iscellstr"; +strcell(3).entries="help"; +iscellstr(strcell) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/isfield.xml b/modules/data_structures/help/fr_FR/isfield.xml new file mode 100755 index 000000000..e0deb48f1 --- /dev/null +++ b/modules/data_structures/help/fr_FR/isfield.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org> + * Copyright (C) 2013 - Samuel GOUGEON : traduction et extension aux tlist et mlist + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isfield"> + <refnamediv> + <refname>isfield</refname> + <refpurpose>teste l'existence d'un ou plusieurs champs pour une structure, une tlist ou une mlist</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>bool = isfield(s, fieldname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>un tableau de structures, ou une liste typée tlist ou mlist</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fieldname</term> + <listitem> + <para>matrice de textes : noms des champs à détecter</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para> + matrice booléenne (même format que <varname>fieldname</varname>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + bool(i,j) vaut <constant>%t</constant> si le champ nommé <varname>fieldname(i,j)</varname> existe pour le tableau de structure ou tlist ou mlist <varname>s</varname>(indépendamment de la valeur éventuellement affectée à ce champ). Si <varname>s</varname> est une structure, son champ caché <code class="literal">dims</code> est ignoré. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +s = struct("field_1",123,"field_2",456,"field_4",789) + +// Test pour un nom de champ unique : +isfield( s , "field_1" ) + +// Test simultané pour plusieurs noms de champs : +isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] ) + +// Test sur une liste typée tlist: +s = tlist(["test" "t" "n","","p"], "Hello", %pi, "anonymous", (1-%z)^3) +isfield( s, ["b" "t" ""]) + // => F T T (la présence de champs anonymes peut être détectée) + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="definedfields">definedfields</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Historique</title> + <revhistory> + <revision> + <revnumber>5.5</revnumber> + <revremark> + Extension aux mlist et tlist + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/isstruct.xml b/modules/data_structures/help/fr_FR/isstruct.xml new file mode 100755 index 000000000..c4e86a603 --- /dev/null +++ b/modules/data_structures/help/fr_FR/isstruct.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isstruct" xml:lang="fr"> + <refnamediv> + <refname>isstruct</refname> + <refpurpose>Vérifie si une variable est une structure</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>bool = isstruct(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Variable Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>Un booléen</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>isstruct(x)</literal> retourne vrai si x est une structure + et faux sinon. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +isstruct(1) + +isstruct(cell()) + +isstruct(struct("name","Scilab", "version", getversion())) + +info.name="Scilab"; +info.function="isstruct"; +info.module="help"; +isstruct(info) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/list.xml b/modules/data_structures/help/fr_FR/list.xml new file mode 100755 index 000000000..23ca2c3d5 --- /dev/null +++ b/modules/data_structures/help/fr_FR/list.xml @@ -0,0 +1,161 @@ +<?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="list"> + <refnamediv> + <refname>list</refname> + <refpurpose>Objet Scilab, Définition d'une liste </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>list(a1,....an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Crée une <literal>liste</literal> avec les éléments <literal>ai</literal> + qui sont des objets Scilab arbitraires (<literal>matrice, + liste, ... + </literal> + ). Le numéro de type des objets <emphasis>liste</emphasis> + (renvoyé par la fonction <literal>type</literal>) est 15. + </para> + <para> + <literal>list()</literal> crée une liste vide (0 élément). + </para> + </refsection> + <refsection> + <title>Operations sur les listes</title> + <variablelist> + <varlistentry> + <term>extraction</term> + <listitem> + <para> + <literal>[x,y,z...]=L(v)</literal> où <literal>v</literal> est un vecteur d'indices; + <literal>[x,y,z]=L(:)</literal> extrait tous les éléments. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>insertion en position i</term> + <listitem> + <para> + <literal>L(i)=a</literal> . Remarque : l'opération <literal>L(i)=a</literal> + avec <emphasis>i > 1 + size(L)</emphasis> ne génère pas d'erreur les + entrées en position <emphasis>1 + size(L), ..., i-1</emphasis> étant + alors <emphasis>indéfinies</emphasis>. Par contre l'extraction d'un élément + <emphasis>indéfini</emphasis> en génère une. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ajouter un élément en queue de liste</term> + <listitem> + <para> + <literal>L($+1)=e</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ajouter un élément en tête de liste</term> + <listitem> + <para> + <literal>L(0)=e</literal>. (remarque : après cette opération <literal>e</literal> est + en position 1, la position des éléments initiaux de la liste étant + décalée vers la droite). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>suppression</term> + <listitem> + <para> + <literal>L(i)=null()</literal> supprime l'élément en position i de la liste <literal>L</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>concaténation de deux listes</term> + <listitem> + <para> + <literal>L3 = lstcat(L1,L2)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>nombre d'éléments d'une liste</term> + <listitem> + <para> + vous pouvez utiliser <literal>nb_elm = size(L)</literal> + ou encore <literal>nb_elm = length(L)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>itérer avec une liste</term> + <listitem> + <para> + il est possible d'utiliser une liste <literal>L</literal> pour piloter une boucle <link linkend="for">for</link> : + <literal>for e=L,...,end</literal> est une boucle avec <literal>length(L)</literal> + itérations, la variable <literal>e</literal> de la boucle prenant la valeur <literal>L(i)</literal> + à l'itération i. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Remarques</title> + <para> + Scilab propose deux autres sortes de liste, les <link linkend="tlist">tlist</link> (pour listes typées) + et les <link linkend="mlist">mlist</link> qui sont très utiles pour définir de nouveaux types de + données avec possibilité de surcharge des opérateurs classiques (voir <link linkend="overloading">overloading</link>). + Les tableaux multidimensionnels de scilab (les <link linkend="hypermatrices">hypermatrices</link>) sont en fait + codés comme des <emphasis>mlist</emphasis>. + </para> + <para> + Les structures Matlab (<emphasis>struct</emphasis>) sont aussi utilisables. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +l = list(1,["a" "b"]) +l(0) = "foo" +l($+1) = "hello" +l(2) = "toto" +l(3) = rand(1,2) +l(3) = null() +lbis = list("gewurtz", "caipirina" ,"debug") +lter = lstcat(l,lbis) +size(lter) - size(lbis) - size(l) // doit être nul + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="lstcat">lstcat</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="size">size</link> + </member> + <member> + <link linkend="length">length</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/lstcat.xml b/modules/data_structures/help/fr_FR/lstcat.xml new file mode 100755 index 000000000..f341c1725 --- /dev/null +++ b/modules/data_structures/help/fr_FR/lstcat.xml @@ -0,0 +1,51 @@ +<?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="lstcat"> + <refnamediv> + <refname>lstcat</refname> + <refpurpose>concaténation de listes </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>lc=lstcat(l1,..ln)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>li </term> + <listitem> + <para>une liste ou une variable de type indifférent + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>lc </term> + <listitem> + <para>une liste + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>lc=lstcat(l1,..ln)</literal> concatène les composantes des listes <literal>li</literal> sous forme d'une liste unique. Si les <literal>li</literal> sont des variables d'un autre type elles sont tout simplement ajoutées comme termes supplémentaires dans la liste. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +lstcat(list(1,2,3),33,list('foo',%s)) +lstcat(1,2,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/matrices.xml b/modules/data_structures/help/fr_FR/matrices.xml new file mode 100755 index 000000000..6d689a3e2 --- /dev/null +++ b/modules/data_structures/help/fr_FR/matrices.xml @@ -0,0 +1,60 @@ +<?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="matrices"> + <refnamediv> + <refname>matrices</refname> + <refpurpose>Objet Scilab, matrices </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Les matrices sont les objets de base dans Scilab. Elles peuvent être définies de la façon suivante : + </para> + <programlisting role=""><![CDATA[ +E=[e11,e12,...,e1n; + e21,e22,...,e2n; + .... + em1,em2,...,emn]; + ]]></programlisting> + <para> + Les termes <literal>eij</literal> peuvent être des nombres complexes ou réels, des polynômes, + des fraction rationnelles, des chaînes de caractères ou des booléens. + </para> + <para> + Les vecteurs sont vus comme des matrices à une ligne ou une colonne. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +E=[1,2;3,4] +E=[%T,%F;1==1,1~=1] +s=poly(0,'s'); +E=[s,s^2;1,1+s] +E=[1/s,0;s,1/(s+1)] +E=['A11','A12';'A21','A22'] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="poly">poly</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="boolean">boolean</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="empty">empty</link> + </member> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/mlist.xml b/modules/data_structures/help/fr_FR/mlist.xml new file mode 100755 index 000000000..2bcd4817c --- /dev/null +++ b/modules/data_structures/help/fr_FR/mlist.xml @@ -0,0 +1,107 @@ +<?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="mlist"> + <refnamediv> + <refname>mlist</refname> + <refpurpose>Objet Scilab, définition d'une liste + typée + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>mlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>vecteur de chaînes de caractères</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + objet Scilab (<literal>matrice, liste, chaîne...</literal>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Les objets de type <literal>mlist</literal> sont très similaires aux objets + de type <literal>tlist</literal>. Si <literal>M</literal> est de type mlist, pour tout + indice <literal>i</literal> qui n'est pas le nom d'un champ de la liste, + <literal>M(i)</literal> n'est pas le <literal>i</literal>-ème champ de la liste mais + est interprété comme le <literal>i</literal>-ème terme de <literal>M</literal> vu + comme un vecteur. C'est la seule différence entre <literal>mlist</literal> et + <literal>tlist</literal>. + </para> + <para/> + <para>Les champs des mlist doivent donc être manipulés par leur noms. Il + peuvent aussi être manipulés avec les fonctions <literal>getfield</literal> et + <literal>setfield</literal>. + </para> + <para/> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +M=mlist(['V','name','value'],['a','b','c'],[1 2 3]); + +// définition de la fonction d'affichage +deff('%V_p(M)','disp(M.name+'':''+string(M.value))') + +// définition de la fonction d'extraction +deff('r=%V_e(i,M)',.. +'r=mlist([''V'',''name'',''value''],M.name(i),M.value(i))') +M(2) // Le deuxième terme du vecteur M +M.value + +// définition de M comme une tlist +M=tlist(['V','name','value'],['a','b','c'],[1 2 3]); +M(2) + +M('name') + +// avec deux indices +M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2;3 4]); +deff('r=%V_e(varargin)',[ + 'M=varargin($)'; + 'H=[''V'',''name'',''value'']' + 'r=mlist(H,M.name(varargin(1:$-1)),M.value(varargin(1:$-1)))']) + +M(:,2) + +// tableau multidimensionnel +str=['a','b','c','d','e','f','g','h']; +n=hypermat([2,2,2],str); +v=hypermat([2,2,2],1:8); +M=mlist(['V','name','value'],n,v); +M(1,1:2,2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/null.xml b/modules/data_structures/help/fr_FR/null.xml new file mode 100755 index 000000000..8e32cf321 --- /dev/null +++ b/modules/data_structures/help/fr_FR/null.xml @@ -0,0 +1,35 @@ +<?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="null"> + <refnamediv> + <refname>null</refname> + <refpurpose>suppression d'un terme d'une liste </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>l(i)=null()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Suppression d'un terme d'une liste + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +l=list(1,"foo",3); +l(2)=null() // get list(1,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="clear">clear</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/rlist.xml b/modules/data_structures/help/fr_FR/rlist.xml new file mode 100755 index 000000000..6d57967d0 --- /dev/null +++ b/modules/data_structures/help/fr_FR/rlist.xml @@ -0,0 +1,87 @@ +<?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="rlist"> + <refnamediv> + <refname>rlist</refname> + <refpurpose>définition d'une fraction rationnelle </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[r] = rlist() + [r] = rlist(N, D [,dom]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>N,D</term> + <listitem> + <para>martices polynomiales.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dom</term> + <listitem> + <para> + chaîne de caractères ou <literal>[]</literal>, ou un scalaire. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + tlist (liste de type "r") représentant la fraction rationnelle. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>[r] = rlist(N, D, dom)</literal> est équivalent à + <literal>tlist(['r','num','den','dt'], N, D, dom)</literal> + </para> + <para> + Pour correspondre au domaine temporel d'un système linéaire, <varname>dom</varname> doit être égale à + <literal>'c'</literal>,<literal>'d'</literal>, <literal>[]</literal> ou à un scalaire. + D'une part, par analogie à des fonctions comme <link linkend="syslin">syslin</link>, + et d'autre part, pour être compatible avec des fonctions comme <link linkend="tf2ss">tf2ss</link>, + il est nécessaire que <varname>dom</varname> soit égale à ces valeurs. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +s=poly(0,'s'); +W=[1/s,1/(s+1)] +W'*W +Num=[s,s+2;1,s]; +Den=[s*s,s;s,s*s]; +rlist(Num,Den,[]) + +H1=(1+2*s)/s^2; +S1bis=syslin('c',H1) +r=rlist(H1.num, H1.den, 'c') +r == S1bis + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="tf2ss">tf2ss</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/setfield.xml b/modules/data_structures/help/fr_FR/setfield.xml new file mode 100755 index 000000000..c31cb6d61 --- /dev/null +++ b/modules/data_structures/help/fr_FR/setfield.xml @@ -0,0 +1,64 @@ +<?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="setfield"> + <refnamediv> + <refname>setfield</refname> + <refpurpose>insertion dans un champ d'une liste </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>setfield(i,x,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>x </term> + <listitem> + <para>matrice de tout type + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>l </term> + <listitem> + <para>variable de type list, tlist ou mlist + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i </term> + <listitem> + <para> + indice de champ, voir <literal>insertion</literal> pour plus de détails. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Cette fonction est équivalente à la syntaxe <literal>l(i)=x</literal> pour l'extraction avec la seule différence qu'elle s'applique aussi aux objets de type <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +l(1)='change' +l(0)='ajoute' +l(6)=['un de plus';'ajoute'] + +a=hypermat([2,2,2],rand(1:2^3));// les hypermatrices sont des mlist +setfield(3,1:8,a);a // affectation du champ + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="insertion">insertion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/struct.xml b/modules/data_structures/help/fr_FR/struct.xml new file mode 100755 index 000000000..fedbf1653 --- /dev/null +++ b/modules/data_structures/help/fr_FR/struct.xml @@ -0,0 +1,91 @@ +<?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="struct"> + <refnamediv> + <refname>struct</refname> + <refpurpose>creer une struct</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>st=struct(field1,value1,field2,value2, ...)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>field1, field2, ...</term> + <listitem> + <para>noms des champs (chaines de caracteres)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value1, value2, ...</term> + <listitem> + <para>les valeurs des champs (acceptent tous types de données + (double, matrice de doubles,des cells, char, ...) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + La fonction <function>struct</function> retourne une struct avec des noms de + champs <varname>field1</varname>, <varname>field2</varname>, .., et dont les valeurs + respectives sont <varname>value1</varname>, <varname>value2</varname>, + ... + </para> + <para> + Notez que <literal>type(st)</literal> retourne <literal>17</literal> et que <literal>typeof(st)</literal> retourne <literal>st</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +//creer une struct: date les champs sont: 'jour' (valeur: 25), 'mois' (valeur: 'DEC'), 'annee' (valeur: 2006) +date_st=struct('jour',25,'mois','DEC','annee',2006) + +// changer la valeur des champs +date_st.jour=19; +date_st.mois='AOU'; +date_st.annee=1973; + +// ajouter un champ 'semaine' +date_st.semaine=32 + +//creation d'une structure test +test=struct('list1',list('testlist',1,2), 'matrix1', [1 2 3; 4 5 6], 'boolean1', %t); +//ajout d'un polynôme +s=poly(0,'s') +test.pol1=s; +//ajout d'un système linéaire (représentation d'état) +A=[0,1;0,0]; B=[1;1];C=[1,1]; +test.ss1=syslin('c',A,B,C); +//Affichage de la liste +test.list1 +getfield(3,test) +//Affichage du type +type(test) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/tlist.xml b/modules/data_structures/help/fr_FR/tlist.xml new file mode 100755 index 000000000..ca96eafde --- /dev/null +++ b/modules/data_structures/help/fr_FR/tlist.xml @@ -0,0 +1,154 @@ +<?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="tlist"> + <refnamediv> + <refname>tlist</refname> + <refpurpose>Objet Scilab. Définition d'une liste typée </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>tlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>typ </term> + <listitem> + <para>chaîne de caractères ou matrice de chaînes de caractères + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai </term> + <listitem> + <para> + objet Scilab (<literal>matrice, liste, chaîne...</literal>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Crée une <literal>liste typée</literal> avec les éléments <literal>ai</literal>. L'argument <literal>typ</literal> + spécifie le nom du type. L'utilisateur peut redéfinir + les opérateurs et primitives de Scilab pour ces nouveaux objets à l'aide de fonctions Scilab (voir <literal>overloading</literal>). La seule différence entre les listes typées et les listes (voir <literal>list</literal>) + est la valeur numérique du type (16 au lieu de 15). + </para> + <para> + <literal>typ(1)</literal> spécifie le nom du type (cette chaîne de caractères est utilisée dans les noms des fonctions surchargeant les opérateurs et primitives). + </para> + <para> + S'il est spécifié, <literal>typ(i)</literal> donne le nom formel de l'élément <literal>i+1</literal> (voir plus bas dans les exemples). + </para> + <para> + Les opérations standard sur les listes fonctionnent similairement pour les listes typées (tlist). + </para> + <para> + extraction + : <literal>[x,y,z...]=l(v)</literal> ou <literal>v</literal> est un vecteur d'indices; + <literal>[x,y,z]=l(:)</literal> extrait tous les éléments. + </para> + <para> + insertion + : <literal>l(i)=a</literal> + </para> + <para> + suppression : <literal>l(i)=null()</literal> supprime le i-ème + élément de la <literal>tlist l</literal>. A noter que la + sémantique de <literal>l.x=null()</literal> n'est pas définie, + mais qu'il est possible de lui donner un sens par surcharge (voir + <link linkend="overloading">overloading</link>). + </para> + <para> + affichage + </para> + <para> + De plus si les composantes <literal>typ(2:n+1)</literal> sont + spécifiées, les éléments peuvent être désignés par leur noms + formels. + </para> + <para> + Voici quelques exemples d'utilisation des liste typées : + </para> + <para> + Dans Scilab, les systèmes dynamiques linéaires sont définis par une liste typée : + le quadruplet <literal>[A,B,C,D]</literal> est représenté par la tlist + <literal>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</literal> + et cette tlist spécifique est créée par la fonction <literal>syslin</literal>. + </para> + <para> + Sys(2), Sys('A') ou Sys.A est la matrice d'état et Sys('dt') ou Sys.dt est le domaine temporel. + </para> + <para> + Une matrice rationnelle <literal>H</literal> est représentée par la tlist + <literal>H=rlist(Num,Den,[])</literal> où <literal>Num</literal> et <literal>Den</literal> sont deux + matrices polynomiales et un système dynamique linéaire (en temps continu) peut être créé sous la forme d'une + matrice de transfert <literal>H</literal> par <literal>syslin('c',H)</literal>. + </para> + <para> + H(2), H('num') ou H.num est le numérateur de la matrice de transfert + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +// tlist creation +t = tlist(["listtype","field1","field2"], [], []); +t.field1(1) = 10; +t.field1(2) = 20; +t.field2(1) = "Scilab"; +t.field2(2) = "tlist"; +t.field2(3) = "example"; + +// Fields contents display +disp(t.field1) +disp(t.field2) + +// Generic tlist display +disp(t) + +// Overloading display for this type of tlist +function %listtype_p(mytlist) + f = fieldnames(mytlist); + + // typeof(mytlist) <=> f(1) + mprintf("Displaying a tlist of type: %s\n", typeof(mytlist)); + + mprintf("\n"); + + mprintf("-- Field ''%s'' --\n", f(1)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(1)))); + + mprintf("\n"); + + mprintf("-- Field ''%s'' --\n", f(2)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(2)))); +endfunction + +// Display using overloading function +disp(t) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="percent">percent</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/type.xml b/modules/data_structures/help/fr_FR/type.xml new file mode 100755 index 000000000..25b50b5df --- /dev/null +++ b/modules/data_structures/help/fr_FR/type.xml @@ -0,0 +1,262 @@ +<?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="type"> + <refnamediv> + <refname>type</refname> + <refpurpose>Retourne le type d'une variable </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis> i =type(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>x </term> + <listitem> + <para> + objet Scilab + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i </term> + <listitem> + <para>entier + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>type(x)</literal> renvoie un entier donnant le code + numérique du type de <literal>x</literal> définit comme suit + : + </para> + <variablelist> + <varlistentry> + <term>1</term> + <listitem> + <para>matrice réelle ou complexe..</para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + <link linkend="poly">matrice polynomiale</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + <link linkend="matrices">matrice booléenne</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>5</term> + <listitem> + <para> + <link linkend="sparse">matrice creuse</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>6</term> + <listitem> + <para> + <link linkend="sparse">matrice creuse booléenne</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para>matrice creuse au format Matlab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>8</term> + <listitem> + <para> + matrice d'<link linkend="int8">entiers</link> codés + sur 1 (int8), 2 (int16) ou 4 (int32) octets. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>9</term> + <listitem> + <para> + matrice de "<link linkend="graphics_entities">handle</link>" sur les objets + graphiques. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>10</term> + <listitem> + <para> + matrice de <link linkend="strings">chaînes de caractères</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>11</term> + <listitem> + <para>fonction non-compilée (code Scilab). Fonction créée + par <link linkend="deff">deff</link> avec l'argument + 'n'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>13</term> + <listitem> + <para> + <link linkend="function">fonction</link> compilée (code Scilab). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>14</term> + <listitem> + <para>bibliothèque de fonctions.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>15</term> + <listitem> + <para> + <link linkend="list">liste</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>16</term> + <listitem> + <para> + Liste typée (<link linkend="tlist">tlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>17</term> + <listitem> + <para> + liste typée orientée matrice (<link linkend="mlist">mlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>128</term> + <listitem> + <para> + pointeur (Use case: <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>129</term> + <listitem> + <para>polynôme implicite utilisé pour indexer.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>130</term> + <listitem> + <para> + Fonction interne Scilab, aussi appellé <emphasis role="italic">primitive</emphasis> (Code C, C++ ou + Fortran). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>0</term> + <listitem> + <para> + <emphasis role="italic"> variable + nulle + </emphasis> + .Ce type est principalement utilisé en + interne par Scilab. Si une fonction n'a pas pas d'argument + de retour déclaré comme <literal>disp</literal>, quand + elle est appelée elle retourne une <emphasis role="italic"> variable nulle</emphasis>. Si une fonction + est appellée avec un argument de la liste des arguments + d'entrée omis comme <literal>foo(a,,b)</literal> + l'argument manquant est assigné à la <emphasis role="italic"> variable nulle</emphasis>. + </para> + <para> + Note: Si une <emphasis role="italic"> variable + nulle + </emphasis> + est affectée à un nom, ce nom est + supprimé de la liste des variables définies. + <literal>x=disp(1)</literal> détruit + <literal>x</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para>Note: pour certaines variables, à cause de la représentation + interne, <emphasis role="italic">type(x)</emphasis> retournera + tlist (16) ou mlist (17). C'est le cas de <emphasis role="italic">rational</emphasis>, <emphasis role="italic">state-space</emphasis>, +<emphasis role="italic">uitree</emphasis>, <emphasis role="italic">hypermat</emphasis> et <emphasis role="italic">struct</emphasis>. Merci de considérer l'utilisation + de <link linkend="typeof">typeof</link> à la place. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +a=42; +type(a) + +b=%t; +type(b) + +c="foo" +type(c) + +d=sparse([1,2;4,5;3,10],[1,2,3]); +type(d) + +e = tlist(["listtype","field1","field2"], [], []); +type(e) + +f=poly(0,"s"); +type(f) + +g=int8([1 -120 127 312]); +type(g) + +h=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +type(h) + +l = list(1,["a" "b"]); +type(l) + +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']); +type(mymacro) + +deff('[x]=myplus(y,z)','x=y+z','n'); +type(myplus) + +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="inttype">inttype</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/fr_FR/typename.xml b/modules/data_structures/help/fr_FR/typename.xml new file mode 100755 index 000000000..c5010d459 --- /dev/null +++ b/modules/data_structures/help/fr_FR/typename.xml @@ -0,0 +1,96 @@ +<?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="typename"> + <refnamediv> + <refname>typename</refname> + <refpurpose>associe un nom à un type de variable </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[types [ [,names]]=typename() + typename(name,type) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>types </term> + <listitem> + <para>vecteur colonne d'entiers, les codes des types de variables + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>names </term> + <listitem> + <para>vecteur colonne de chaînes de caractères, les noms associés à chaque code + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type </term> + <listitem> + <para>entier, le code d'un nouveau type de variable + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>name </term> + <listitem> + <para>chaîne de caractères, le nom associé au nouveau type + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + La surcharge des opérateurs et primitives utilise des noms formels associés à + chaque type de variable pour former les noms des fonctions de surcharge + (voir <literal>overloading</literal>). <literal>typename</literal> peut être utilisé pour gérer ces noms pour les types natifs de variables (les noms formels pour les types <literal>tlist</literal> ou <literal>mlist</literal> sont définis autrement, pour ceci voir <literal>overloading</literal>). + </para> + <para> + Sans argument d'entrée, <literal>typename</literal> renvoie les informations associées aux types de données déjà définis. + </para> + <para> + Avec les arguments d'entrée, <literal>typename</literal> associe un nom à un code de type de variable. + </para> + <para> + <literal>typename('',type)</literal> supprime le type de donnée défini par le code passé dans <literal>type</literal> dans la table des types de variables connus. + </para> + <para>Nombre max de types defini est 50.</para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +[typs,nams]=typename(); +disp("First type (double) : " + string(typs(1)) + " / " + nams(1)); +typename("mytype",1024); +[typs,nams]=typename(); +disp(typs($)) +disp(nams($)) // retourne mytype +]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/addchapter.sce b/modules/data_structures/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..6a729d528 --- /dev/null +++ b/modules/data_structures/help/ja_JP/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Data Structures",SCI+"/modules/data_structures/help/ja_JP",%T); + diff --git a/modules/data_structures/help/ja_JP/boolean.xml b/modules/data_structures/help/ja_JP/boolean.xml new file mode 100755 index 000000000..03d6adda0 --- /dev/null +++ b/modules/data_structures/help/ja_JP/boolean.xml @@ -0,0 +1,83 @@ +<?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="boolean"> + <refnamediv> + <refname>boolean</refname> + <refpurpose>Scilab オブジェクト, 論理値(boolean)変数および演算子 & | ~ </refpurpose> + </refnamediv> + <refsection> + <title>説明</title> + <para> + 論理値(boolean)変数の値は <literal>%T</literal> (意味: "true") または + <literal>%F</literal> (意味: "false") です. + これらの変数は,論理値の行列を定義する際に通常の構文として使用可能です. + 論理値行列は要素の展開/挿入/結合など通常の行列と同様に操作することができます. + 他の一般的な処理(<literal>+, *, -, ^,</literal>など)は + 論理値行列では定義されないことに注意してください. + 以下の3種類の特別な演算子が論理値行列に関して定義されています: + </para> + <variablelist> + <varlistentry> + <term>~b</term> + <listitem> + <para> + は論理値<literal>b</literal>(行列)の要素毎の否定です. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1&b2</term> + <listitem> + <para> + は<literal>b1</literal> および <literal>b2</literal> (行列)の + 要素毎の論理積(<literal>and</literal>) です. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1|b2</term> + <listitem> + <para> + は<literal>b1</literal> および <literal>b2</literal> (行列)の + 要素毎の論理和(<literal>or</literal>) です. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>論理値変数は行列またはベクトルの添え字として使用できます.</term> + <listitem> + <para> + 例えば, <literal>a([%T,%F,%T],:)</literal>は, + <literal>a</literal>の <literal>1</literal> 行目と<literal>3</literal>行目 + からなる部分行列を返します. + 論理値の疎行列もサポートされています. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +[1,2]==[1,3] +[1,2]==1 +a=1:5; a(a>2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="matrices">matrices</link> + </member> + <member> + <link linkend="or">or</link> + </member> + <member> + <link linkend="and">and</link> + </member> + <member> + <link linkend="not">not</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/cell.xml b/modules/data_structures/help/ja_JP/cell.xml new file mode 100755 index 000000000..b5926fd97 --- /dev/null +++ b/modules/data_structures/help/ja_JP/cell.xml @@ -0,0 +1,153 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="cell" xml:lang="ja"> + <refnamediv> + <refname>cell</refname> + <refpurpose>空行列のセル配列を作成する.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis> + c=cell() + c=cell(m1) + c=cell(m1, m2) + c=cell(m1, m2, ..., mn) + c=cell(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>作成するセル配列の次元のベクトル.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>m1, m2,..</term> + <listitem> + <para>作成するセルの次元.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>空行列のセルを生成,返します.</para> + <variablelist> + <varlistentry> + <term>cell()</term> + <listitem> + <para> + 空行列の <literal>(0,0)</literal> セル配列を返します. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1)</term> + <listitem> + <para> + <literal>(m1,m1)</literal> は空行列のセル配列を返します. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1,m2)</term> + <listitem> + <para> + <literal>(m1,m2) </literal>は空行列のセル配列を返します. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1,m2,..,mn)</term> + <listitem> + <para> + <literal>(m1,m2,..,mn)</literal> は空行列のセル配列を作成します. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(x)</term> + <listitem> + <para> + 最初の次元が<literal>x(1)</literal>, + 2番目の次元が<literal>x(2), ...</literal>となる + 空行列のセル配列を返します. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>注意</title> + <para> + <literal>cell(x) </literal>は + <literal>x</literal>と同じ大きさになりません. + </para> + <para> + <literal>cell()</literal> は + <literal>cell(0)</literal>に等しくなりです. + </para> + <para>A がセル配列の場合, + <literal>A(m1, m2, ..., mn).entries</literal>により + Aの要素の内容にアクセスすることができます. + 式 <literal>A(1,1) = zeros(2,2)</literal> は有効ではなく, + <literal>A(1,1).entries = zeros(2,2)</literal>が正しい構文となります. + </para> + <para>A がセル配列の場合, + <literal>A.dims</literal>によりその次元を得ることができます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +a=cell(3) +b=cell(3,1) +c=cell([2,3,4]) +// Assigning cell entries +b=cell(3,1); +// Assigning the first element of b using the 'entries' field +b(1).entries=1:3 +// Assigning the second element of b using the 'entries' field +b(2).entries='Scilab' +// Assigning the third element of b using the 'entries' field +b(3).entries=poly(1:3,'s') +// Assigning sub-cells +X=cell(3,2); +X(:,1)=b +// Extracting a sub-cell: result is a cell +b(1) +b(1:2) +// Extracting a sub-cell value: result is an array +b(1).entries +// Dimensions of b +b.dims + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="eye">eye</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/definedfields.xml b/modules/data_structures/help/ja_JP/definedfields.xml new file mode 100755 index 000000000..5a236258d --- /dev/null +++ b/modules/data_structures/help/ja_JP/definedfields.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="definedfields"> + <refnamediv> + <refname>definedfields</refname> + <refpurpose>フィールド値が定義済みのリストの添え字を返す</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>k=definedfields(l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>l</term> + <listitem> + <para>リスト , tlist またはmlist 変数.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>k</term> + <listitem> + <para>添え字のベクトル.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>l</literal> が <literal>list</literal> <literal>tlist</literal> + <literal>mlist</literal> の場合, <literal>k=definedfields(l)</literal> は + リストのフィールドが定義済みの添え字<literal>k</literal>を返します. + この関数は未定義のフィールドにアクセスするとエラーとなるため, + 有用です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +l=list(1);l(3)=5 +k=definedfields(l) +t=tlist('x');t(5)=4 +definedfields(t) +m=mlist(['m','a','b']);m.b='sdfgfgd' +definedfields(m) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/fieldnames.xml b/modules/data_structures/help/ja_JP/fieldnames.xml new file mode 100755 index 000000000..53b26cf25 --- /dev/null +++ b/modules/data_structures/help/ja_JP/fieldnames.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="fieldnames"> + <refnamediv> + <refname>fieldnames</refname> + <refpurpose>tlist, mlist または 構造体のフィールド名を取得します</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>f=fieldnames(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>tlistまたは mlist または構造体. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>文字列の列ベクトル</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + この関数は tlist, mlist, cell または構造体のフィールド名を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +clear t; +t.a=1; +t.b=2; +fieldnames(t) +fieldnames(1/%s) +fieldnames(tf2ss(1/%s)) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="mlist">struct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/getfield.xml b/modules/data_structures/help/ja_JP/getfield.xml new file mode 100755 index 000000000..ab676547e --- /dev/null +++ b/modules/data_structures/help/ja_JP/getfield.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="getfield"> + <refnamediv> + <refname>getfield</refname> + <refpurpose>リストのフィールドの展開</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>[x,...]=getfield(i,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>任意の型の行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>list, tlist または mlist変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>フィールド添え字, 詳細は extraction 参照.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + この関数は, フィールド展開用の <literal>[x,...]=l(i)</literal> 構文と等価ですが, + 唯一の違いは, <literal>mlist</literal> オブジェクトにも適用できる + ことです. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +[a,b]=getfield([3 2],l) +a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists +a(1) // the a(1,1,1) entry +getfield(1,a) // the mlist first field + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/hypermat.xml b/modules/data_structures/help/ja_JP/hypermat.xml new file mode 100755 index 000000000..869627e22 --- /dev/null +++ b/modules/data_structures/help/ja_JP/hypermat.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermat"> + <refnamediv> + <refname>hypermat</refname> + <refpurpose>N 次元行列を初期化する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>M=hypermat(dims [,v])</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para>ハイパー行列の次元のベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>v</term> + <listitem> + <para> + ハイパー行列のエントリのベクトル (デフォルト値: <literal>zeros(prod(dims),1)</literal>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 次元をベクトル dims ,要素をオプション引数<literal>v</literal> + で指定してハイパー行列を初期化します. + </para> + <para> + データ構造体 M には,行列次元のベクトル<literal>M('dims')</literal>および + エントリのベクトル<literal>M('entries')</literal> + が含まれています. + このエントリのベクトルでは, + <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal> のように最も左のサブスクリプトがまず変化します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +M=hypermat([2 3 2 2],1:24) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/hypermatrices.xml b/modules/data_structures/help/ja_JP/hypermatrices.xml new file mode 100755 index 000000000..2432c114e --- /dev/null +++ b/modules/data_structures/help/ja_JP/hypermatrices.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermatrices"> + <refnamediv> + <refname>hypermatrices</refname> + <refpurpose>Scilab オブジェクト, Scilabの N 次元行列</refpurpose> + </refnamediv> + <refsection> + <title>説明</title> + <para> + ハイパー行列型により多次元配列の操作が可能です. + </para> + <para> + ハイパー行列型は,2次元行列を以下のように拡張することにより, + a=[1 2;3 4];a(:,:,2)=rand(2,2) + </para> + <para> + または直接 <literal>hypermat</literal> 関数により定義できます. + </para> + <para> + エントリは,実数または複素数, 多項式, 有理数, 文字列, 論理値とすることができます. + </para> + <para> + ハイパー行列は,以下の <literal>mlists</literal>型となります: + <literal>mlist(['hm','dims','entries'],sz,v)</literal> ,ただし, + <literal>sz</literal> は次元を含む行ベクトル, + <literal>v</literal> はエントリを含む列ベクトル (最初の次元が最初に保存されます) + </para> + <para>注意: ハイパー行列の最も右の次元の数が1となる場合, + 自動的に次元が縮小されます. + 次元が2つのみのハイパー行列は,自動的に通常の行列(タイプ1)に変換されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +a(1,1,1,1:2)=[1 2] +a=[1 2;3 4];a(:,:,2)=rand(2,2) +a(1,1,:) +size(a) +a(:,:,1) //dimensionality reduction +type(a(:,:,1)) +[a a] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="hypermat">hypermat</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/iscell.xml b/modules/data_structures/help/ja_JP/iscell.xml new file mode 100755 index 000000000..f71a5ca34 --- /dev/null +++ b/modules/data_structures/help/ja_JP/iscell.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscell" xml:lang="ja"> + <refnamediv> + <refname>iscell</refname> + <refpurpose>変数がセル配列かどうかを調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>bool = iscell(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Scilab 変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>A boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>iscell(x)</literal> は,xがセル配列の場合に真, + それ以外の場合に偽となります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +iscell(1) +iscell(cell()) +c = cell(1,2); +c(1).entries="Scilab"; +c(2).entries=datenum(); +iscell(c) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/iscellstr.xml b/modules/data_structures/help/ja_JP/iscellstr.xml new file mode 100755 index 000000000..1fd673f3f --- /dev/null +++ b/modules/data_structures/help/ja_JP/iscellstr.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscellstr" xml:lang="ja"> + <refnamediv> + <refname>iscellstr</refname> + <refpurpose>変数が文字列のセル配列であるかどうか調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>bool = iscellstr(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Scilab 変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>iscellstr(x)</literal> は x が文字列のセル配列 + (または空のセル配列)の場合にtrue, その他の場合に false + を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +iscellstr(1) +iscellstr(cell()) +iscellstr(cell(3)) +strcell = cell(3,1); +strcell(1).entries="Scilab"; +strcell(2).entries="iscellstr"; +strcell(3).entries="help"; +iscellstr(strcell) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/isfield.xml b/modules/data_structures/help/ja_JP/isfield.xml new file mode 100755 index 000000000..e380cca54 --- /dev/null +++ b/modules/data_structures/help/ja_JP/isfield.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isfield"> + <refnamediv> + <refname>isfield</refname> + <refpurpose>指定したフィールド名が構造体またはmlistまたはtlistの中にあるかどうか調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>bool = isfield(s,fieldname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>構造体配列, tlist または mlist</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fieldname</term> + <listitem> + <para>文字列の行列: 検出するフィールド名</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para> + 論理値の行列 (<varname>fieldname></varname>と同じ形式). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + This function returns <constant>%t</constant> if the specified structure or tlist or mlist <varname>s</varname> includes the field <varname>fieldname</varname>, regardless of the corresponding value. For a structure, the hidden field <code class="literal">dims</code> is ignored. + この関数は指定した構造体 "s" がその値によらず, + フィールド "field" を有する場合に true を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +s = struct("field_1",123,"field_2",456,"field_4",789) +// Single Fieldname Syntax +isfield( s , "field_1" ) +// Multiple Fieldname Syntax +isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] ) +// with a tlist: +s = tlist(["test" "t" "n","","p"], "Hello", %pi, "anonymous", (1-%z)^3) +isfield(s, ["b" "t" ""]) // => F T T (anonymous fields can be detected) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="definedfields">definedfields</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5</revnumber> + <revremark> + mlistおよびtlist用の拡張モジュール + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/isstruct.xml b/modules/data_structures/help/ja_JP/isstruct.xml new file mode 100755 index 000000000..b84b2ddf1 --- /dev/null +++ b/modules/data_structures/help/ja_JP/isstruct.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isstruct" xml:lang="ja"> + <refnamediv> + <refname>isstruct</refname> + <refpurpose>変数が構造体配列であるかどうか調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>bool = isstruct(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Scilab変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>isstruct(x)</literal> は x が構造体配列 + の場合にtrue, その他の場合に false + を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +isstruct(1) +isstruct(cell()) +isstruct(struct("name","Scilab", "version", getversion())) +info.name="Scilab"; +info.function="isstruct"; +info.module="help"; +isstruct(info) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/list.xml b/modules/data_structures/help/ja_JP/list.xml new file mode 100755 index 000000000..887fe9e90 --- /dev/null +++ b/modules/data_structures/help/ja_JP/list.xml @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="list"> + <refnamediv> + <refname>list</refname> + <refpurpose>Scilab オブジェクトおよびリスト関数定義</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼出し手順</title> + <synopsis>list(a1,....an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para> + 要素 <literal>ai</literal>を有する<literal>リスト</literal>を作成します. + その要素は任意のScilabオブジェクト(<literal>行列, リスト,...</literal>) + です.<literal>リスト</literal>オブジェクトの型は 15 です. + <literal>list()</literal> は空の <literal>リスト</literal> (要素数0)を + 返します. + </para> + </refsection> + <refsection> + <title>リストの処理</title> + <variablelist> + <varlistentry> + <term>展開</term> + <listitem> + <para> + <literal>[x,y,z...]=L(v)</literal> ただし, + <literal>v</literal> は添え字のベクトルです; + <literal>[x,y,z]=L(:)</literal> は全要素を展開します. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>添字iに挿入</term> + <listitem> + <para> + <literal>L(i)=a</literal> + (<emphasis>i > 1 + size(L)</emphasis> により + <literal>L(i)=a</literal>としてもエラーとなりませんが, + この結果いくつかのリストのエントリが未定義となり, + これらを展開する時にエラーを発生することに注意してください). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>要素を末尾に追加</term> + <listitem> + <para> + <literal>L($+1)=e</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>要素を先頭に追加</term> + <listitem> + <para> + <literal>L(0)=e</literal>. + (この操作の後, <literal>e</literal>は添字1にあり, + 最初の要素は右にシフトすることに注意してください). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>削除</term> + <listitem> + <para> + <literal>L(i)=null()</literal> removes the i-th element of the list <literal>L</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>二つのリストを結合</term> + <listitem> + <para> + <literal>L3 = lstcat(L1,L2)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>リストの要素数</term> + <listitem> + <para> + <literal>nb_elm = size(L)</literal> + または <literal>nb_elm = length(L)</literal>のどちらかを + 使用することができます. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>リストで反復処理</term> + <listitem> + <para> + <link linkend="for">for</link> ループでリスト<literal>L</literal> + を使用することが可能です: + <literal>for e=L,...,end</literal> は <literal>length(L)</literal> + 回の反復処理を行うループで, + ループ変数<literal>e</literal> はi番目の反復で <literal>L(i)</literal> + となります. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>注記</title> + <para> + Scilab では他の種類のリストである <link linkend="tlist">tlist</link> + 型(型付のリスト),<link linkend="mlist">mlist</link>型 + も提供されています. + これらのリストは,演算子 + <link linkend="overloading">オーバーロード</link>機能を + 有する新しいデータ型を定義する際に有用です + (Scilabの多次元配列である + <link linkend="hypermatrices">超越行列</link> + は実際には<emphasis>mlist</emphasis>です). + </para> + <para> + Matlab <emphasis>struct</emphasis> も利用可能です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +l = list(1,["a" "b"]) +l(0) = "foo" +l($+1) = "hello" +l(2) = "toto" +l(3) = rand(1,2) +l(3) = null() +lbis = list("gewurtz", "caipirina" ,"debug") +lter = lstcat(l,lbis) +size(lter) - size(lbis) - size(l) // must be zero + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="lstcat">lstcat</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="size">size</link> + </member> + <member> + <link linkend="length">length</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/lstcat.xml b/modules/data_structures/help/ja_JP/lstcat.xml new file mode 100755 index 000000000..25c5f8bb1 --- /dev/null +++ b/modules/data_structures/help/ja_JP/lstcat.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="lstcat"> + <refnamediv> + <refname>lstcat</refname> + <refpurpose>リストの結合</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>lc=lstcat(l1,..ln)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>li</term> + <listitem> + <para>リストまたは任意の型の変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lc</term> + <listitem> + <para>リスト</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>lc=lstcat(l1,..ln)</literal> はリスト<literal>li</literal>の + 要素を結合し, 単一のリストとします. + <literal>li</literal> が他の型の変数の場合, + 単純に追加され,結果はリストとなります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +lstcat(list(1,2,3),33,list('foo',%s)) +lstcat(1,2,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/makecell.xml b/modules/data_structures/help/ja_JP/makecell.xml new file mode 100755 index 000000000..5f4d34870 --- /dev/null +++ b/modules/data_structures/help/ja_JP/makecell.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="makecell"> + <refnamediv> + <refname>makecell</refname> + <refpurpose>セル配列を作成. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>s = makecell(dims,a1,a2,...an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para> + 正の整数要素を有するベクトル, セル配列の次元 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>a1,a2,...,an</term> + <listitem> + <para> + 一連のScilab変数, <literal>n</literal> は <literal>prod(dims)</literal> + に等しい必要があります + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para> + 返されるセル配列 + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>s= makecell(dims,a1,a2,...an)</literal> は + 指定した入力引数において<literal>dims</literal>で指定された次元の + 配列です. + <literal>ai</literal> には,最後の次元が最初に保存されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +makecell([2,3],1,2,3,'x','y','z') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/matrices.xml b/modules/data_structures/help/ja_JP/matrices.xml new file mode 100755 index 000000000..9210d8277 --- /dev/null +++ b/modules/data_structures/help/ja_JP/matrices.xml @@ -0,0 +1,61 @@ +<?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="matrices"> + <refnamediv> + <refname>matrices</refname> + <refpurpose>Scilab オブジェクト, Scilabの行列</refpurpose> + </refnamediv> + <refsection> + <title>説明</title> + <para> + 行列は,Scilabで定義される基本的なオブジェクトです. + 行列は以下のように定義されます: + </para> + <programlisting role=""><![CDATA[ +E=[e11,e12,...,e1n; + e21,e22,...,e2n; + .... + em1,em2,...,emn]; + ]]></programlisting> + <para> + エントリ <literal>eij</literal> は, + 実数または複素数, 多項式, 有理数, 文字列, 論理値とすることができます. + </para> + <para> + ベクトルは,1行または1列のみを有する行列として扱われます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +E=[1,2;3,4] +E=[%T,%F;1==1,1~=1] +s=poly(0,'s'); +E=[s,s^2;1,1+s] +E=[1/s,0;s,1/(s+1)] +E=['A11','A12';'A21','A22'] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="poly">poly</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="boolean">boolean</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="empty">empty</link> + </member> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/mlist.xml b/modules/data_structures/help/ja_JP/mlist.xml new file mode 100755 index 000000000..22a0bec78 --- /dev/null +++ b/modules/data_structures/help/ja_JP/mlist.xml @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="mlist"> + <refnamediv> + <refname>mlist</refname> + <refpurpose>Scilab オブジェクト, 型付リスト定義に向いた行列.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>mlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>文字列のベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + 任意のScilabオブジェクト (<literal>matrix, list,string...</literal>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>mlist</literal> オブジェクトは <link linkend="tlist">tlist</link> オブジェクトに + 非常に良く似ています. 唯一の差異は, + <link linkend="extraction">展開</link> および + <link linkend="insertion">insertion</link> 挿入の構文です: + <literal>M</literal> が mlistの場合, フィールド名でない <literal>i</literal> に関して, + <literal>M(i)</literal> はリストの <literal>i</literal>番目のフィールドではありません. + </para> + <para> + 展開および挿入の構文の意味付けは, <link linkend="overloading">overloading</link> + 関数で指定される必要があります. + </para> + <para> + overloading 関数の展開構文 <literal>b=a(i1,...,in)</literal> + は以下の呼び出し手順となります + : <literal>b=%<type_of_a>_e_(i1,...,in,a)</literal> + </para> + <para>そして構文 + <literal>[x1,..,xm]=a(i1,...,in)</literal> は以下の呼び出し手順となります: + <literal>[x1,..,xm]=%<type_of_a>_e_(i1,...,in,a)</literal> + </para> + <para/> + <para>挿入構文に関連する overloading 関数 + <literal>a(i1,...,in)=b</literal> は以下の呼び出し手順となります: + <literal>a=%<type_of_b>_i_<type_of_a>(i1,...,in,b,a)</literal>. + </para> + <para/> + <para>mlist フィールドはそれらの名前に基づき設計される必要があります. + <literal>getfield</literal> および <literal>setfield</literal> + 関数により処理することも可能です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +//define display +function %V_p(M),disp(M.name+':'+string(M.value)),endfunction +//define extraction operation +function r=%V_e(varargin) + M=varargin($) + r=mlist(['V','name','value'],M.name(varargin(1:$-1)),M.value(varargin(1:$-1))) +endfunction +M(2,:) // the second row of M +M.value +//define insertion operations +function M=%V_i_V(varargin) + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N.value + M.name(varargin(1:$-2))=N.name +endfunction +M(1,1)=M(2,2) +function M=%s_i_V(varargin) //insertion of a regular matrix into a V matrix + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N + M.name(varargin(1:$-2))=emptystr(N) +endfunction +M(1,1)=44 +//tlist case +M=tlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +M(2) +M(2)='a'+string([1 2;3 4]) +M('name') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/null.xml b/modules/data_structures/help/ja_JP/null.xml new file mode 100755 index 000000000..8cdbf6266 --- /dev/null +++ b/modules/data_structures/help/ja_JP/null.xml @@ -0,0 +1,35 @@ +<?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="null"> + <refnamediv> + <refname>null</refname> + <refpurpose>リストの要素を削除する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼出し手順</title> + <synopsis>l(i)=null()</synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para> + リスト内のオブジェクトを削除します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +l=list(1,"foo",3); +l(2)=null() // list(1,3)となる + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="clear">clear</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/rlist.xml b/modules/data_structures/help/ja_JP/rlist.xml new file mode 100755 index 000000000..6e91f9890 --- /dev/null +++ b/modules/data_structures/help/ja_JP/rlist.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="rlist"> + <refnamediv> + <refname>rlist</refname> + <refpurpose>Scilab 有理関数定義</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>rlist() + rlist(a1,....an) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para> + <literal>rlist(a1,....an)</literal> は + <literal>tlist(['r','num';'den','dt'], a1,....an)</literal>へのショートカットです. + </para> + <para> + <literal>['r','num';'den','dt']</literal>を最初のエントリ, + <literal>ai</literal>を次のエントリといったようなエントリを有する + <literal>tlist</literal>を作成します. + <literal>ai</literal>の型も大きさも確認されません. + </para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/setfield.xml b/modules/data_structures/help/ja_JP/setfield.xml new file mode 100755 index 000000000..10a8c22b4 --- /dev/null +++ b/modules/data_structures/help/ja_JP/setfield.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="setfield"> + <refnamediv> + <refname>setfield</refname> + <refpurpose>list フィールドの挿入</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>setfield(i,x,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>任意の型の行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>list, tlist または mlist 変数</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>フィールド添え字, 詳細は insertion 参照.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + この関数は,フィールド展開を行う<literal>l(i)=x</literal>構文と等価ですが, + 唯一の差異は,<literal>mlist</literal>オブジェクトにも適用可能なことです. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +l(1)='Changed' +l(0)='Added' +l(6)=['one more';'added'] +a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists +setfield(3,1:8,a);a // set the field value to 1:8 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="insertion">insertion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/struct.xml b/modules/data_structures/help/ja_JP/struct.xml new file mode 100755 index 000000000..fbd331b35 --- /dev/null +++ b/modules/data_structures/help/ja_JP/struct.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="struct"> + <refnamediv> + <refname>struct</refname> + <refpurpose>構造体を作成する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>st=struct(field1,value1,field2,value2...)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>field1, field2, ..</term> + <listitem> + <para>フィールド名を表す文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value1, value2, ..</term> + <listitem> + <para>フィールドの値を表すデータ型 (double, char, int, ...)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>この関数はフィールド名 + <literal>fields1</literal>, <literal>field2</literal>, ..., を有し, + その値が<literal>value1</literal>, <literal>value2</literal>, ... + となる構造体を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// create a struct date +date=struct('day',25,'month' ,'DEC','year',2006) +//change the month +date.month='AUG'; +// change the year +date.year=1973; +//change the day +date.day=19; +// add a new field +date.semaine=32 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/tlist.xml b/modules/data_structures/help/ja_JP/tlist.xml new file mode 100755 index 000000000..c4870a41b --- /dev/null +++ b/modules/data_structures/help/ja_JP/tlist.xml @@ -0,0 +1,162 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="tlist"> + <refnamediv> + <refname>tlist</refname> + <refpurpose>Scilab オブジェクトおよび型付のリスト定義. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>tlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>文字列または文字列のベクトル</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + Scilabオブジェクト (<literal>行列, リスト,文字列...</literal>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 要素<literal>ai</literal>を有する + <literal>型付のリスト</literal> を作成します. + <literal>typ</literal>引数はリストの型を指定する引数です. + この <literal>型付のリスト</literal> により + ユーザはScilab関数によりこれらのオブジェクトで動作する + 新しい処理を定義できるようになります. + <literal>型付のリスト</literal> と <literal>リスト</literal> + の唯一の差は型の値(15ではなく16)です. + </para> + <para> + <literal>typ(1)</literal> はリストの型を指定します + (ソフトコードされた処理を定義するために使用される文字列) + </para> + <para> + <literal>typ(i)</literal> が指定された場合, + <literal>i+1</literal>番目の形式要素の名前を指定します. + </para> + <para> + <literal>リスト</literal>における標準処理は + <literal>型付リスト</literal>でも類似性があります: + </para> + <para> + 展開 + : <literal>[x,y,z...]=l(v)</literal> ただし <literal>v</literal> は添え字のベクトルです; + <literal>[x,y,z]=l(:)</literal> は全ての要素を展開します. + </para> + <para> + 挿入 + : <literal>l(i)=a</literal> + </para> + <para> + 削除 + : <literal>l(i)=null()</literal> は<literal>tlist l</literal>の i番目の要素を削除します. + </para> + <para> + 表示 + </para> + <para> + 更に<literal>typ(2:n+1)</literal> が指定された場合, + ユーザは名前で要素を指定することができます + </para> + <para> + 以下に tlist の使用例を示します. + </para> + <para> + 線形システムは,特定の<literal>型付リスト</literal>で表されます. + 例えば,線形システム <literal>[A,B,C,D]</literal>は + tlist <literal>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</literal> で表されこの特別のリストは関数<literal>syslin</literal>により + 作成することが可能です. + </para> + <para> + Sys(2), Sys('A') または Sys.A は状態行列で, Sys('dt') または Sys.dt は + 時間領域です + </para> + <para> + 有理行列 <literal>H</literal> は<literal>型付リスト</literal> + <literal>H=rlist(Num,Den,[])</literal> + により表されます. + ただし,<literal>Num</literal> および <literal>Den</literal> + は多項式行列です. + 伝達関数行列 <literal>H</literal> を有する(連続時間)線形システムは + <literal>syslin('c',H)</literal>で作成できます. + </para> + <para> + H(2), H('num') または H.num は伝達関数行列の分子です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// tlist creation +t = tlist(["listtype","field1","field2"], [], []); +t.field1(1) = 10; +t.field1(2) = 20; +t.field2(1) = "Scilab"; +t.field2(2) = "tlist"; +t.field2(3) = "example"; +// Fields contents display +disp(t.field1) +disp(t.field2) +// Generic tlist display +disp(t) +// Overloading display for this type of tlist +function %listtype_p(mytlist) + f = fieldnames(mytlist); + // typeof(mytlist) <=> f(1) + mprintf("Displaying a tlist of type: %s\n", typeof(mytlist)); + mprintf("\n"); + mprintf("-- Field ''%s'' --\n", f(1)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(1)))); + mprintf("\n"); + mprintf("-- Field ''%s'' --\n", f(2)); + mprintf("Contents: %s\n", sci2exp(mytlist(f(2)))); +endfunction +// Display using overloading function +disp(t) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="percent">percent</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/type.xml b/modules/data_structures/help/ja_JP/type.xml new file mode 100755 index 000000000..ed799c9a4 --- /dev/null +++ b/modules/data_structures/help/ja_JP/type.xml @@ -0,0 +1,115 @@ +<?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="type"> + <refnamediv> + <refname>type</refname> + <refpurpose>変数の型を返す</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>[i]=type(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>Scilab オブジェクト</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>整数</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>type(x)</literal> は,以下のように + <literal>x</literal>の型の種類を整数で返します : + </para> + <para> + 1 + : 実数または複素数の定数行列. + </para> + <para> + 2 + : 多項式行列. + </para> + <para> + 4 + : 論理値行列. + </para> + <para> + 5 + : 疎行列. + </para> + <para> + 6 + : 論理値疎行列. + </para> + <para> + 7 + : Matlab 疎行列. + </para> + <para> + 8 + : 1 2 または 4 バイトに保存される整数行列. + </para> + <para> + 9 + : グラフィックハンドルの行列. + </para> + <para> + 10 + : 文字列の行列. + </para> + <para> + 11 + : コンパイル前の関数 (Scilab コード). + </para> + <para> + 13 + : コンパイル済みの関数 (Scilab コード). + </para> + <para> + 14 + : 関数ライブラリ. + </para> + <para> + 15 + : リスト. + </para> + <para> + 16 + : 型付リスト (tlist). + </para> + <para> + 17 + : 行列の型付リスト (mlist). + </para> + <para> + 128 + : ポインタ (<link linkend="lufact">lufact</link>参照). + </para> + <para> + 129 + : 添字に使用される暗黙の大きさの多項式. + </para> + <para> + 130 + : Scilab 内部コード (C または Fortran コード). + </para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="typeof">typeof</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/typename.xml b/modules/data_structures/help/ja_JP/typename.xml new file mode 100755 index 000000000..d52537c3f --- /dev/null +++ b/modules/data_structures/help/ja_JP/typename.xml @@ -0,0 +1,90 @@ +<?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="typename"> + <refnamediv> + <refname>typename</refname> + <refpurpose>変数の型に名前を付ける</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼出し手順</title> + <synopsis>[types [ [,names]]=typename() + typename(name,type) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>types</term> + <listitem> + <para>整数列ベクトル: 各定義済みのデータ型の型コード.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>文字列の列ベクトル: 型コードを指す名前.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para>整数: 新しいデータ型の型コード.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>文字列: 型コードを指す名前</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 関数および演算子のオーバーロードにおいて, + データ型に関連付けられた汎用名を + オーバーロード関数の名前を作成する際に指定できる + できるようになります(オーバーローディング参照). + <literal>typename</literal> は, + ハードコードされたデータ型に関して + この汎用名を処理する際に使用できます + (<literal>tlist</literal> または <literal>mlist</literal>にコード化されたデータ型の + 場合,汎用名は他の方法で定義されます, <literal>overloading</literal>を参照ください). + </para> + <para> + 右辺の引数を指定せずにコールされた場合, <literal>typename</literal> は + 定義済みのデータ型に関する情報を返します. + </para> + <para> + 右辺の引数を指定してコールされると, <literal>typename</literal> は名前を + データ型コードに関連付けます. + </para> + <para> + <literal>typename('',type)</literal> は, + コード <literal>type</literal> で指定されるデータ型を + データ型のテーブルから削除します. + </para> + <para>定義済みの型の最大数は 50です.</para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ja_JP/typeof.xml b/modules/data_structures/help/ja_JP/typeof.xml new file mode 100755 index 000000000..3cfb86bf4 --- /dev/null +++ b/modules/data_structures/help/ja_JP/typeof.xml @@ -0,0 +1,213 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="typeof" xml:lang="ja"> + <refnamediv> + <refname>typeof</refname> + <refpurpose>オブジェクトの型</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>[t]=typeof(object)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>object</term> + <listitem> + <para>Scilabオブジェクト</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>t=typeof(object)</literal> は以下の文字列のどれかを返します: + </para> + <variablelist> + <varlistentry> + <term>"constant"</term> + <listitem> + <para>オブジェクトが実数または複素数の定数行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"polynomial"</term> + <listitem> + <para>オブジェクトが多項式行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"function"</term> + <listitem> + <para>オブジェクトが関数の場合 (Scilab コード).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"handle"</term> + <listitem> + <para>オブジェクトがハンドルの場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"string"</term> + <listitem> + <para>オブジェクトが文字列からなる行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean"</term> + <listitem> + <para>オブジェクトが論理値行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"list"</term> + <listitem> + <para>オブジェクトがリストの場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"rational"</term> + <listitem> + <para>オブジェクトが有理行列(伝達行列)の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"state-space"</term> + <listitem> + <para> + オブジェクトが状態空間モデルの場合(<link linkend="syslin">syslin</link>参照). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"sparse"</term> + <listitem> + <para>オブジェクトが(実数)疎行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean sparse"</term> + <listitem> + <para>オブジェクトが論理値の疎行列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"hypermat"</term> + <listitem> + <para> + オブジェクトがハイパー行列の場合(N >=3 のN次元配列). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"st"</term> + <listitem> + <para>オブジェクトが構造体配列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"ce"</term> + <listitem> + <para>オブジェクトがセル配列の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>the first string in the first list entry</term> + <listitem> + <para>オブジェクトtlistまたはmlistの場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"fptr"</term> + <listitem> + <para>オブジェクトがScilabイントリンシック(CまたはFortranコード)の場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"pointer"</term> + <listitem> + <para> + オブジェクトがポインタの場合 (<link linkend="lufact">lufact</link> 参照). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"size implicit"</term> + <listitem> + <para> + オブジェクトが + 添字に使用される大きさが不明な多項式の場合 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"library"</term> + <listitem> + <para>オブジェクトが関数ライブラリの場合.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"int8" または "uint8" または "int16" または "uint16" または "int32" または "uint32"</term> + <listitem> + <para> + オブジェクトが 8,16または32ビットに保存される[符号なしの]整数の行列の場合. + <link linkend="int8">int8</link>参照) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +typeof(1) +typeof(poly(0,'x')) +typeof(1/poly(0,'x')) +typeof(%t) +w=sprand(100,100,0.001); +typeof(w) +typeof(w==w) +deff('y=f(x)','y=2*x'); +typeof(f) +L=tlist(['V','a','b'],18,'Scilab'); +typeof(L) +typeof(corelib) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="strings">strings</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="poly">poly</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/addchapter.sce b/modules/data_structures/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..b41157012 --- /dev/null +++ b/modules/data_structures/help/pt_BR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Estruturas de Dados",SCI+"/modules/data_structures/help/pt_BR",%T); + diff --git a/modules/data_structures/help/pt_BR/boolean.xml b/modules/data_structures/help/pt_BR/boolean.xml new file mode 100755 index 000000000..299b51e5d --- /dev/null +++ b/modules/data_structures/help/pt_BR/boolean.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<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="boolean" xml:lang="en"> + <refnamediv> + <refname>boolean</refname> + <refpurpose>objetos Scilab: variveis booleanas e operadores '&', '|' + e '~' + </refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para> + Uma varivel booleana <literal>%T</literal> (para "true", + "verdadeiro") ou <literal>%F</literal> (for "false"). (para + "false","falso"). Estas variveis podem ser usadas para definir matrizes + de valores booleanos, com a sintaxe usual. Matrizes de valores booleanos + podem ser manipuladas como matrizes ordinrias para extrao/insero de + elementos e concatenao. Note que outras operaes usuais ( +, *, -, ^, + etc.) no so definidas para matrizes de valores booleanos. Trs + operadores especiais so definidos para estas matrizes: + </para> + <variablelist> + <varlistentry> + <term>~b</term> + <listitem> + <para> + a negao elemento a elemento de <literal>b</literal> + (matriz). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1&b2</term> + <listitem> + <para> + o <literal>and</literal> ("e") lgico elemento a elemento de + <literal>b1</literal> e <literal>b2</literal> (matrizes). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1|b2</term> + <listitem> + <para> + o <literal>or</literal> ("ou") lgico elemento a elemento de + <literal>b1</literal> e <literal>b2</literal> (matrizes). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Variveis booleanas podem ser usadas para se indexar vetores ou + matrizes. + </term> + <listitem> + <para> + Por exemplo <literal>a([%T,%F,%T],:)</literal> retorna a + submatriz feita das linhas <literal>1</literal> e + <literal>3</literal> de <literal>a</literal>. Matrizes esparsas de + valores booleanos so suportadas. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +[1,2]==[1,3] +[1,2]==1 +a=1:5; a(a>2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="matrices">matrices</link> + </member> + <member> + <link linkend="or">or</link> + </member> + <member> + <link linkend="and">and</link> + </member> + <member> + <link linkend="not">not</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/cell.xml b/modules/data_structures/help/pt_BR/cell.xml new file mode 100755 index 000000000..41d1dab95 --- /dev/null +++ b/modules/data_structures/help/pt_BR/cell.xml @@ -0,0 +1,164 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="cell" xml:lang="en"> + <refnamediv> + <refname>cell</refname> + <refpurpose>cria um cell (célula) de matrizes vazias</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis> + c=cell() + c=cell(m1) + c=cell(m1, m2) + c=cell(m1, m2, ..., mn) + c=cell(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>vetor contendo as dimensões do cell a ser criado</para> + </listitem> + </varlistentry> + <varlistentry> + <term>m1, m2,..</term> + <listitem> + <para>dimensões do cell a ser criado</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para>retorna um cell de matrizes vazias</para> + <variablelist> + <varlistentry> + <term>cell()</term> + <listitem> + <para> + retorna um cell <literal>(0,0)</literal> de matrizes + vazias. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1)</term> + <listitem> + <para> + retorna um cell <literal>(m1,m1)</literal> de matrizes + vazias. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1,m2)</term> + <listitem> + <para> + retorna um cell <literal>(m1,m2) </literal>de matrizes + vazias. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1,m2,..,mn)</term> + <listitem> + <para> + retorna um cell <literal>(m1,m2,..,mn)</literal> de matrizes + vazias. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(x)</term> + <listitem> + <para>retorna um cell de matrizes vazias com: a primeira dimensão + sendo <literal>x(1)</literal>, a segunda sendo <literal>x(2), + ... + </literal> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Observações</title> + <para> + <literal>cell(x) </literal>não possui o mesmo tamanho que + <literal>x</literal>. + </para> + <para> + <literal>cell()</literal> é equivalente a + <literal>cell(0)</literal>. + </para> + <para>Se A for um cell, você pode acessar os conteúdos de um elemento de A + utilizando <literal>A(m1, m2, ..., mn).entries</literal>. A expressão + <literal>A(1,1) = zeros(2,2)</literal> não é válida, a sintaxe correta é + <literal>A(1,1).entries = zeros(2,2)</literal>. + </para> + <para>Se A é um cell, você pode obter suas dimensões através de + <literal>A.dims</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +a=cell(3) +b=cell(3,1) +c=cell([2,3,4]) + +// atribuição em entradas do cell +b=cell(3,1); + +// atribuindo o primeiro elemento de b utilizando o campo 'entries' +b(1).entries=1:3 + +// atribuindo o segundo elemento de b utilizando o campo 'entries' +b(2).entries='Scilab' + +// atribuindo o terceiro elemento de b utilizando o campo 'entries' +b(3).entries=poly(1:3,'s') + +// atribuição de sub-cells +X=cell(3,2); +X(:,1)=b + +// extraindo um sub-cell: o resultado é um cell +b(1) +b(1:2) + +// extraindo o valor de um sub-cell: o resultado é um array +b(1).entries + +// dimensões de b +b.dims + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="eye">eye</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/definedfields.xml b/modules/data_structures/help/pt_BR/definedfields.xml new file mode 100755 index 000000000..e0c97ddba --- /dev/null +++ b/modules/data_structures/help/pt_BR/definedfields.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="definedfields" xml:lang="en"> + <refnamediv> + <refname>definedfields</refname> + <refpurpose>retorna o ndice dos campos definidos de uma + lista + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>k=definedfields(l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>l</term> + <listitem> + <para>uma lista, tlist ou mlist </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k</term> + <listitem> + <para>um vetor de ndices .</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Se <literal>l</literal> do tipo <literal>list</literal> + <literal>tlist</literal> <literal>mlist</literal> + <literal>k=definedfields(l)</literal> retorna em <literal>k</literal> os + ndices dos campos definidos da lista. Esta funo til porque a + indexao de campos indefinidos acarreta erros. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +l=list(1);l(3)=5 +k=definedfields(l) + +t=tlist('x');t(5)=4 +definedfields(t) + +m=mlist(['m','a','b']);m.b='sdfgfgd' +definedfields(m) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/getfield.xml b/modules/data_structures/help/pt_BR/getfield.xml new file mode 100755 index 000000000..e2b626b0e --- /dev/null +++ b/modules/data_structures/help/pt_BR/getfield.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getfield" xml:lang="en"> + <refnamediv> + <refname>getfield</refname> + <refpurpose>extrao de campos de listas</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[x,...]=getfield(i,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>matriz de qualquer tipo possvel </para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>lista, tlist ou mlist </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>ndice de campo, ver "extraction" para mais detalhes.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Esta funo equivalente sintaxe <literal>[x,...]=l(i)</literal> + para extrao de campos com a nica diferena de que tambm se aplica a + objetos <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +[a,b]=getfield([3 2],l) + +a=hypermat([2,2,2],rand(1:2^3));// hipermatrizes so codificadas usando-se mlists +a(1) // a entrada a(1,1,1) +getfield(1,a) // o primeiro campo do mlist + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">extraction</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/hypermat.xml b/modules/data_structures/help/pt_BR/hypermat.xml new file mode 100755 index 000000000..1a0c73472 --- /dev/null +++ b/modules/data_structures/help/pt_BR/hypermat.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermat" xml:lang="en"> + <refnamediv> + <refname>hypermat</refname> + <refpurpose>inicializa matrizes n-dimensionais</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>M=hypermat(dims [,v])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para>vetor de dimenses da hipermatriz </para> + </listitem> + </varlistentry> + <varlistentry> + <term>v</term> + <listitem> + <para>vetor de entradas da hipermatriz (valor padro + <literal>zeros(prod(dims),1)</literal>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Incializa uma hipermatriz cujas dimenses so dadas pelo vetor dims + e as entradas so dadas pelo argumento opcional + <literal>v</literal> + </para> + <para>A estrutura de dados de M contm o vetor de dimenses da matriz + <literal>M('dims')</literal> e o vetor de entradas + <literal>M('entries')</literal> tais que os ndices subescritos mais + esquerda variam primeiro: + <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal> + </para> + <para> + Warning: If you build your own <literal>hypermat</literal>, you must be careful. The M('dims') entry must be a row vector whereas the M('entries') must be a column vector. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +M = hypermat([2 3 2 2],1:24) +disp(size(M('dims'))) +disp(size(M('entries'))) + +M_own = mlist(['hm','dims','entries']); +M_own('dims') = [2 3 2 2]; +M_own('entries') = [1:24]'; +disp(size(M_own('dims'))) +disp(size(M_own('entries'))) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/hypermatrices.xml b/modules/data_structures/help/pt_BR/hypermatrices.xml new file mode 100755 index 000000000..c9a08ce91 --- /dev/null +++ b/modules/data_structures/help/pt_BR/hypermatrices.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermatrices" xml:lang="en"> + <refnamediv> + <refname>hypermatrices</refname> + <refpurpose>objeto do Scilab: matrizes n-dimensionais</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para>O tipo hipermatriz ("hypermatrix") permite manipular arrays + multidimensionais. + </para> + <para>Hipermatrizes podem ser definidas por uma extenso das matrizes 2D + como segue: a=[1 2;3 4];a(:,:,2)=rand(2,2) + </para> + <para> + ou usando a funo <literal>hypermat</literal> diretamente. + </para> + <para>As entradas podem ser nmeros reais ou complexos, polinmios, razes + de polinmios, strings ou valores booleanos. + </para> + <para> + Hipermatrizes so <literal>mlists</literal>: + <literal>mlist(['hm','dims','entries'],sz,v)</literal> onde + <literal>sz</literal> o vetor linha de dimenses e <literal>v</literal> + o vetor coluna de entradas (as primeiras dimenses so armazenadas + primeiro) + </para> + <para>NOTAS: O nmero de dimenses de hipermatrizes com tamanhos mais + direita iguais a 1 automaticamente reduzido. Uma hipermatriz com apenas + duas dimenses automaticamente trocada por uma matriz regular (tipo + 1). + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +a(1,1,1,1:2)=[1 2] +a=[1 2;3 4];a(:,:,2)=rand(2,2) +a(1,1,:) + +size(a) + +a(:,:,1) //reduo de dimensionalidade +type(a(:,:,1)) + +[a a] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="hypermat">hypermat</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/iscell.xml b/modules/data_structures/help/pt_BR/iscell.xml new file mode 100755 index 000000000..8e447cca7 --- /dev/null +++ b/modules/data_structures/help/pt_BR/iscell.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscell" xml:lang="en"> + <refnamediv> + <refname>iscell</refname> + <refpurpose>verifica se um array é um cell (célula)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>bool = iscell(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>variável Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>um booleano</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>iscell(x)</literal> retorna %t (verdadeiro) se x é um cell + e %f (falso) em caso contrário. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +iscell(1) + +iscell(cell()) + +c = cell(1,2); +c(1).entries="Scilab"; +c(2).entries=datenum(); +iscell(c) + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/iscellstr.xml b/modules/data_structures/help/pt_BR/iscellstr.xml new file mode 100755 index 000000000..f20cf1909 --- /dev/null +++ b/modules/data_structures/help/pt_BR/iscellstr.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscellstr" xml:lang="en"> + <refnamediv> + <refname>iscellstr</refname> + <refpurpose>verifica se uma variável é um cell array de + strings + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>bool = iscellstr(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>variável Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>um booleano</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>iscellstr(x)</literal> retorna verdadeiro se x é um cell + array de strings (ou um cell array vazio) e falso em caso + contrário. + </para> + </refsection> + <refsection> + <title>Exemplos </title> + <programlisting role="example"><![CDATA[ +iscellstr(1) + +iscellstr(cell()) + +iscellstr(cell(3)) + +strcell = cell(3,1); +strcell(1).entries="Scilab"; +strcell(2).entries="iscellstr"; +strcell(3).entries="help"; +iscellstr(strcell) + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/isstruct.xml b/modules/data_structures/help/pt_BR/isstruct.xml new file mode 100755 index 000000000..de14771f9 --- /dev/null +++ b/modules/data_structures/help/pt_BR/isstruct.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isstruct" xml:lang="en"> + <refnamediv> + <refname>isstruct</refname> + <refpurpose>checa se uma variável é um struct array + (estrutura) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>bool = isstruct(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>variável Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>um booleano</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>isstruct(x)</literal> retorna %t (verdadeiro) se x é um + struct array e %f em caso contrário. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +isstruct(1) + +isstruct(cell()) + +isstruct(struct("name","Scilab", "version", getversion())) + +info.name="Scilab"; +info.function="isstruct"; +info.module="help"; +isstruct(info) + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/list.xml b/modules/data_structures/help/pt_BR/list.xml new file mode 100755 index 000000000..4d680f298 --- /dev/null +++ b/modules/data_structures/help/pt_BR/list.xml @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="list" xml:lang="en"> + <refnamediv> + <refname>list</refname> + <refpurpose>objeto do Scilab e definio de lists ("listas")</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>list(a1,....an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para> + Cria um <literal>list</literal> com elementos + <literal>ai</literal>'s que so elementos Scilab arbitrrios + (<literal>matrix, list,...</literal>). O tipo de objetos + <literal>list</literal> 15. <literal>list()</literal> cria o + <literal>list</literal> vazio (0 elementos). + </para> + </refsection> + <refsection> + <title>Operaes em Listas</title> + <variablelist> + <varlistentry> + <term>extrao</term> + <listitem> + <para> + <literal>[x,y,z...]=L(v)</literal> onde <literal>v</literal> + um vetor de ndices; <literal>[x,y,z]=L(:)</literal> extrai todos + os elementos. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>insero no ndice i</term> + <listitem> + <para> + <literal>L(i)=a</literal> (note que no errado usar + <literal>L(i)=a</literal> com <emphasis>i > 1 + + size(L) + </emphasis> + mas algumas entradas de lista esto ento + indefinidas e sua extrao levanta um erro). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>anexar elemento no fim da lista</term> + <listitem> + <para> + <literal>L($+1)=e</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>anexar elementos no incio da lista</term> + <listitem> + <para> + <literal>L(0)=e</literal>. (note que aps esta operao e + est no ndice 1, os elementos iniciais foram movidos para a + direita). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>deleo</term> + <listitem> + <para> + <literal>L(i)=null()</literal> remove o i-simo elemento da + lista <literal>L</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>concatenao de duas listas</term> + <listitem> + <para> + <literal>L3 = lstcat(L1,L2)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>nmero de elementos de uma lista</term> + <listitem> + <para> + voc pode usar tanto <literal>nb_elm = size(L)</literal> ou + <literal>nb_elm = length(L)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>iteraes com uma lista</term> + <listitem> + <para> + possvel usar uma lista <literal>L</literal> com um lao + ("loop") <link linkend="for">for</link>: <literal>for + e=L,...,end + </literal> + um lao com <literal>length(L)</literal> + iteraes, a varivel de lao <literal>e</literal> sendo igual a + <literal>L(i)</literal> na i-sima iterao. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Observaes </title> + <para> + O Scilab tambm possui outros tipos de listas, o tipo <link linkend="tlist">tlist</link> (lista com tipo) e o tipo <link linkend="mlist">mlist</link> que so teis para definir um novo tipo de + dado com o operador <link linkend="overloading">overloading</link> + facilities (<link linkend="hypermatrices">hypermatrices</link> + (hipermatrizes), que so arrays multi-dimensionais no Scilab, so, na + verdade, <emphasis>mlist</emphasis>). + </para> + <para> + <emphasis>struct</emphasis> do Matlab tambm esto + disponveis. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +l = list(1,["a" "b"]) +l(0) = "foo" +l($+1) = "ol" +l(2) = "toto" +l(3) = rand(1,2) +l(3) = null() +lbis = list("gewurtz", "caipirina" ,"debug") +lter = lstcat(l,lbis) +size(lter) - size(lbis) - size(l) // deve ser zero + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="lstcat">lstcat</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">insertion</link> + </member> + <member> + <link linkend="extraction">extraction</link> + </member> + <member> + <link linkend="size">size</link> + </member> + <member> + <link linkend="length">length</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/lstcat.xml b/modules/data_structures/help/pt_BR/lstcat.xml new file mode 100755 index 000000000..6304e5aa5 --- /dev/null +++ b/modules/data_structures/help/pt_BR/lstcat.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="lstcat" xml:lang="en"> + <refnamediv> + <refname>lstcat</refname> + <refpurpose>concatenao de listas</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>lc=lstcat(l1,..ln)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>li</term> + <listitem> + <para>lista ou qualquer outro tipo de varivel </para> + </listitem> + </varlistentry> + <varlistentry> + <term>lc</term> + <listitem> + <para>uma lista </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <literal>lc=lstcat(l1,..ln)</literal> concatena os componentes das + <literal>li</literal> listas em uma nica lista. Se os + <literal>li</literal> so outros tipos de variveis, eles simplesmente so + adicionados lista resultante. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +lstcat(list(1,2,3),33,list('foo',%s)) +lstcat(1,2,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/matrices.xml b/modules/data_structures/help/pt_BR/matrices.xml new file mode 100755 index 000000000..84bfcde05 --- /dev/null +++ b/modules/data_structures/help/pt_BR/matrices.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<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="matrices" xml:lang="en"> + <refnamediv> + <refname>matrices</refname> + <refpurpose>objeto do Scilab: matrizes</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para>Matrizes so objetos bsicos definidos no Scilab. Elas podem ser + definidas como segue: + </para> + <programlisting role=""><![CDATA[ +E=[e11,e12,...,e1n; + e21,e22,...,e2n; + .... + em1,em2,...,emn]; + ]]></programlisting> + <para> + As entradas <literal>eij</literal> podem ser nmeros reais, + complexos, polinmios, razes de polinmios, strings ou booleanos. + </para> + <para>Vetores so vistos como matrizes de uma linha ou uma coluna.</para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +E=[1,2;3,4] +E=[%T,%F;1==1,1~=1] +s=poly(0,'s'); +E=[s,s^2;1,1+s] +E=[1/s,0;s,1/(s+1)] +E=['A11','A12';'A21','A22'] + ]]></programlisting> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="poly">poly</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="boolean">boolean</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="empty">empty</link> + </member> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/mlist.xml b/modules/data_structures/help/pt_BR/mlist.xml new file mode 100755 index 000000000..72c3a9bed --- /dev/null +++ b/modules/data_structures/help/pt_BR/mlist.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="mlist" xml:lang="en"> + <refnamediv> + <refname>mlist</refname> + <refpurpose>objeto Scilab, definio de listas com tipos orientadas + matricialmente + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>mlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>vector of character strings</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + any Scilab object (<literal>matrix, + list,string... + </literal> + ). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Objetos mlist so bastante semelhantes a objetos <link linkend="tlist">tlist</link> objects. A nica diferena concerne s + sintaxes de extrao e insero (<link linkend="extraction">extraction</link> e <link linkend="insertion">insertion</link>): se <literal>M</literal> uma + mlist, para qualquer ndice <literal>i</literal> que no um campo de + nome, <literal>M(i)</literal> no mais o <literal>i</literal>-simo + campo da lista + </para> + <para>A semntica da sintaxe de extrao e insero deve ser dada por uma + funo de (sobrecarga) <link linkend="overloading">overloading</link>. + </para> + <para>A funo de overloading para sintaxe de extrao + <literal>b=a(i1,...,in)</literal> tem a seguinte seqncia de chamamento: + <literal>b=%<tipo_de_a>_e_(i1,...,in,a)</literal> + </para> + <para> + e a sintaxe <literal>[x1,..,xm]=a(i1,...,in)</literal> tem a + seguinte seqncia de chamamento: + <literal>[x1,..,xm]=%<type_de_a>_e_(i1,...,in,a)</literal> + </para> + <para/> + <para>A funo de overloading associada sintaxe de insero + <literal>a(i1,...,in)=b</literal> tem a seguinte seqncia de chamamento: + <literal>a=%<type_de_b>_i_<type_de_a>(i1,...,in,b,a)</literal>. + </para> + <para/> + <para>Os campos de um mlist devem, ento, ser designados por seus nomes. + Eles tambm podem ser manipulados usando-se as funes + <literal>getfield</literal> e <literal>setfield</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +//Definindo exibio +function %V_p(M),disp(M.name+':'+string(M.value)),endfunction + +//Definindo operao de extrao +function r=%V_e(varargin) + M=varargin($) + r=mlist(['V','name','value'],M.name(varargin(1:$-1)),M.value(varargin(1:$-1))) +endfunction +M(2,:) // a segunda entrada do vetor M +M.value + +//Definindo operaes de insero +function M=%V_i_V(varargin) + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N.value + M.name(varargin(1:$-2))=N.name +endfunction +M(1,1)=M(2,2) + +function M=%s_i_V(varargin) //insero de uma matriz regular em uma matriz V + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N + M.name(varargin(1:$-2))=emptystr(N) +endfunction +M(1,1)=44 + +//caso de tlists +M=tlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +M(2) +M(2)='a'+string([1 2;3 4]) + +M('name') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/null.xml b/modules/data_structures/help/pt_BR/null.xml new file mode 100755 index 000000000..e5d4b3205 --- /dev/null +++ b/modules/data_structures/help/pt_BR/null.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<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="null" xml:lang="en"> + <refnamediv> + <refname>null</refname> + <refpurpose>deleta um elemento em uma lista</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>l(i)=null()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Deleta objetos dentro de uma lista.</para> + </refsection> + <refsection> + <title> Exemplos </title> + <programlisting role="example"><![CDATA[ +l=list(1,"foo",3); +l(2)=null() // retorna list(1,3) + ]]></programlisting> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="clear">clear</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/rlist.xml b/modules/data_structures/help/pt_BR/rlist.xml new file mode 100755 index 000000000..014d1c9b2 --- /dev/null +++ b/modules/data_structures/help/pt_BR/rlist.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="rlist" xml:lang="en"> + <refnamediv> + <refname>rlist</refname> + <refpurpose>definio de funo racional do Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>rlist() + rlist(a1,....an) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para> + <literal>rlist(a1,....an)</literal> um atalho para + <literal>tlist(['r','num';'den','dt'], a1,....an)</literal> + </para> + <para> + Cria um <literal>tlist</literal> com + <literal>['r','num';'den','dt']</literal> como primeira entrada e os + <literal>ai</literal>'s como prximas entradas, se tiver algum. Nenhuma + verificao de tipo ou tamanho feita nos <literal>ai</literal>'s. + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/setfield.xml b/modules/data_structures/help/pt_BR/setfield.xml new file mode 100755 index 000000000..209b20fdd --- /dev/null +++ b/modules/data_structures/help/pt_BR/setfield.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="setfield" xml:lang="en"> + <refnamediv> + <refname>setfield</refname> + <refpurpose>insero de campos de listas</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>setfield(i,x,l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>matriz de qualquer tipo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>lista, tlist ou mlist </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>ndice de campo, ver "insertion" para mais detalhes.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Esta funo equivalente sintaxe <literal>l(i)=x</literal> spara + insero de campos, com a nica diferena de que tambm se aplica a + objetos <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +l(1)='Modificado' +l(0)='Adicionado' +l(6)=['mais um';'adicionado'] + +a=hypermat([2,2,2],rand(1:2^3));// hipermatrizes so codificadas usando-se mlists +setfield(3,1:8,a);a // ajusta o valor de campo para 1:8 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="insertion">insertion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/struct.xml b/modules/data_structures/help/pt_BR/struct.xml new file mode 100755 index 000000000..967da4ae9 --- /dev/null +++ b/modules/data_structures/help/pt_BR/struct.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="struct" xml:lang="en"> + <refnamediv> + <refname>struct</refname> + <refpurpose>criando um struct (estrutura)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>st=struct(field1,value1,field2,value2...)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>field1, field2, ..</term> + <listitem> + <para>strings, representam os nomes dos campos</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value1, value2, ..</term> + <listitem> + <para>todos os tipos de dados (double, char, int, ...), representam + os valores dos campos + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Esta funo retorna uma estrutura com campos de nomes + <literal>fields1</literal>, <literal>field2</literal>, ..., e valores + correspondentes <literal>value1</literal>, <literal>value2</literal>, + ... + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +// criando um dado struct +date_st=struct('dia',25,'mes' ,'DEZ','ano',2006) + +//mudando o mes +date_st.mes='AGO'; + +// mudando o ano +date_st.ano=1973; + +//mudando o dia +date_st.dia=19; + +// adicionando um novo campo +date_st.semana=32 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/tlist.xml b/modules/data_structures/help/pt_BR/tlist.xml new file mode 100755 index 000000000..63035a32b --- /dev/null +++ b/modules/data_structures/help/pt_BR/tlist.xml @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="tlist" xml:lang="en"> + <refnamediv> + <refname>tlist</refname> + <refpurpose>objeto do Scilab e definio de listas com tipos ("typed + lists") + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>tlist(typ,a1,....an )</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>string ou vetor de strings </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + qualquer objeto Scilab (<literal>matrix, + list,string... + </literal> + ). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Cria um <literal>typed-list</literal> com elementos + <literal>ai</literal>'s. O argumento <literal>typ</literal> especifica o + tipo da lista. Tais <literal>typed-list</literal> permitem ao usurio + definir novas operaes trabalhando nestes objetos atravs de funes do + Scilab. A nica diferena entre um <literal>typed-list</literal> e um + <literal>list</literal> (lista) o valor do tipo (16 ao invs de + 15). + </para> + <para> + <literal>typ(1)</literal> espeifica o tipo de lista (string usado + para definir operaes "soft-coded"). + </para> + <para> + Se especificado, <literal>typ(i)</literal> pode fornecer o nome + formal do <literal>i+1</literal> -simo elemento. + </para> + <para> + Operaes padres em <literal>list</literal> operam de modo + semelhante para <literal>typed-list</literal>: + </para> + <para> + Extrao : <literal>[x,y,z...]=l(v)</literal> onde + <literal>v</literal> o vetor de ndices; <literal>[x,y,z]=l(:)</literal> + extrai todos os elementos. + </para> + <para> + Insero: <literal>l(i)=a</literal> + </para> + <para> + Deleo: <literal>l(i)=null()</literal> remove o i-simo elemento do + <literal>tlist l</literal>. + </para> + <para>Exibio.</para> + <para> + Alm disso, se <literal>typ(2:n+1)</literal> forem especificados, o + usurio pode apontar elementos por seus nomes. + </para> + <para>Abaixo fornecemos exemplos de onde tlists so usados:</para> + <para>Sistemas lineares so representados por + <literal>typed-list</literal> especficos, ex.: um sistema linear + <literal>[A,B,C,D]</literal> representado pelo tlist + <literal>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</literal> + e esta lista especfica pode ser criada pela funo + <literal>syslin</literal>. + </para> + <para>Sys(2), Sys('A') ou Sys.A a estado-matriz e Sys('dt') ou Sys.dt + o domnio de tempo + </para> + <para> + Uma matriz de razes de polinmios <literal>H</literal> + representada por um <literal>typed-list</literal> + <literal>H=rlist(Num,Den,[])</literal> onde + <literal>Num</literal> e <literal>Den</literal> so duas matrizes de + polinmios e um sistema linear (ex.: de tempo contnuo) com matriz de + transferncia <literal>H</literal> possivelmente criada por + <literal>syslin('c',H)</literal>. + </para> + <para>H(2), H('num') ou H.num o numerador da matriz de + transferncia + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="percent">percent</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/type.xml b/modules/data_structures/help/pt_BR/type.xml new file mode 100755 index 000000000..f1bd93bbf --- /dev/null +++ b/modules/data_structures/help/pt_BR/type.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<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="type" xml:lang="en"> + <refnamediv> + <refname>type</refname> + <refpurpose>tipo de varivel</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title> Seqncia de Chamamento </title> + <synopsis>[i]=type(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>objeto Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>inteiro</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <literal>type(x)</literal>retorna um inteiro que indica o tipo de + <literal>x </literal>como segue: + </para> + <para> 1 : uma matriz constante de reais ou complexos;</para> + <para> 2 : uma matriz de polinmios;</para> + <para> 4 : uma matriz de valores booleanos;</para> + <para> 5 : uma matriz esparsa;</para> + <para> 6 : uma matriz de valores booleanos esparsa;</para> + <para> 7 : uma matriz esparsa do Matlab.</para> + <para> 8 : uma matriz de inteiros armazenados em 1, 2 ou 4 bytes;</para> + <para> 9 : uma matriz de manipuladores grficos;</para> + <para> 10 : uma matriz de strings;</para> + <para> 11 : uma funo no-compilada (cdigo Scilab);</para> + <para> 13 : uma funo compilada (cdigo Scilab);</para> + <para> 14 : uma biblioteca de funes;</para> + <para> 15 : uma lista;</para> + <para> 16 : uma lista com tipo ("typed list" ou "tlist");</para> + <para> 17 : uma lista com tipo orientada matricialmente (mlist);</para> + <para> + 128 : um ponteiro (ver <link linkend="lufact">lufact</link>). + </para> + <para>129 : polinmio de tamanho implcito, usado para indexao.</para> + <para>130 : intrnseco do Scilab (cdigo C ou Fortran).</para> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="inttype">inttype</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/typename.xml b/modules/data_structures/help/pt_BR/typename.xml new file mode 100755 index 000000000..8782768f4 --- /dev/null +++ b/modules/data_structures/help/pt_BR/typename.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<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="typename" xml:lang="en"> + <refnamediv> + <refname>typename</refname> + <refpurpose>associa um nome ao tipo de varivel</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[types [ [,names]]=typename() + typename(name,type) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>types</term> + <listitem> + <para>vetor coluna de inteiros: os cdigos dos tipos de cada tipo de + dado definido. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>vetor coluna de strings: os nomes associados aos cdigos de + tipos. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para>inteiro: o cdigo de tipo do novo tipo de dado. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>string: o nome associado ao cdigo de tipo </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>O overloading de funes e operadores faz uso de nomes formais + associados aos tipos de dados para formar o nome da funo de overloading + (ver overloading). <literal>typename</literal> pode ser usado para + manipular esses nomes formais para tipos de dados "hard-coded" (os nomes + formais de tipos de dados codificados de <literal>tlist</literal> ou + <literal>mlist</literal> so definidos de outra forma, ver + <literal>overloading</literal>). + </para> + <para> + Chamado sem argumento do lado direito, <literal>typename</literal> + retorna informaes sobre tipos de dados definidos. + </para> + <para> + Chamado com argumento do lado direito, <literal>typename</literal> + associa um nome a um cdigo de tipo de dado. + </para> + <para> + <literal>typename('',type)</literal> suprime o tipo de dado + fornecido pelo seu cdigo <literal>type</literal> de tabelas de tipos de + dados conhecidos. + </para> + <para>Number max. of defined types is 50.</para> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="overloading">overloading</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/pt_BR/typeof.xml b/modules/data_structures/help/pt_BR/typeof.xml new file mode 100755 index 000000000..5ced03a8e --- /dev/null +++ b/modules/data_structures/help/pt_BR/typeof.xml @@ -0,0 +1,207 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="typeof" xml:lang="en"> + <refnamediv> + <refname>typeof</refname> + <refpurpose>tipo do objeto</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[t]=typeof(object)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>object</term> + <listitem> + <para>objeto Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <literal>t=typeof(object)</literal> retorna um dos seguintes + strings: + </para> + <variablelist> + <varlistentry> + <term>"constant"</term> + <listitem> + <para>se o objeto uma matriz constante de reais ou + complexos + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"polynomial"</term> + <listitem> + <para>se o objeto uma matriz de polinmios</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"function"</term> + <listitem> + <para>se o objeto uma funo (cdigo Scilab).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"handle"</term> + <listitem> + <para>se o objeto um manipulador ("ala")</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"string"</term> + <listitem> + <para>se o objeto uma matriz de strings</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean"</term> + <listitem> + <para>se o objeto uma matriz de valores booleanos</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"list"</term> + <listitem> + <para>se o objeto uma lista</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"rational"</term> + <listitem> + <para>se o objeto a uma martriz de razes de polinmios (matriz + de transferncia) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"state-space"</term> + <listitem> + <para> + se o objeto um modelo de espao de estados (ver <link linkend="syslin">syslin</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"sparse"</term> + <listitem> + <para>se o objeto uma matriz (de reais) esparsa.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean sparse"</term> + <listitem> + <para>se o objeto uma matriz de valores booleanos esparsa.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"hypermat"</term> + <listitem> + <para>se o objeto uma hipermatriz (array N-dimensional N + >=3). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"st"</term> + <listitem> + <para>se o objeto um array de estrutura</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"ce"</term> + <listitem> + <para>se o objeto um array de clulas</para> + </listitem> + </varlistentry> + <varlistentry> + <term>the first string in the first list entry</term> + <listitem> + <para>se o objeto um tlist ou mlist</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"fptr"</term> + <listitem> + <para>se o objeto intrnseco ao Scilab (cdigo C ou + Fortran). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"pointer"</term> + <listitem> + <para> + se o objeto um ponteiro (ver <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"size implicit"</term> + <listitem> + <para>se o objeto um polinmio de tamanho implcito para + indexao. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +typeof(1) +typeof(poly(0,'x')) + +typeof(1/poly(0,'x')) +typeof(%t) + +w=sprand(100,100,0.001); +typeof(w) +typeof(w==w) + +deff('y=f(x)','y=2*x'); +typeof(f) + +L=tlist(['V','a','b'],18,'Scilab'); +typeof(L) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="strings">strings</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="poly">poly</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/addchapter.sce b/modules/data_structures/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..9331d2503 --- /dev/null +++ b/modules/data_structures/help/ru_RU/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Data Structures",SCI+"/modules/data_structures/help/ru_RU",%T); + diff --git a/modules/data_structures/help/ru_RU/boolean.xml b/modules/data_structures/help/ru_RU/boolean.xml new file mode 100755 index 000000000..8658f8914 --- /dev/null +++ b/modules/data_structures/help/ru_RU/boolean.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="boolean"> + <refnamediv> + <refname>boolean</refname> + <refpurpose>Объекты Scilab'а, логические переменные и операторы & | ~ + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Логическими переменными являются <constant>%T</constant>, ИСТИНА (англ. "true"), и <constant>%F</constant>, ЛОЖЬ (англ. "false"). Эти переменные могут использоваться для определения матриц логических значений с помощью обычного синтаксиса. С матрицами логических значений можно обращаться как с обычными матрицами для выделения/вставки элементов и конкатенации. Заметим, что другие обычные операции(<literal>+</literal>, <literal>*</literal>, <literal>-</literal>, <literal>^</literal> и т. д.) не определены для матриц логических значений. Для матриц логических значений определены три специальных оператора: + </para> + <variablelist> + <varlistentry> + <term>~b</term> + <listitem> + <para> + поэлементное логическое НЕ матрицы <literal>b</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1 & b2</term> + <listitem> + <para> + поэлементное логическое И матриц <literal>b1</literal> и <literal>b2</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>b1 | b2</term> + <listitem> + <para> + поэлементное логическое ИЛИ матриц <literal>b1</literal> и <literal>b2</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Логические переменные могут использоваться для индексации матриц и векторов. Например, <code>a([%T, %F, %T],:)</code> возвращает подматрицу, составленную из строк <literal>1</literal> и <literal>3</literal> матрицы <literal>a</literal>. Поддерживаются разрежённые логические матрицы. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[1,2]==[1,3] +[1,2]==1 +a=1:5; a(a>2) +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="matrices">матрицы</link> + </member> + <member> + <link linkend="or">or</link> + </member> + <member> + <link linkend="and">and</link> + </member> + <member> + <link linkend="not">not</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/cell.xml b/modules/data_structures/help/ru_RU/cell.xml new file mode 100755 index 000000000..21b35a20f --- /dev/null +++ b/modules/data_structures/help/ru_RU/cell.xml @@ -0,0 +1,169 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2007-2008 - INRIA +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="cell" xml:lang="ru"> + <refnamediv> + <refname>cell</refname> + <refpurpose>создаёт cell-массив пустых матриц</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + c = cell() + c = cell(m1) + c = cell(m1, m2) + c = cell(m1, m2, ..., mn) + c = cell(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para> + целочисленный вектор, содержащий размеры cell-массива, который требуется создать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>m1, m2, ..., mn</term> + <listitem> + <para> + целые числа: размеры cell-массива, который + требуется создать. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>cell</function> возвращает cell-массив пустых матриц. + </para> + <variablelist> + <varlistentry> + <term>cell()</term> + <listitem> + <para> + возвращает cell-массив размером <literal>0 x 0</literal> пустых матриц. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1)</term> + <listitem> + <para> + возвращает cell-массив размером <literal>m1 x m1)</literal> пустых матриц. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1, m2)</term> + <listitem> + <para> + возвращает cell-массив размером <literal>m1 x m2</literal> пустых матриц. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(m1, m2, ..., mn)</term> + <listitem> + <para> + создаёт cell-массив размером <literal>m1 x m2 x ... x mn</literal> пустых матриц. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cell(x)</term> + <listitem> + <para> + возвращает cell-массив пустых матриц у которого первая размерность равна <literal>x(1)</literal>, вторая размерность равна <literal>x(2)</literal> и так далее. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Примечания</title> + <para> + У <code>cell(x)</code> не такой же размер, как у <varname>x</varname>. + </para> + <para> + <code>cell()</code> эквивалентна <code>cell(0)</code>. + </para> + <para> + Если <literal>A</literal> является cell-массивом, то у вас есть + допуск к содержимому элемента <literal>A</literal> с помощью + <code>A(m1, m2, ..., mn).entries</code>. Инструкция + <code>A(1,1) = zeros(2,2)</code> не допустима, правильным + синтаксисом является <code>A(1,1).entries = zeros(2,2)</code>. + </para> + <para> + Если <literal>A</literal> является cell-массивом, то вы можете получить его размеры с помощью <code>A.dims</code>, которое возвращает значение типа <literal>int32</literal> и которое нельзя использовать в качестве индекса в cell-массиве. В этом случае лучше всего использовать <code>size(A)</code>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +a=cell(3) +b=cell(3,1) +c=cell([2,3,4]) + +// Определение cell-элементов +b=cell(3,1); + +// Присвоение значения первому элементу b с помощью поля 'entries' +b(1).entries=1:3 + +// Присвоение значения второму элементу b с помощью поля 'entries' +b(2).entries='Scilab' + +// Присвоение значения третьему элементу b с помощью поля 'entries' +b(3).entries=poly(1:3,'s') + +// Присвоение cell-подмассивов +X=cell(3,2); +X(:,1)=b + +// Выделение cell-подмассива: результатом является cell-массив +b(1) +b(1:2) + +// Выделение значения cell-подмассива: результатом является массив +b(1).entries + +// Размеры b в виде значения int32 (нельзя использовать в качестве индекса) +b.dims +// Размеры b в виде значения double +size(b) + +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="eye">eye</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/definedfields.xml b/modules/data_structures/help/ru_RU/definedfields.xml new file mode 100755 index 000000000..f50b6f11b --- /dev/null +++ b/modules/data_structures/help/ru_RU/definedfields.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="definedfields"> + <refnamediv> + <refname>definedfields</refname> + <refpurpose> + возвращает индекс определённых полей списков + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>k = definedfields(lst)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>lst</term> + <listitem> + <para>переменная типа list, tlist или mlist.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>k</term> + <listitem> + <para>вектор индексов.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Если <varname>lst</varname> является списком <literal>list</literal>, типизированным списком + <literal>tlist</literal>, матричноориентированным списком <literal>mlist</literal>, то <code>k = definedfields(lst)</code> возвращает в <varname>k</varname> индексы определённых полей списка. Эта функция полезна, поскольку индексация неопределённых полей формирует ошибку. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +lst=list(1);lst(3)=5 +k=definedfields(lst) + +t=tlist('x');t(5)=4 +definedfields(t) + +m=mlist(['m','a','b']);m.b='sdfgfgd' +definedfields(m) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">вставка</link> + </member> + <member> + <link linkend="extraction">выделение</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/fieldnames.xml b/modules/data_structures/help/ru_RU/fieldnames.xml new file mode 100755 index 000000000..722ce99f1 --- /dev/null +++ b/modules/data_structures/help/ru_RU/fieldnames.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * Copyright (C) 2010 - Digiteo - Vincent LIARD + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="fieldnames"> + <refnamediv> + <refname>fieldnames</refname> + <refpurpose> + получает имена полей переменных типа tlist, mlist или struct + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>f = fieldnames(lst)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>lst</term> + <listitem> + <para> + типизированный список (tlist), матричноориентированный список (mlist) или структура (struct). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>вектор-столбец имён полей.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>fieldnames</function> возвращает имена полей типизированного списка (tlist), матричноориентированного списка (mlist) или структуры (struct). Функция <function>fieldnames</function> не работает с cell-массивами. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + fieldnames(tlist(['listtype', 'f1', 'f2'], [], [])) + fieldnames(mlist(['V', 'ключ', 'значение'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4])) + fieldnames(struct('день', 7, 'месяц', 'ЯНВАРЬ', 'год', 2007)) + obj.x = 3; + obj.y = 3; + fieldnames(obj) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">выделение</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="struct">struct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/getfield.xml b/modules/data_structures/help/ru_RU/getfield.xml new file mode 100755 index 000000000..41277d78d --- /dev/null +++ b/modules/data_structures/help/ru_RU/getfield.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="getfield"> + <refnamediv> + <refname>getfield</refname> + <refpurpose>выделение поля списка</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[x,...] = getfield(i, l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>матрица любого всевозможного типа.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para> + список (list), типизированный список (tlist) или матричноориентированный список (mlist). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para> + целое число: индекс поля, см. подробности в документации по <link linkend="extraction">выделению</link>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Инструкция <literal>[x,...] = getfield(i, l)</literal> эквивалентна <literal>[x,...] = l(i)</literal> для выделения поля с той лишь разницей, что она может также применяться к объектам типа <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +[a,b]=getfield([3 2],l) + +a=hypermat([2,2,2],rand(1:2^3));// гиперматрицы кодируются используя mlist-ы +a(1) // элемент a(1,1,1) +getfield(1,a) // первое поле mlist-а + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="extraction">выделение</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/hypermat.xml b/modules/data_structures/help/ru_RU/hypermat.xml new file mode 100755 index 000000000..1f8298d42 --- /dev/null +++ b/modules/data_structures/help/ru_RU/hypermat.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermat"> + <refnamediv> + <refname>hypermat</refname> + <refpurpose>инициализирует N-мерную матрицу</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>M = hypermat(dims [,v])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>dims</term> + <listitem> + <para>вектор размеров гиперматрицы.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>v</term> + <listitem> + <para> + вектор элементов гиперматрицы (значение по умолчанию <code>zeros(prod(dims),1)</code>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>hypermat</function> инициализирует гиперматрицу, чьи + размеры заданы в векторе <varname>dims</varname>, а элементы заданы в + необязательном аргументе <varname>v</varname>. + </para> + <para> + Структура данных <varname>M</varname> содержит вектор размеров + матрицы <code>M('dims')</code> и вектор элементов + <code>M('entries')</code> такие, что первыми изменяются самые левые + индексы <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal> + </para> + <para> + <warning> + Если вы строите свою собственную <function>hypermat</function>, то вы + должны быть осторожны. Элемент <code>M('dims')</code> должен быть + вектор-строкой, а элемент <code>M('entries')</code> должен быть вектор-столбцом. + </warning> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +M = hypermat([2 3 2 2],1:24) +disp(size(M('dims'))) +disp(size(M('entries'))) + +M_own = mlist(['hm','dims','entries']); +M_own('dims') = [2 3 2 2]; +M_own('entries') = [1:24]'; +disp(size(M_own('dims'))) +disp(size(M_own('entries'))) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="hypermatrices">hypermatrices</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/hypermatrices.xml b/modules/data_structures/help/ru_RU/hypermatrices.xml new file mode 100755 index 000000000..e38e77a8f --- /dev/null +++ b/modules/data_structures/help/ru_RU/hypermatrices.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="hypermatrices"> + <refnamediv> + <refname>hypermatrices</refname> + <refpurpose>объект Scilab'а, N-мерная матрица в Scilab'е</refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Тип гиперматрицы позволяет манипулировать многомерными массивами. + </para> + <para> + Они могут быть определены расширением двумерных матриц следующим + образом <code>a=[1 2;3 4];a(:,:,2)=rand(2,2)</code> или напрямую + с помощью функции <function>hypermat</function>. + </para> + <para> + Элементы могут быть вещественными или комплексными числами, + полиномами, рациональными числами, строковыми и логическими + значениями. + </para> + <para> + Гиперматрицы являются матричноориентированными списками <literal>mlists</literal>: + <code>mlist(['hm','dims','entries'],sz,v)</code>, где + <literal>sz</literal> - вектор-строка размеров, а + <literal>v</literal> - вектор-столбец элементов (первая + размерность сохраняется первой). + </para> + <para> + <note> + Число размерностей гиперматрицы с самыми правыми размерами, + равными 1, автоматически уменьшается. Гиперматрица, у которой + только две размерности, автоматически меняется на обычную матрицу + (тип 1). + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +a(1,1,1,1:2)=[1 2] +a=[1 2;3 4];a(:,:,2)=rand(2,2) +a(1,1,:) + +size(a) + +a(:,:,1) //уменьшение размерности +type(a(:,:,1)) + +[a a] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="hypermat">hypermat</link> + </member> + <member> + <link linkend="zeros">zeros</link> + </member> + <member> + <link linkend="ones">ones</link> + </member> + <member> + <link linkend="grand">grand</link> + </member> + <member> + <link linkend="matrix">matrix</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/iscell.xml b/modules/data_structures/help/ru_RU/iscell.xml new file mode 100755 index 000000000..812c56021 --- /dev/null +++ b/modules/data_structures/help/ru_RU/iscell.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscell" xml:lang="ru"> + <refnamediv> + <refname>iscell</refname> + <refpurpose>проверяет: является ли переменная cell-массивом</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>bool = iscell(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>переменная Scilab'а.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>логическое значение.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>iscell(x)</code> возвращает <constant>%t</constant>, если + <varname>x</varname> является cell-массивом, и <constant>%f</constant> - в противном случае. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +iscell(1) + +iscell(cell()) + +c = cell(1,2); +c(1).entries="Scilab"; +c(2).entries=datenum(); +iscell(c) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/iscellstr.xml b/modules/data_structures/help/ru_RU/iscellstr.xml new file mode 100755 index 000000000..c246b3dcc --- /dev/null +++ b/modules/data_structures/help/ru_RU/iscellstr.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="iscellstr" xml:lang="ru"> + <refnamediv> + <refname>iscellstr</refname> + <refpurpose>проверяет: является ли переменная cell-массивом строковых значений</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>bool = iscellstr(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>переменная Scilab'а.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>логическое значение.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>iscellstr(x)</code> возвращает <constant>%t</constant>, + если <varname>x</varname> являетя cell-массивом строковых + значений (или пустой cell-массив), и <constant>%f</constant> - в противном случае. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +iscellstr(1) + +iscellstr(cell()) + +iscellstr(cell(3)) + +strcell = cell(3,1); +strcell(1).entries="Scilab"; +strcell(2).entries="iscellstr"; +strcell(3).entries="help"; +iscellstr(strcell) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + <member> + <link linkend="isstruct">isstruct</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/isfield.xml b/modules/data_structures/help/ru_RU/isfield.xml new file mode 100755 index 000000000..3e44bd659 --- /dev/null +++ b/modules/data_structures/help/ru_RU/isfield.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isfield"> + <refnamediv> + <refname>isfield</refname> + <refpurpose>проверяет: существует ли поле с указанным именем в структуре</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>bool = isfield(s, fieldname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>массив структуры.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fieldname</term> + <listitem> + <para>матрица строк.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>матрица логических значений.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Эта функция возвращает <constant>%t</constant>, если указанная + структура <varname>s</varname> содержит поле с именем <varname>fieldname</varname>, не взирая на его значение. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +s = struct("field_1",123,"field_2",456,"field_4",789) + +// Single Fieldname Syntax +isfield( s , "field_1" ) + +// Multiple Fieldname Syntax +isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] ) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="definedfields">definedfields</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/isstruct.xml b/modules/data_structures/help/ru_RU/isstruct.xml new file mode 100755 index 000000000..f6a74477b --- /dev/null +++ b/modules/data_structures/help/ru_RU/isstruct.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="isstruct" xml:lang="ru"> + <refnamediv> + <refname>isstruct</refname> + <refpurpose>проверяет: является ли переменная массивом-структурой</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>bool = isstruct(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>переменная Scilab'а.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bool</term> + <listitem> + <para>логическое значение.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>isstruct(x)</code> возвращает <constant>%t</constant>, если + <varname>x</varname> является массивом-структурой, и <constant>%f</constant> - в противном случае. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +isstruct(1) + +isstruct(cell()) + +isstruct(struct("name","Scilab", "version", getversion())) + +info.name="Scilab"; +info.function="isstruct"; +info.module="help"; +isstruct(info) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="struct">struct</link> + </member> + <member> + <link linkend="iscell">iscell</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/list.xml b/modules/data_structures/help/ru_RU/list.xml new file mode 100755 index 000000000..02a9c71cd --- /dev/null +++ b/modules/data_structures/help/ru_RU/list.xml @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="list"> + <refnamediv> + <refname>list</refname> + <refpurpose>объект Scilab'а и функция определения списка</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>list(a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + Создаёт список <literal>list</literal> с элементами + <varname>ai</varname>, которые являются произвольными объектами Scilab'а (<literal>matrix</literal>, + <literal>list</literal>,...). Тип объекта <literal>list</literal> равен 15. <code>list()</code> + создаёт пустой список (0 элементов). + </para> + </refsection> + <refsection> + <title>Операции со списками</title> + <variablelist> + <varlistentry> + <term>выделение</term> + <listitem> + <para> + <literal>[x,y,z,...]=L(v)</literal>, где <literal>v</literal> - вектор индексов; + <literal>[x,y,z,...]=L(:)</literal> выделяет все элементы. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>вставка на место индекса i</term> + <listitem> + <para> + <code>L(i)=a</code> (заметьте, что это не ошибка использовать <code>L(i)=a</code> с + <code><![CDATA[i > 1 + size(L)]]></code>, но + некоторые элементы списка тогда не определены, и их + выделение вызовет ошибку). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>добавление элемента в хвост</term> + <listitem> + <para> + <code>L($+1)=e</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>добавление элемента в начало</term> + <listitem> + <para> + <code>L(0)=e</code>. + <note> + После этой операции <literal>e</literal> имеет индекс 1, исходные элементы будут сдвинуты вправо. + </note> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>удаление</term> + <listitem> + <para> + <code>L(i)=null()</code> удаляет <literal>i</literal>-тый элемент списка <literal>L</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>конкатенация двух списков</term> + <listitem> + <para> + <code>L3 = lstcat(L1,L2)</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>число элементов списка</term> + <listitem> + <para> + вы можете использовать либо <code>nb_elm = size(L)</code>, либо <code>nb_elm = length(L)</code>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>итерации со списками</term> + <listitem> + <para> + можно использовать список <literal>L</literal> в цикле <link linkend="for">for</link>: + <literal>for e=L,...,end</literal> - цикл с числом + итераций <literal>length(L)</literal>, переменная + цикла <literal>e</literal> будет равна <literal>L(i)</literal> + на <literal>i</literal>-той итерации. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Примечания</title> + <para> + Scilab предлагает также другие виды списков, тип <link linkend="tlist">tlist</link> (типизированный список) + и тип <link linkend="mlist">mlist</link> + (матричноориентированный список), которые полезны для + определения нового типа данных с механизмом + <link linkend="overloading">перегрузки</link> операторов + (<link linkend="hypermatrices">гиперматрицы</link>, которые + являются многомерными массивами, в Scilab'е на самом деле + имеют тип <emphasis>mlist</emphasis>). + </para> + <para> + Также доступны структуры <emphasis>struct</emphasis> Matlab'а. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +l = list(1,["a" "b"]) // объявление основного списка с элементом типа + // double и вектором двух строковых значений +size(l) // размер равен 2 +// l(0) - Не существует! +l(1) // доступ к значению типа double +l(2) // доступ к вектору строковых значений +size(l(2)) // размер равен 1,2 + +l(0) = "foo" // вставка в начало списка +// l(0) - по-прежнему не существует +l(1) // равно "foo" + +l($+1) = "hello" // вставка в конец списка +l(2) = "toto" // перезапись моего значения типа double +l(3) = rand(1,2) // перезапись моего вектора строковых значений + +l(3) = null() // удаление третьего элемента + +lbis = list("gewurtz", "caipirina" ,"debug") // объявление нового списка +lter = lstcat(l,lbis) // слияние двух списков +size(lter) - size(lbis) - size(l) // должен быть ноль + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="null">null</link> + </member> + <member> + <link linkend="lstcat">lstcat</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + <member> + <link linkend="insertion">вставка</link> + </member> + <member> + <link linkend="extraction">выделение</link> + </member> + <member> + <link linkend="size">size</link> + </member> + <member> + <link linkend="length">length</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/lstcat.xml b/modules/data_structures/help/ru_RU/lstcat.xml new file mode 100755 index 000000000..8ed489de9 --- /dev/null +++ b/modules/data_structures/help/ru_RU/lstcat.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="lstcat"> + <refnamediv> + <refname>lstcat</refname> + <refpurpose>конкатенация списков</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>lc = lstcat(l1, ..., ln)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>li</term> + <listitem> + <para>список или иной тип переменной</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lc</term> + <listitem> + <para>список</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Инструкция <literal>lc = lstcat(l1, ..., ln)</literal> + конкатенирует компоненты списки <varname>li</varname> в + единый список <varname>lc</varname>. Если + <varname>li</varname> являются переменными иного типа, + то они просто добавляются к результирующему списку. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +lstcat(list(1,2,3),33,list('foo',%s)) +lstcat(1,2,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/matrices.xml b/modules/data_structures/help/ru_RU/matrices.xml new file mode 100755 index 000000000..d159ffb4c --- /dev/null +++ b/modules/data_structures/help/ru_RU/matrices.xml @@ -0,0 +1,61 @@ +<?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="matrices"> + <refnamediv> + <refname>матрицы</refname> + <refpurpose>объект Scilab'а, матрицы в Scilab'е</refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Матрицы являются основными объектами, определёнными в Scilab'е. + Они могут определяться следующим образом: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +E=[e11,e12,...,e1n; + e21,e22,...,e2n; + .... + em1,em2,...,emn]; + ]]></programlisting> + <para> + Элементы <literal>eij</literal> могут быть вещественными или комплексными числами, + полиномами, рациональными дробями, строками, логическими значениями. + </para> + <para> + Векторы представляются как матрицы с одной строкой или одним столбцом. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +E=[1,2;3,4] +E=[%T,%F;1==1,1~=1] +s=poly(0,'s'); +E=[s,s^2;1,1+s] +E=[1/s,0;s,1/(s+1)] +E=['A11','A12';'A21','A22'] + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="poly">poly</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="boolean">boolean</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + <member> + <link linkend="empty">empty</link> + </member> + <member> + <link linkend="hypermatrices">гиперматрицы</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/mlist.xml b/modules/data_structures/help/ru_RU/mlist.xml new file mode 100755 index 000000000..0d61267ac --- /dev/null +++ b/modules/data_structures/help/ru_RU/mlist.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2007-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="mlist"> + <refnamediv> + <refname>mlist</refname> + <refpurpose>объект Scilab'а, определение матричноориентированного типизированного списка + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mlist(typ, a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para>вектор символьных строк.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + любой объект Scilab'а (матрица, список, строка, ...). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Объект <link linkend="mlist">mlist</link> очень похож на объект <link linkend="tlist">tlist</link>. + Единственное отличие касается синтаксиса <link linkend="extraction">выделения</link> и + <link linkend="insertion">вставки</link>: + если <literal>M</literal> является <literal>mlist</literal>'ом, то для любого индекса <literal>i</literal>, который не является именем поля, <literal>M(i)</literal> более не является <literal>i</literal>-тым полем списка. + </para> + <para> + Семантика синтаксиса выделения и вставки должна задаваться + функцией <link linkend="overloading">перегрузки</link>. + </para> + <para> + Функция перегрузки для синтаксиса выделения <literal>b=a(i1, ..., in)</literal> + имеет следующую последовательность вызова: <literal>b=%<тип_a>_e_(i1, ..., in, a)</literal>. + </para> + <para>и синтаксис + <literal>[x1, ..., xm]=a(i1, ..., in)</literal> имеет следующую последовательность вызова: + <literal>[x1, ..., xm]=%<тип_a>_e_(i1, ..., in,a)</literal>. + </para> + <para/> + <para> + Функция перегрузки, связанная с синтаксисом вставки + <literal>a(i1, ..., in)=b</literal> имеет следующую последовательность вызова: + <literal>a=%<тип_b>_i_<тип_a>(i1, ..., in, b, a)</literal>. + </para> + <para/> + <para> + Поля <literal>mlist</literal>'а должны тогда обозначаться по их + именам. Они также могут обрабатываться с помощью функций + <function>getfield</function> и <function>setfield</function>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); + +//определение вывода на экран +function %V_p(M),disp(M.name+':'+string(M.value)),endfunction + +//определение операции выделения +function r=%V_e(varargin) + M=varargin($) + r=mlist(['V','name','value'],M.name(varargin(1:$-1)),M.value(varargin(1:$-1))) +endfunction + +M(2,:) // вторая строка M +M.value + +//определение операции вставки +function M=%V_i_V(varargin) + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N.value + M.name(varargin(1:$-2))=N.name +endfunction +M(1,1)=M(2,2) + +function M=%s_i_V(varargin) //вставка обычной матрицы в матрицу V + M=varargin($) + N=varargin($-1) + M.value(varargin(1:$-2))=N + M.name(varargin(1:$-2))=emptystr(N) +endfunction +M(1,1)=44 + +// в случае tlist'а +M=tlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +M(2) +M(2)='a'+string([1 2;3 4]) + +M('name') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="overloading">перегрузка</link> + </member> + <member> + <link linkend="getfield">getfield</link> + </member> + <member> + <link linkend="setfield">setfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/null.xml b/modules/data_structures/help/ru_RU/null.xml new file mode 100755 index 000000000..7fad3936c --- /dev/null +++ b/modules/data_structures/help/ru_RU/null.xml @@ -0,0 +1,35 @@ +<?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="null"> + <refnamediv> + <refname>null</refname> + <refpurpose>удаление элемента в списке</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>l(i)=null()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + Удаление объектов внутри списка. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +l=list(1,"foo",3); +l(2)=null() // получить list(1,3) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="clear">clear</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/data_structures/help/ru_RU/rlist.xml b/modules/data_structures/help/ru_RU/rlist.xml new file mode 100755 index 000000000..b7670b2d9 --- /dev/null +++ b/modules/data_structures/help/ru_RU/rlist.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="rlist"> + <refnamediv> + <refname>rlist</refname> + <refpurpose> + определение функции рационального деления Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>rlist() + rlist(a1 ,..., an) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + <literal>rlist(a1, ..., an)</literal> - сокращённая запись для + <literal>tlist(['r','num';'den','dt'], a1, ..., an)</literal>. + </para> + <para> + <literal>rlist(a1, ..., an)</literal> создаёт <literal>tlist</literal> с <literal>['r','num';'den','dt']</literal> в качестве первого элемента и <literal>ai</literal>-тыми в качестве последующих элементов, если они есть. Над <literal>ai</literal>-тыми элементами не делается проверка ни типа ни размера. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +s=poly(0,'s'); +W=[1/s,1/(s+1)] +W'*W +Num=[s,s+2;1,s]; +Den=[s*s,s;s,s*s]; +rlist(Num,Den,[]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="rational">rational</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/setfield.xml b/modules/data_structures/help/ru_RU/setfield.xml new file mode 100755 index 000000000..86e2bf6c3 --- /dev/null +++ b/modules/data_structures/help/ru_RU/setfield.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="setfield"> + <refnamediv> + <refname>setfield</refname> + <refpurpose>внесение поля списка</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>setfield(i, x, l)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>матрица всевозможного типа.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para> + переменная типа <literal>list</literal>, <literal>tlist</literal> или <literal>mlist</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para> + индекс поля, см. справку по <link linkend="insertion">вставке</link>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Эта функция является эквивалентом синтаксиса <code>l(i)=x</code> + для вставки поля с той лишь разницей, что она также применима к объектам <literal>mlist</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +l=list(1,'qwerw',%s) +l(1)='Изменён' +l(0)='Добавлен' +l(6)=['ещё один';'добавлен'] + +a=hypermat([2,2,2],rand(1:2^3));// гиперматрицы кодируются с помощью mlist-ов +setfield(3,1:8,a);a // установка значения поля равным 1:8 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="insertion">вставка</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/struct.xml b/modules/data_structures/help/ru_RU/struct.xml new file mode 100755 index 000000000..8dc25680f --- /dev/null +++ b/modules/data_structures/help/ru_RU/struct.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="struct"> + <refnamediv> + <refname>struct</refname> + <refpurpose>создаёт структуру</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>st = struct(field1, value1, field2, value2, ...)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>field1, field2, ...</term> + <listitem> + <para>строки, представляющие имена полей.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value1, value2, ...</term> + <listitem> + <para> + все типы данных (<literal>double</literal>, <literal>char</literal>, <literal>int</literal>, ...), представляющие значения полей. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Эта функция возвращает структуру с именами полей + <varname>fields1</varname>, <varname>field2</varname>, ..., и значениями полей, соответственно, <varname>value1</varname>, <varname>value2</varname>, ... + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +//создадим структуру данных +date_st=struct('day',25,'month' ,'DEC','year',2006) + +//изменим месяц +date_st.month='AUG'; + +//изменим год +date_st.year=1973; + +//изменим день +date_st.day=19; + +//добавим новое поле +date_st.semaine=32 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="cell">cell</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/tlist.xml b/modules/data_structures/help/ru_RU/tlist.xml new file mode 100755 index 000000000..fff6205bd --- /dev/null +++ b/modules/data_structures/help/ru_RU/tlist.xml @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="tlist"> + <refnamediv> + <refname>tlist</refname> + <refpurpose>объект Scilab'а и определение типизированного списка</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>tlist(typ, a1, ..., an)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>typ</term> + <listitem> + <para> + символьная строка или вектор символьных строк. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ai</term> + <listitem> + <para> + любой объект Scilab'а (<literal>matrix</literal>, <literal>list</literal>, + <literal>string</literal>, ...). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <literal>tlist(typ, a1, ..., an)</literal> создаёт типизированный список <literal>tlist</literal> с элементами <varname>ai</varname>. Аргумент <varname>typ</varname> определяет тип списка. Такой типизированный список позволяет пользователю определять новые операции, действующие над этими объектами через функции Scilab-а. Единственная разница между <literal>tlist</literal> и <literal>list</literal> состоит в значении типа (16 вместо 15). + </para> + <para> + <code>typ(1)</code> определяет тип списка (символьная строка, используемая для определения запрограммированных действий). + </para> + <para> + Если это определено, то <code>typ(i)</code> может дать <literal>(i+1)</literal>-тому элементу формальное имя. + </para> + <para> + Стандартные операции, определённые над списками <literal>list</literal> работают и типизированными списками <literal>tlist</literal>: + </para> + <para> + извлечение: + </para> + <para> + <literal>[x, y, z, ...]=l(v)</literal>, где <literal>v</literal> - вектор индексов; + <literal>[x, y, z]=l(:)</literal> извлекает все элементы. + </para> + <para> + вставка: + </para> + <para> + <literal>l(i)=a</literal> + </para> + <para> + удаление: + </para> + <para> + <code>l(i)=null()</code> удаляет <literal>i</literal>-тый + элемент типизированного списка <literal>l</literal>. + <note> + Заметьте, что семантика инструкции <code>l.x=null()</code> не определена, а определение может быть дано через механизм <link linkend="overloading">перегрузки</link>. + </note> + </para> + <para> + вывод на экран. + </para> + <para> + Более того, если <code>typ(2:n+1)</code> определены, то пользователь может обращаться к элементам по их именам. + </para> + <para> + Ниже приводятся примеры, где используются <literal>tlist</literal>. + </para> + <para> + Линейные системы представляются особыми типизированными списками, например, линейная система <literal>[A,B,C,D]</literal> представляется типизированным списком <code>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</code> + и этот особый список можно создать с помощью функции <function>syslin</function>. + </para> + <para> + <code>Sys(2)</code>, <code>Sys('A')</code> или <code>Sys.A</code> является матрицей состояний, а <code>Sys('dt')</code> или <code>Sys.dt</code> является временн<emphasis role="bold" >о</emphasis>й областью. + </para> + <para> + Матрица рациональных значений <literal>H</literal> представляется типизированным списком + <code>H=rlist(Num,Den,[])</code>, где <literal>Num</literal> и <literal>Den</literal> являются матрицами полиномов, а линейная система непрерывного времени с передаточной матрицей <literal>H</literal> может быть создана с помощью <code>syslin('c',H)</code>. + </para> + <para> + <code>H(2)</code>, <code>H('num')</code> или <code>H.num</code> является числителем передаточной матрицы. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// tlist creation +t = tlist(["listtype","field1","field2"], [], []); +t.field1(1) = 10; +t.field1(2) = 20; +t.field2(1) = "Scilab"; +t.field2(2) = "tlist"; +t.field2(3) = "пример"; + +// Отображение содержимого полей +disp(t.field1) +disp(t.field2) + +// Общее отображение типизированного списка +disp(t) + +// Перегрузка отображения для этого типа типизированного списка +function %listtype_p(mytlist) + f = fieldnames(mytlist); + + // typeof(mytlist) <=> f(1) + mprintf("Отображение типизированного списка типа: %s\n", typeof(mytlist)); + + mprintf("\n"); + + mprintf("-- Поле ''%s'' --\n", f(1)); + mprintf("Содержимое: %s\n", sci2exp(mytlist(f(1)))); + + mprintf("\n"); + + mprintf("-- Поле ''%s'' --\n", f(2)); + mprintf("Содержимое: %s\n", sci2exp(mytlist(f(2)))); +endfunction + +// Отображение с помощью функции перегрузки +disp(t) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="percent">процент</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/type.xml b/modules/data_structures/help/ru_RU/type.xml new file mode 100755 index 000000000..234431f02 --- /dev/null +++ b/modules/data_structures/help/ru_RU/type.xml @@ -0,0 +1,241 @@ +<?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="type"> + <refnamediv> + <refname>type</refname> + <refpurpose>возвращает тип переменной</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[i]=type(x)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>объект Scilab'а.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>целое число.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>type(x)</code> возвращает целое число, которое равно типу <varname>x</varname>: + </para> + <variablelist> + <varlistentry> + <term>1</term> + <listitem> + <para>матрица вещественных или комплексных значений удвоенной точности (double).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + матрица <link linkend="poly">полиномов</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + матрица <link linkend="matrices">логических</link> значений. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>5</term> + <listitem> + <para> + <link linkend="sparse">разрежённая</link> матрица. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>6</term> + <listitem> + <para> + <link linkend="sparse">разрежённая</link> матрица логических значений. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para>разрежённая матрица Matlab'а.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>8</term> + <listitem> + <para> + матрица <link linkend="int8">целочисленных</link> значений, хранимых в 1 (<literal>int8</literal>), 2 (<literal>int16</literal>) или 4 (<literal>int32</literal>) байтах. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>9</term> + <listitem> + <para> + матрица <link linkend="graphics_entities">графических дескрипторов</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>10</term> + <listitem> + <para> + матрица <link linkend="strings">символьных строк</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>11</term> + <listitem> + <para> + некомпилированная функция (Scilab-код). Функция, созданная с помощью <link linkend="deff">deff</link> с аргументом <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>13</term> + <listitem> + <para> + компилированная <link linkend="function">функция</link> (Scilab code). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>14</term> + <listitem> + <para> + <link linkend="library">библиотека</link> функций. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>15</term> + <listitem> + <para> + список (<link linkend="list">list</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>16</term> + <listitem> + <para> + типизированный список (<link linkend="tlist">tlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>17</term> + <listitem> + <para> + матричноориентированный типизированный список (<link linkend="mlist">mlist</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>128</term> + <listitem> + <para> + указатель (используется в <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>129</term> + <listitem> + <para> + размер неявного многочлена, используемый для индексации. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>130</term> + <listitem> + <para> + встроенная функция Scilab'а, называемая также <emphasis role="italic">шлюзом</emphasis> (код C, C++ или Fortran). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>0</term> + <listitem> + <para> + нуль-переменная. Она главным образом используется внутри Scilab'а. Если функция не имеет объявленных возвращаемых аргументов, как например <function>disp</function>, то, когда она вызывается, она возвращает нуль-переменную. Если функция вызвана с опущенным аргументом в списке аргументов, как например <code>foo(a,,b)</code>, то пропущенный аргумент назначается нуль-переменной. + </para> + <para> + <note> + Заметьте, что, если нуль-переменная назначается имени, то оно удаляется. + <code>x=disp(1)</code> удаляет <varname>x</varname>. + </note> + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <note> + Пожалуйста, заметьте, что для некоторых переменных <function>type</function> вернёт <literal>tlist</literal> + или <literal>mlist</literal> в зависимости от внутренней структуры данных. Это так же для случая матрицы с + <emphasis role="italic">рациональными</emphasis> значениями, матрицы с элементами <emphasis role="italic">пространства состояний</emphasis>, <emphasis role="italic">гиперматрицы</emphasis> и <emphasis role="italic">структуры</emphasis>. Пожалуйста, используйте вместо этого <link linkend="typeof">typeof</link>. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +a=42; +type(a) + +b=%t; +type(b) + +c="foo" +type(c) + +d=sparse([1,2;4,5;3,10],[1,2,3]); +type(d) + +e = tlist(["listtype","field1","field2"], [], []); +type(e) + +f=poly(0,"s"); +type(f) + +g=int8([1 -120 127 312]); +type(g) + +h=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); +type(h) + +l = list(1,["a" "b"]); +type(l) + +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="inttype">inttype</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/typename.xml b/modules/data_structures/help/ru_RU/typename.xml new file mode 100755 index 000000000..be4394fbd --- /dev/null +++ b/modules/data_structures/help/ru_RU/typename.xml @@ -0,0 +1,90 @@ +<?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="typename"> + <refnamediv> + <refname>typename</refname> + <refpurpose>связывает имя и тип переменной</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[types [ [,names]]=typename() + typename(name, type) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>types</term> + <listitem> + <para>вектор-столбец целочисленных значений: коды типов каждого из определённых типов данных.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>names</term> + <listitem> + <para>вектор-столбец строк: имена, связанные с кодами типов.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para>целое число: код типа нового типа данных.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>строковое значение: имя, связанное с кодом типа.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Перегрузка функции и оператора позволяет использовать формальное имя, связанное с типами данных для того, чтобы формировать имя функции перегрузки (см. <link linkend="overloading">перегрузку</link>). Функция <function>typename</function> может быть использована для управления этими формальными именами для жёстко запрограммированных типов данных (типы данных, запрограммированных с помощью <literal>tlist</literal> или <literal>mlist</literal>, определяются по-другому, см. <link linkend="overloading">перегрузку</link>). + </para> + <para> + В случае вызова без аргументов с правой стороны, функция <function>typename</function> вернёт информацию по определённым типам данных. + </para> + <para> + В случае вызова с аргументами с правой стороны, функция <function>typename</function> свяжет имя и код типа данных. + </para> + <para> + <code>typename('',type)</code> удаляет тип данных, указанный по его коду <varname>type</varname> из таблицы известных типов данных. + </para> + <para>Максимальное число определённых типов 50.</para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[typs,nams]=typename(); +disp("Первый тип (double) : " + string(typs(1)) + " / " + nams(1)); +typename("mytype",1024); +[typs,nams]=typename(); +disp(typs($)) +disp(nams($)) // возвращает mytype +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="overloading">перегрузка</link> + </member> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="mlist">mlist</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/data_structures/help/ru_RU/typeof.xml b/modules/data_structures/help/ru_RU/typeof.xml new file mode 100755 index 000000000..9e1e0e732 --- /dev/null +++ b/modules/data_structures/help/ru_RU/typeof.xml @@ -0,0 +1,244 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="typeof" xml:lang="ru"> + <refnamediv> + <refname>typeof</refname> + <refpurpose>указывает тип объекта</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[t]=typeof(object)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>object</term> + <listitem> + <para>объект Scilab'а</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>строковое значение</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Инструкция <code>t = typeof(object)</code> возвращает одну из следующих строк: + </para> + <variablelist> + <varlistentry> + <term>"constant"</term> + <listitem> + <para> + если <varname>object</varname> - матрица вещественных или комплексных значений удвоенной точности. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"polynomial"</term> + <listitem> + <para> + если <varname>object</varname> матрица <link linkend="poly">полиномов</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"function"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="function">функция</link> (Scilab-код). См. также <link linkend="deff">deff</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"handle"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="graphics_entities">дескриптор</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"string"</term> + <listitem> + <para> + если <varname>object</varname> - матрица, составленная из <link linkend="strings">символьных строк</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="matrices">матрица</link> логических значений. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"list"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="list">список</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"rational"</term> + <listitem> + <para> + если <varname>object</varname> - матрица <link linkend="rational">рациональных чисел</link> (передаточная матрица). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"state-space"</term> + <listitem> + <para> + если <varname>object</varname> - модель пространства состояний (см.<link linkend="syslin">syslin</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"sparse"</term> + <listitem> + <para> + если <varname>object</varname> - (вещественная) <link linkend="sparse">разрежённая матрица</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"boolean sparse"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="sparse">разрежённая матрица</link> логических значений. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"hypermat"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="hypermatrices">гиперматрица</link> (<literal>N</literal>-мерный массив <literal><![CDATA[N<=3]]></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"st"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="struct">структура</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"ce"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="cell">cell</link>-массив. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"fptr"</term> + <listitem> + <para> + если <varname>object</varname> - встроенная Scilab-функция, называемая также <emphasis role="italic">шлюзом</emphasis> (код C, C++ или Fortran). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"pointer"</term> + <listitem> + <para> + если <varname>object</varname> - указатель (см. <link linkend="lufact">lufact</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"size implicit"</term> + <listitem> + <para> + если <varname>object</varname> - размер неявного полинома, используемый для индексации. Это чисто внутреннее значение. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"library"</term> + <listitem> + <para> + если <varname>object</varname> - <link linkend="library">библиотека функций</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"int8" или "uint8" или "int16" или "uint16" или "int32" или "uint32"</term> + <listitem> + <para> + если <varname>object</varname> - матрица [беззнаковых] целых чисел, хранимых в 8, 16 или 32 битах. (См. <link linkend="int8">int</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <note> + Заметьте, что, если объект <varname>object</varname> является <link linkend="tlist">tlist</link> или <link linkend="mlist">mlist</link>, то <function>typeof</function> вернёт первое строковое значение в первом элементе списка. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +typeof(1) +typeof(poly(0,'x')) + +typeof(1/poly(0,'x')) +typeof(%t) + +w=sprand(100,100,0.001); +typeof(w) +typeof(w==w) + +deff('y=f(x)','y=2*x'); +typeof(f) + +L=tlist(['V','a','b'],18,'Scilab'); +typeof(L) + +typeof(corelib) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="strings">strings</link> + </member> + <member> + <link linkend="syslin">syslin</link> + </member> + <member> + <link linkend="poly">poly</link> + </member> + </simplelist> + </refsection> +</refentry> + |