summaryrefslogtreecommitdiffstats
path: root/scilab/modules/compatibility_functions
diff options
context:
space:
mode:
authorYann Collette <yann.collette@scilab.org>2009-07-28 13:40:13 +0200
committerYann Collette <yann.collette@scilab.org>2009-07-28 13:40:13 +0200
commit60e63925d29f7ef52b46b85d11f84e44cee6dc6d (patch)
treec68f03b8cd2c846512f0ad7806ce5dacda74d683 /scilab/modules/compatibility_functions
parentedd25cefa1980f71b667f4b3c85e8e5df01056ae (diff)
downloadscilab-60e63925d29f7ef52b46b85d11f84e44cee6dc6d.zip
scilab-60e63925d29f7ef52b46b85d11f84e44cee6dc6d.tar.gz
Revert "correct bug 4184 for compatibility_functions - uniformisation of the examples presentation"
This reverts commit f13b606e08b0905844d4215f7c2a54747d96c000.
Diffstat (limited to 'scilab/modules/compatibility_functions')
-rw-r--r--scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml45
-rw-r--r--scilab/modules/compatibility_functions/help/en_US/makecell.xml64
-rw-r--r--scilab/modules/compatibility_functions/help/en_US/mtlb_eval.xml113
-rw-r--r--scilab/modules/compatibility_functions/help/en_US/mtlb_var.xml113
-rw-r--r--scilab/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml49
5 files changed, 139 insertions, 245 deletions
diff --git a/scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml b/scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml
index 6252a0d..144d5b1 100644
--- a/scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml
+++ b/scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml
@@ -10,70 +10,48 @@
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 * 11 *
12 --> 12 -->
13<refentry version="5.0-subset Scilab" xml:id="firstnonsingleton" xml:lang="en" 13<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="firstnonsingleton">
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns4="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info> 14 <info>
21 <pubdate>$LastChangedDate$</pubdate> 15 <pubdate>$LastChangedDate$</pubdate>
22 </info> 16 </info>
23
24 <refnamediv> 17 <refnamediv>
25 <refname>firstnonsingleton</refname> 18 <refname>firstnonsingleton</refname>
26
27 <refpurpose>Finds first dimension which is not 1</refpurpose> 19 <refpurpose>Finds first dimension which is not 1</refpurpose>
28 </refnamediv> 20 </refnamediv>
29
30 <refsynopsisdiv> 21 <refsynopsisdiv>
31 <title>Calling Sequence</title> 22 <title>Calling Sequence</title>
32
33 <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis> 23 <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis>
34 </refsynopsisdiv> 24 </refsynopsisdiv>
35
36 <refsection> 25 <refsection>
37 <title>Parameters</title> 26 <title>Parameters</title>
38
39 <variablelist> 27 <variablelist>
40 <varlistentry> 28 <varlistentry>
41 <term>dim</term> 29 <term>dim</term>
42
43 <listitem> 30 <listitem>
44 <para>first dimension of A which is not 1</para> 31 <para>first dimension of A which is not 1</para>
45 </listitem> 32 </listitem>
46 </varlistentry> 33 </varlistentry>
47
48 <varlistentry> 34 <varlistentry>
49 <term>A</term> 35 <term>A</term>
50
51 <listitem> 36 <listitem>
52 <para>a variable of any Scilab data type</para> 37 <para>a variable of any Scilab data type</para>
53 </listitem> 38 </listitem>
54 </varlistentry> 39 </varlistentry>
55
56 <varlistentry> 40 <varlistentry>
57 <term>opt</term> 41 <term>opt</term>
58
59 <listitem> 42 <listitem>
60 <para>a character string giving the type of output we want</para> 43 <para>a character string giving the type of output we want</para>
61
62 <variablelist> 44 <variablelist>
63 <varlistentry> 45 <varlistentry>
64 <term>"num"</term> 46 <term>"num"</term>
65
66 <listitem> 47 <listitem>
67 <para>returned value is a numerical value</para> 48 <para>returned value is a numerical value</para>
68 </listitem> 49 </listitem>
69 </varlistentry> 50 </varlistentry>
70
71 <varlistentry> 51 <varlistentry>
72 <term>"str"</term> 52 <term>"str"</term>
73
74 <listitem> 53 <listitem>
75 <para>returned value is a character string if possible ("r" 54 <para>returned value is a character string if possible ("r" instead of 1 and "c" instead of 2)</para>
76 instead of 1 and "c" instead of 2)</para>
77 </listitem> 55 </listitem>
78 </varlistentry> 56 </varlistentry>
79 </variablelist> 57 </variablelist>
@@ -81,31 +59,28 @@
81 </varlistentry> 59 </varlistentry>
82 </variablelist> 60 </variablelist>
83 </refsection> 61 </refsection>
84
85 <refsection> 62 <refsection>
86 <title>Description</title> 63 <title>Description</title>
87 64 <para>
88 <para>This function is used by <literal>mfile2sci</literal> to emulate 65 This function is used by <literal>mfile2sci</literal> to emulate Matlab behavior under Scilab, particularly
89 Matlab behavior under Scilab, particularly for functions which treat the 66 for functions which treat the values along the first non-singleton dimension of A in Matlab
90 values along the first non-singleton dimension of A in Matlab while in 67 while in Scilab they treat all values of A.
91 Scilab they treat all values of A.</para> 68 </para>
92 </refsection> 69 </refsection>
93
94 <refsection> 70 <refsection>
95 <title>Examples</title> 71 <title>Examples</title>
72 <programlisting role="example"><![CDATA[
96 73
97 <programlisting role="example">
98A = [1 2 3;4 5 6]; 74A = [1 2 3;4 5 6];
99// Scilab max 75// Scilab max
100M = max(A) 76M = max(A)
101// Matlab max emulation 77// Matlab max emulation
102M = max(A,firstnonsingleton(A)) 78M = max(A,firstnonsingleton(A))
103 </programlisting> 79
80 ]]></programlisting>
104 </refsection> 81 </refsection>
105
106 <refsection> 82 <refsection>
107 <title>Authors</title> 83 <title>Authors</title>
108
109 <simplelist type="vert"> 84 <simplelist type="vert">
110 <member>V.C.</member> 85 <member>V.C.</member>
111 </simplelist> 86 </simplelist>
diff --git a/scilab/modules/compatibility_functions/help/en_US/makecell.xml b/scilab/modules/compatibility_functions/help/en_US/makecell.xml
index e8391b4..6276ef2 100644
--- a/scilab/modules/compatibility_functions/help/en_US/makecell.xml
+++ b/scilab/modules/compatibility_functions/help/en_US/makecell.xml
@@ -10,91 +10,75 @@
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 * 11 *
12--> 12-->
13<refentry version="5.0-subset Scilab" xml:id="makecell" xml:lang="fr" 13<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="fr" xml:id="makecell">
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns4="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info> 14 <info>
21 <pubdate>$LastChangedDate: 18-04-2008 $</pubdate> 15 <pubdate>$LastChangedDate: 18-04-2008 $</pubdate>
22 </info> 16 </info>
23
24 <refnamediv> 17 <refnamediv>
25 <refname>makecell</refname> 18 <refname>makecell</refname>
26 19 <refpurpose>Creates a cell array. </refpurpose>
27 <refpurpose>Creates a cell array.</refpurpose>
28 </refnamediv> 20 </refnamediv>
29
30 <refsynopsisdiv> 21 <refsynopsisdiv>
31 <title>Calling Sequence</title> 22 <title>Calling Sequence</title>
32
33 <synopsis>s = makecell(dims,a1,a2,...an)</synopsis> 23 <synopsis>s = makecell(dims,a1,a2,...an)</synopsis>
34 </refsynopsisdiv> 24 </refsynopsisdiv>
35
36 <refsection> 25 <refsection>
37 <title>Parameters</title> 26 <title>Parameters</title>
38
39 <variablelist> 27 <variablelist>
40 <varlistentry> 28 <varlistentry>
41 <term>dims</term> 29 <term>dims</term>
42
43 <listitem> 30 <listitem>
44 <para>a vector with positive integer elements, the cell array 31 <para>
45 dimension</para> 32 a vector with positive integer elements, the cell array dimension
33 </para>
46 </listitem> 34 </listitem>
47 </varlistentry> 35 </varlistentry>
48
49 <varlistentry> 36 <varlistentry>
50 <term>a1,a2,...,an</term> 37 <term>a1,a2,...,an</term>
51
52 <listitem> 38 <listitem>
53 <para>Sequence of Scilab variables, <literal>n</literal> must be 39 <para>
54 equal to <literal>prod(dims)</literal></para> 40 Sequence of Scilab variables, <literal>n</literal> must be equal to <literal>prod(dims)</literal>
41 </para>
55 </listitem> 42 </listitem>
56 </varlistentry> 43 </varlistentry>
57
58 <varlistentry> 44 <varlistentry>
59 <term>s</term> 45 <term>s</term>
60
61 <listitem> 46 <listitem>
62 <para>resulting cell array</para> 47 <para>
48 resulting cell array
49 </para>
63 </listitem> 50 </listitem>
64 </varlistentry> 51 </varlistentry>
65 </variablelist> 52 </variablelist>
66 </refsection> 53 </refsection>
67
68 <refsection> 54 <refsection>
69 <title>Description</title> 55 <title>Description</title>
70 56 <para>
71 <para><literal>s = makecell(dims,a1,a2,...an)</literal> creates a cell 57 <literal>s = makecell(dims,a1,a2,...an)</literal> creates a cell
72 array of dimensions given by <literal>dims</literal> with the given input 58 array of dimensions given by <literal>dims</literal> with the
73 arguments. The <literal>ai</literal> are stored along the last dimension 59 given input arguments. The <literal>ai</literal> are stored
74 first.</para> 60 along the last dimension first.
61 </para>
75 </refsection> 62 </refsection>
76
77 <refsection> 63 <refsection>
78 <title>Examples</title> 64 <title>Examples</title>
79 65 <programlisting role="example"><![CDATA[
80 <programlisting role="example"> 66 makecell([2,3],1,2,3,'x','y','z')
81makecell([2,3],1,2,3,'x','y','z') 67 ]]></programlisting>
82 </programlisting>
83 </refsection> 68 </refsection>
84
85 <refsection> 69 <refsection>
86 <title>See Also</title> 70 <title>See Also</title>
87
88 <simplelist type="inline"> 71 <simplelist type="inline">
89 <member><link linkend="cell">cell</link></member> 72 <member>
73 <link linkend="cell" >cell</link>
74 </member>
90 </simplelist> 75 </simplelist>
91 </refsection> 76 </refsection>
92
93 <refsection> 77 <refsection>
94 <title>Authors</title> 78 <title>Authors</title>
95
96 <simplelist type="vert"> 79 <simplelist type="vert">
97 <member>Farid Belhacen, INRIA</member> 80 <member>Farid Belhacen, INRIA</member>
98 </simplelist> 81 </simplelist>
99 </refsection> 82 </refsection>
83
100</refentry> 84</refentry>
diff --git a/scilab/modules/compatibility_functions/help/en_US/mtlb_eval.xml b/scilab/modules/compatibility_functions/help/en_US/mtlb_eval.xml
index 2e2623c..321c433 100644
--- a/scilab/modules/compatibility_functions/help/en_US/mtlb_eval.xml
+++ b/scilab/modules/compatibility_functions/help/en_US/mtlb_eval.xml
@@ -10,100 +10,87 @@
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 * 11 *
12 --> 12 -->
13<refentry version="5.0-subset Scilab" xml:id="mtlb_eval" xml:lang="en" 13<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mtlb_eval">
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns4="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info> 14 <info>
21 <pubdate>$LastChangedDate$</pubdate> 15 <pubdate>$LastChangedDate$</pubdate>
22 </info> 16 </info>
23
24 <refnamediv> 17 <refnamediv>
25 <refname>mtlb_eval</refname> 18 <refname>mtlb_eval</refname>
26
27 <refpurpose>Matlab eval emulation function</refpurpose> 19 <refpurpose>Matlab eval emulation function</refpurpose>
28 </refnamediv> 20 </refnamediv>
29
30 <refsection> 21 <refsection>
31 <title>Description</title> 22 <title>Description</title>
32 23 <para>Scilab equivalent for Matlab <literal>eval</literal> is different according to its inputs and outputs</para>
33 <para>Scilab equivalent for Matlab <literal>eval</literal> is different 24 <para>
34 according to its inputs and outputs</para> 25 The function <literal>mtlb_eval(str1,str2)</literal> is used by
35 26 <literal>mfile2sci</literal> to replace <literal>eval</literal> because it was not possible to know
36 <para>The function <literal>mtlb_eval(str1,str2)</literal> is used by 27 what were the inputs while porting Matlab code to Scilab. This function will
37 <literal>mfile2sci</literal> to replace <literal>eval</literal> because it 28 determine the correct semantic at run time. If you want to have a
38 was not possible to know what were the inputs while porting Matlab code to 29 more efficient code it is possible to replace <literal>mtlb_eval</literal> calls:
39 Scilab. This function will determine the correct semantic at run time. If 30 </para>
40 you want to have a more efficient code it is possible to replace
41 <literal>mtlb_eval</literal> calls:</para>
42
43 <itemizedlist> 31 <itemizedlist>
44 <listitem> 32 <listitem>
45 <para>When called with one input and no output, 33 <para>
46 <literal>mtlb_eval(str1)</literal> may be replaced by 34 When called with one input and no output,
47 <literal>evstr(str1)</literal> if <literal>str1</literal> is a valid 35 <literal>mtlb_eval(str1)</literal> may be replaced by <literal>evstr(str1)</literal>
48 Scilab expression or by <literal>execstr(str1)</literal> if 36 if <literal>str1</literal> is a valid Scilab expression
49 <literal>str1</literal> is a valid Scilab instruction.</para> 37 or by <literal>execstr(str1)</literal>
38 if <literal>str1</literal> is a valid Scilab instruction.
39 </para>
50 </listitem> 40 </listitem>
51
52 <listitem> 41 <listitem>
53 <para>When called with one input and one output, 42 <para>
54 <literal>val=mtlb_eval(str1)</literal> may be replaced by 43 When called with one input and one output,
55 <literal>val=evstr(str1)</literal> if <literal>str1</literal> is a 44 <literal>val=mtlb_eval(str1)</literal> may be replaced by <literal>val=evstr(str1)</literal>
56 valid Scilab instruction.</para> 45 if <literal>str1</literal> is a valid Scilab instruction.
46 </para>
57 </listitem> 47 </listitem>
58
59 <listitem> 48 <listitem>
60 <para>When called with two inputs and no output, 49 <para>
50 When called with two inputs and no output,
61 <literal>mtlb_eval(str1,str2)</literal> may be replaced by: 51 <literal>mtlb_eval(str1,str2)</literal> may be replaced by:
62 <literal>if execstr(str1,"errcatch")&lt;&gt;0 then 52 <literal>if execstr(str1,"errcatch")&lt;&gt;0 then execstr(str2);end</literal>
63 execstr(str2);end</literal> if <literal>str1</literal> and 53 if <literal>str1</literal> and <literal>str2</literal> are valid Scilab instructions.
64 <literal>str2</literal> are valid Scilab instructions.</para> 54 </para>
65 </listitem> 55 </listitem>
66
67 <listitem> 56 <listitem>
68 <para>When called with more than one output and one input, 57 <para>
58 When called with more than one output and one input,
69 <literal>[val1,val2,...]=mtlb_eval(str1)</literal> may be replaced by 59 <literal>[val1,val2,...]=mtlb_eval(str1)</literal> may be replaced by
70 <literal>execstr("[val1,val2,...]"+str1)</literal> if 60 <literal>execstr("[val1,val2,...]"+str1)</literal>
71 <literal>str1</literal> is a valid Scilab instruction.</para> 61 if <literal>str1</literal> is a valid Scilab instruction.
62 </para>
72 </listitem> 63 </listitem>
73
74 <listitem> 64 <listitem>
75 <para>When called with two inputs and more than one output, 65 <para>
76 <literal>[val1,val2,...]=mtlb_eval(str1,str2)</literal> may be 66 When called with two inputs and more than one output,
77 replaced by:</para> 67 <literal>[val1,val2,...]=mtlb_eval(str1,str2)</literal> may be replaced by:
78 68 </para>
79 <programlisting> 69 <programlisting><![CDATA[
80if execstr("[val1,val2,...]"+str1,"errcatch")&lt;&gt;0 then 70 if execstr("[val1,val2,...]"+str1,"errcatch")<>0 then
81 execstr("[val1,val2,...]"+str2); 71 execstr("[val1,val2,...]"+str2);
82end 72 end
83 </programlisting> 73 ]]></programlisting>
84 74 <para>
85 <para>if <literal>str1</literal> and <literal>str2</literal> are valid 75 if <literal>str1</literal> and <literal>str2</literal> are valid Scilab instructions.
86 Scilab instructions.</para> 76 </para>
87 </listitem> 77 </listitem>
88 </itemizedlist> 78 </itemizedlist>
89 79 <para>Caution: <literal>mtlb_eval</literal> has not to be used for hand coded functions.</para>
90 <para>Caution: <literal>mtlb_eval</literal> has not to be used for hand
91 coded functions.</para>
92 </refsection> 80 </refsection>
93
94 <refsection> 81 <refsection>
95 <title>See Also</title> 82 <title>See Also</title>
96
97 <simplelist type="inline"> 83 <simplelist type="inline">
98 <member><link linkend="evstr">evstr</link></member> 84 <member>
99 85 <link linkend="evstr">evstr</link>
100 <member><link linkend="execstr">execstr</link></member> 86 </member>
87 <member>
88 <link linkend="execstr">execstr</link>
89 </member>
101 </simplelist> 90 </simplelist>
102 </refsection> 91 </refsection>
103
104 <refsection> 92 <refsection>
105 <title>Authors</title> 93 <title>Authors</title>
106
107 <simplelist type="vert"> 94 <simplelist type="vert">
108 <member>V.C.</member> 95 <member>V.C.</member>
109 </simplelist> 96 </simplelist>
diff --git a/scilab/modules/compatibility_functions/help/en_US/mtlb_var.xml b/scilab/modules/compatibility_functions/help/en_US/mtlb_var.xml
index 8fafa5c..80384c4 100644
--- a/scilab/modules/compatibility_functions/help/en_US/mtlb_var.xml
+++ b/scilab/modules/compatibility_functions/help/en_US/mtlb_var.xml
@@ -10,122 +10,98 @@
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 * 11 *
12 --> 12 -->
13<refentry version="5.0-subset Scilab" xml:id="mtlb_var" xml:lang="en" 13<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mtlb_var">
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns4="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info> 14 <info>
21 <pubdate>$LastChangedDate$</pubdate> 15 <pubdate>$LastChangedDate$</pubdate>
22 </info> 16 </info>
23
24 <refnamediv> 17 <refnamediv>
25 <refname>mtlb_var</refname> 18 <refname>mtlb_var</refname>
26
27 <refpurpose>Matlab var emulation function</refpurpose> 19 <refpurpose>Matlab var emulation function</refpurpose>
28 </refnamediv> 20 </refnamediv>
29
30 <refsection> 21 <refsection>
31 <title>Parameters</title> 22 <title>Parameters</title>
32
33 <variablelist> 23 <variablelist>
24
34 <varlistentry> 25 <varlistentry>
35 <term>x</term> 26 <term>x</term>
36
37 <listitem> 27 <listitem>
38 <para>a real or a complex vector or matrix.</para> 28 <para>a real or a complex vector or matrix.</para>
39 </listitem> 29 </listitem>
40 </varlistentry> 30 </varlistentry>
41 31
42 <varlistentry> 32 <varlistentry>
43 <term>s</term> 33 <term>s</term>
44
45 <listitem> 34 <listitem>
46 <para>a real scalar or real vector.</para> 35 <para>a real scalar or real vector.</para>
47
48 <itemizedlist> 36 <itemizedlist>
49 <listitem> 37 <listitem>
50 <para>If x is a vector, s is the variance of x.</para> 38 <para>If x is a vector, s is the variance of x.</para>
51 </listitem> 39 </listitem>
52
53 <listitem> 40 <listitem>
54 <para>If x is a matrix, s is a row vector containing the 41 <para>If x is a matrix, s is a row vector containing the variance of each column of x.</para>
55 variance of each column of x.</para>
56 </listitem> 42 </listitem>
57 </itemizedlist> 43 </itemizedlist>
44
58 </listitem> 45 </listitem>
59 </varlistentry> 46 </varlistentry>
60 47
61 <varlistentry> 48 <varlistentry>
62 <term>w</term> 49 <term>w</term>
63
64 <listitem> 50 <listitem>
65 <para>type of normalization to use. Valid values are, depending on 51 <para>type of normalization to use. Valid values are, depending on the number of columns m of x :</para>
66 the number of columns m of x :</para>
67
68 <itemizedlist> 52 <itemizedlist>
69 <listitem> 53 <listitem>
70 <para>w = 0 : normalizes with m-1, provides the best unbiased 54 <para>w = 0 : normalizes with m-1, provides the best unbiased estimator of the variance (this is the default).</para>
71 estimator of the variance (this is the default).</para>
72 </listitem> 55 </listitem>
73
74 <listitem> 56 <listitem>
75 <para>w = 1: normalizes with m, this provides the second moment 57 <para>w = 1: normalizes with m, this provides the second moment around the mean. </para>
76 around the mean.</para>
77 </listitem> 58 </listitem>
78 </itemizedlist> 59 </itemizedlist>
60
79 </listitem> 61 </listitem>
80 </varlistentry> 62 </varlistentry>
81 63
82 <varlistentry> 64 <varlistentry>
83 <term>dim</term> 65 <term>dim</term>
84
85 <listitem> 66 <listitem>
86 <para>the dimension along which the variance is computed (default is 67 <para>the dimension along which the variance is computed (default is 1, i.e. column by column).
87 1, i.e. column by column). If dim is 2, the variance is computed row 68 If dim is 2, the variance is computed row by row.</para>
88 by row.</para>
89 </listitem> 69 </listitem>
90 </varlistentry> 70 </varlistentry>
71
91 </variablelist> 72 </variablelist>
92 </refsection> 73 </refsection>
93
94 <refsection> 74 <refsection>
95 <title>Description</title> 75 <title>Description</title>
96 76 <para>This function computes the variance of the values of a vector or matrix x.
97 <para>This function computes the variance of the values of a vector or 77It provides the same service as Octave and Matlab.
98 matrix x. It provides the same service as Octave and Matlab. It differs 78It differs from Scilab's variance primitive: </para>
99 from Scilab's variance primitive:</para> 79 <itemizedlist>
100 80 <listitem>
101 <itemizedlist> 81 <para>mtlb_var returns a real (i.e. with a zero imaginary part) variance,
102 <listitem> 82 even if x is a complex vector or matrix. The Scilab variance
103 <para>mtlb_var returns a real (i.e. with a zero imaginary part) 83 primitive returns a complex value if the input vector x is complex and
104 variance, even if x is a complex vector or matrix. The Scilab variance 84 if no option additionnal is used.
105 primitive returns a complex value if the input vector x is complex and 85 </para>
106 if no option additionnal is used.</para> 86 </listitem>
107 </listitem> 87 <listitem>
108 88 <para>Whatever the type of the input data x (i.e. vector or matrix),
109 <listitem> 89 mtlb_var computes the variance either on dimension 1 or on dimension 2 while,
110 <para>Whatever the type of the input data x (i.e. vector or matrix), 90 if no option is passed to the Scilab's variance primitive, the variance is computed
111 mtlb_var computes the variance either on dimension 1 or on dimension 2 91 on all dimension at once.</para>
112 while, if no option is passed to the Scilab's variance primitive, the 92 </listitem>
113 variance is computed on all dimension at once.</para> 93 </itemizedlist>
114 </listitem>
115 </itemizedlist>
116 </refsection> 94 </refsection>
117
118 <refsection> 95 <refsection>
119 <title>Examples</title> 96 <title>Examples</title>
97<para>The following 3 examples illustrates the use of the mtlb_var function.
98In the first case, a column vector is passed to the function, which returns the value 750.
99In the second case, a matrix is passed to the function, which returns the row vector
100[0.16 0.09].
101In the third case, a complex column vector is passed to the function, which
102returns a value close to 2.</para>
103<programlisting role="example"><![CDATA[
120 104
121 <para>The following 3 examples illustrates the use of the mtlb_var
122 function. In the first case, a column vector is passed to the function,
123 which returns the value 750. In the second case, a matrix is passed to the
124 function, which returns the row vector [0.16 0.09]. In the third case, a
125 complex column vector is passed to the function, which returns a value
126 close to 2.</para>
127
128 <programlisting role="example">
129x = [10; 20; 30; 40; 50; 60; 70; 80; 90]; 105x = [10; 20; 30; 40; 50; 60; 70; 80; 90];
130computed = mtlb_var(x); 106computed = mtlb_var(x);
131 107
@@ -137,20 +113,19 @@ computed = mtlb_var(x);
137N=1000; 113N=1000;
138x = grand(N,1,'nor',0,1) + %i*grand(N,1,'nor',0,1); 114x = grand(N,1,'nor',0,1) + %i*grand(N,1,'nor',0,1);
139computed = mtlb_var(x); 115computed = mtlb_var(x);
140 </programlisting>
141 </refsection>
142 116
117 ]]></programlisting>
118 </refsection>
143 <refsection> 119 <refsection>
144 <title>See Also</title> 120 <title>See Also</title>
145
146 <simplelist type="inline"> 121 <simplelist type="inline">
147 <member><link linkend="variance">variance</link></member> 122 <member>
123 <link linkend="variance">variance</link>
124 </member>
148 </simplelist> 125 </simplelist>
149 </refsection> 126 </refsection>
150
151 <refsection> 127 <refsection>
152 <title>Authors</title> 128 <title>Authors</title>
153
154 <simplelist type="vert"> 129 <simplelist type="vert">
155 <member>Michael Baudin</member> 130 <member>Michael Baudin</member>
156 </simplelist> 131 </simplelist>
diff --git a/scilab/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml b/scilab/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml
index bc57844..78f552a 100644
--- a/scilab/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml
+++ b/scilab/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml
@@ -10,71 +10,48 @@
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 * 11 *
12 --> 12 -->
13<refentry version="5.0-subset Scilab" xml:id="firstnonsingleton" xml:lang="fr" 13<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="fr" xml:id="firstnonsingleton">
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns4="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info> 14 <info>
21 <pubdate>$LastChangedDate$</pubdate> 15 <pubdate>$LastChangedDate$</pubdate>
22 </info> 16 </info>
23
24 <refnamediv> 17 <refnamediv>
25 <refname>firstnonsingleton</refname> 18 <refname>firstnonsingleton</refname>
26
27 <refpurpose>Trouve la première dimension qui n'est pas 1</refpurpose> 19 <refpurpose>Trouve la première dimension qui n'est pas 1</refpurpose>
28 </refnamediv> 20 </refnamediv>
29
30 <refsynopsisdiv> 21 <refsynopsisdiv>
31 <title>Séquence d'appel</title> 22 <title>Séquence d'appel</title>
32
33 <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis> 23 <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis>
34 </refsynopsisdiv> 24 </refsynopsisdiv>
35
36 <refsection> 25 <refsection>
37 <title>Paramètres</title> 26 <title>Paramètres</title>
38
39 <variablelist> 27 <variablelist>
40 <varlistentry> 28 <varlistentry>
41 <term>dim</term> 29 <term>dim</term>
42
43 <listitem> 30 <listitem>
44 <para>première dimension de A qui n'est pas 1</para> 31 <para>première dimension de A qui n'est pas 1</para>
45 </listitem> 32 </listitem>
46 </varlistentry> 33 </varlistentry>
47
48 <varlistentry> 34 <varlistentry>
49 <term>A</term> 35 <term>A</term>
50
51 <listitem> 36 <listitem>
52 <para>une variable de n'importe quel type de donnée Scilab</para> 37 <para>une variable de n'importe quel type de donnée Scilab</para>
53 </listitem> 38 </listitem>
54 </varlistentry> 39 </varlistentry>
55
56 <varlistentry> 40 <varlistentry>
57 <term>opt</term> 41 <term>opt</term>
58
59 <listitem> 42 <listitem>
60 <para>une chaîne de caractères qui précise le type de la variable de 43 <para>une chaîne de caractères qui précise le type de la variable de sortie que l'on veut</para>
61 sortie que l'on veut</para>
62
63 <variablelist> 44 <variablelist>
64 <varlistentry> 45 <varlistentry>
65 <term>"num"</term> 46 <term>"num"</term>
66
67 <listitem> 47 <listitem>
68 <para>la valeur retournée est une valeur numérique</para> 48 <para>la valeur retournée est une valeur numérique</para>
69 </listitem> 49 </listitem>
70 </varlistentry> 50 </varlistentry>
71
72 <varlistentry> 51 <varlistentry>
73 <term>"str"</term> 52 <term>"str"</term>
74
75 <listitem> 53 <listitem>
76 <para>la valeur retournée est une chaîne de caractères si 54 <para>la valeur retournée est une chaîne de caractères si possible ("r" au lieu de 1 et "c" au lieu de 2)</para>
77 possible ("r" au lieu de 1 et "c" au lieu de 2)</para>
78 </listitem> 55 </listitem>
79 </varlistentry> 56 </varlistentry>
80 </variablelist> 57 </variablelist>
@@ -82,32 +59,28 @@
82 </varlistentry> 59 </varlistentry>
83 </variablelist> 60 </variablelist>
84 </refsection> 61 </refsection>
85
86 <refsection> 62 <refsection>
87 <title>Description</title> 63 <title>Description</title>
88 64 <para>
89 <para>Cette fonction est utilisée par <literal>mfile2sci</literal> pour 65 Cette fonction est utilisée par <literal>mfile2sci</literal> pour émuler le comportement de Matlab sous Scilab,
90 émuler le comportement de Matlab sous Scilab, en particulier pour les 66 en particulier pour les fonctions qui traitent les valeurs suivant la première dimension de A qui n'est pas 1
91 fonctions qui traitent les valeurs suivant la première dimension de A qui 67 en Matlab alors que dans Scilab elles traitent toutes les valeurs de A.
92 n'est pas 1 en Matlab alors que dans Scilab elles traitent toutes les 68 </para>
93 valeurs de A.</para>
94 </refsection> 69 </refsection>
95
96 <refsection> 70 <refsection>
97 <title>Exemples</title> 71 <title>Exemples</title>
72 <programlisting role="example"><![CDATA[
98 73
99 <programlisting role="example">
100A = [1 2 3;4 5 6]; 74A = [1 2 3;4 5 6];
101// max Scilab 75// max Scilab
102M = max(A) 76M = max(A)
103// Emulation du max Matlab 77// Emulation du max Matlab
104M = max(A,firstnonsingleton(A)) 78M = max(A,firstnonsingleton(A))
105 </programlisting> 79
80 ]]></programlisting>
106 </refsection> 81 </refsection>
107
108 <refsection> 82 <refsection>
109 <title>Auteurs</title> 83 <title>Auteurs</title>
110
111 <simplelist type="vert"> 84 <simplelist type="vert">
112 <member>V.C.</member> 85 <member>V.C.</member>
113 </simplelist> 86 </simplelist>