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/compatibility_functions/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/compatibility_functions/help')
185 files changed, 12250 insertions, 0 deletions
diff --git a/modules/compatibility_functions/help/en_US/addchapter.sce b/modules/compatibility_functions/help/en_US/addchapter.sce new file mode 100755 index 000000000..6783cc57a --- /dev/null +++ b/modules/compatibility_functions/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("Compatibility Functions",SCI+"/modules/compatibility_functions/help/en_US",%T); + diff --git a/modules/compatibility_functions/help/en_US/firstnonsingleton.xml b/modules/compatibility_functions/help/en_US/firstnonsingleton.xml new file mode 100755 index 000000000..f930dbdc7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/firstnonsingleton.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) 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="en" xml:id="firstnonsingleton"> + <refnamediv> + <refname>firstnonsingleton</refname> + <refpurpose>Finds first dimension which is not 1</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dim</term> + <listitem> + <para>first dimension of A which is not 1</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A</term> + <listitem> + <para>a variable of any Scilab data type</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>a character string giving the type of output we want</para> + <variablelist> + <varlistentry> + <term>"num"</term> + <listitem> + <para>returned value is a numerical value</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"str"</term> + <listitem> + <para>returned value is a character string if possible ("r" instead of 1 and "c" instead of 2)</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function is used by <literal>mfile2sci</literal> to emulate Matlab behavior under Scilab, particularly + for functions which treat the values along the first non-singleton dimension of A in Matlab + while in Scilab they treat all values of A. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +A = [1 2 3;4 5 6]; +// Scilab max +M = max(A) +// Matlab max emulation +M = max(A,firstnonsingleton(A)) + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mstr2sci.xml b/modules/compatibility_functions/help/en_US/mstr2sci.xml new file mode 100755 index 000000000..678072720 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mstr2sci.xml @@ -0,0 +1,59 @@ +<?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="en" xml:id="mstr2sci"> + <refnamediv> + <refname>mstr2sci</refname> + <refpurpose>character string matrix to character matrix conversion</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>a=mstr2sci(txt)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>txt</term> + <listitem> + <para>character string or string matrix</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a</term> + <listitem> + <para>character vector or matrix</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function converts a Scilab character string to a vector of characters. + Result is the Scilab equivalent for a Matlab string. + </para> + <para> + <warning> + Caution: <literal>mstr2sci</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_0.xml b/modules/compatibility_functions/help/en_US/mtlb_0.xml new file mode 100755 index 000000000..5a1694b3a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_0.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_0"> + <refnamediv> + <refname>mtlb_0</refname> + <refpurpose>Matlab non-conjugate transposition emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab non-conjugate transposition behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With character strings operands: The <literal>.'</literal> operator is used to transpose whole + character strings in Scilab while Matlab realizes the transposition of each character. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_0(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A.'</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_0</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix + <literal>mtlb_0(A)</literal> may be replaced by <literal>A.'</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_0</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_a.xml b/modules/compatibility_functions/help/en_US/mtlb_a.xml new file mode 100755 index 000000000..9037abfbb --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_a.xml @@ -0,0 +1,83 @@ +<?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="en" xml:id="mtlb_a"> + <refnamediv> + <refname>mtlb_a</refname> + <refpurpose>Matlab addition emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab addition behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With character string operands: The <literal>+</literal> + operator is used into Scilab to catenate character strings, while + Matlab realizes the sum of the operands ASCII codes. + </para> + </listitem> + <listitem> + <para> + With empty matrix: In Scilab, if one of the + operands is an empty matrix the result of the addition is the + other operand. In Matlab if one of the operand is an empty + matrix the result of the addition should be an error or an empty + matrix. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_a(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A+B</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_a</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are character strings, + <literal>mtlb_a(A,B)</literal> may be replaced by <literal>asciimat(A)+asciimat(B)</literal> + </para> + </listitem> + <listitem> + <para> + If both <literal>A</literal> and <literal>B</literal> are not empty matrices + <literal>mtlb_a(A,B)</literal> may be replaced by <literal>A+B</literal>, + else <literal>mtlb_a(A,B)</literal> may be replaced by + <literal>[]</literal>. + </para> + </listitem> + <listitem> + <para> + If mtlb_mode==%T, then <literal>mtlb_a(A,B)</literal> + may be replaced by <literal>A+B</literal> in any case where + <literal>A</literal> and <literal>B</literal> are not character string matrices. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_a</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mtlb_mode">mtlb_mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_all.xml b/modules/compatibility_functions/help/en_US/mtlb_all.xml new file mode 100755 index 000000000..4a3b6dc65 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_all.xml @@ -0,0 +1,91 @@ +<?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="en" xml:id="mtlb_all"> + <refnamediv> + <refname>mtlb_all</refname> + <refpurpose>Matlab all emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>all</literal> and Scilab <literal>and</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When used with one input (<literal>all(A)</literal>), Matlab <literal>all</literal> treats the values along the first + non-singleton dimension of A as vectors while Scilab <literal>and</literal> treats all A values. + </para> + </listitem> + <listitem> + <para> + When used with two inputs (<literal>all(A,dim)</literal>), Matlab tolerates <literal>dim</literal> to be greater than + the number of dimensions of A while Scilab returns an error message in this case. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>R = mtlb_all(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>all(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_all</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar or a vector + <literal>R = mtlb_all(A)</literal> may be replaced by <literal>R = and(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a matrix + <literal>R = mtlb_all(A)</literal> may be replaced by <literal>R = and(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a hypermatrix + <literal>R = mtlb_all(A)</literal> may be replaced by <literal>R = and(A,firstnonsingleton(A))</literal> + or by <literal>R = and(A,user_defined_value)</literal> if the first non-singleton dimensions of A is known. + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is less equal to the number of dimensions of A + <literal>R = mtlb_all(A,dim)</literal> may be replaced by <literal>R = and(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is greater than then number of dimensions of A + <literal>R = mtlb_all(A,dim)</literal> may be replaced by <literal>R = A<>0</literal> if A is not an empty matrix or by <literal>R = A</literal> if A is an empty matrix. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_all</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_any.xml b/modules/compatibility_functions/help/en_US/mtlb_any.xml new file mode 100755 index 000000000..48a2556ce --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_any.xml @@ -0,0 +1,91 @@ +<?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="en" xml:id="mtlb_any"> + <refnamediv> + <refname>mtlb_any</refname> + <refpurpose>Matlab any emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>any</literal> and Scilab <literal>or</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When used with one input (<literal>any(A)</literal>), Matlab <literal>any</literal> treats the values along the first + non-singleton dimension of A as vectors while Scilab <literal>or</literal> treats all A values. + </para> + </listitem> + <listitem> + <para> + When used with two inputs (<literal>any(A,dim)</literal>), Matlab tolerates <literal>dim</literal> to be greater than + the number of dimensions of A while Scilab returns an error message in this case. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>R = mtlb_any(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>any(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_any</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar or a vector + <literal>R = mtlb_any(A)</literal> may be replaced by <literal>R = or(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a matrix + <literal>R = mtlb_any(A)</literal> may be replaced by <literal>R = or(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a hypermatrix + <literal>R = mtlb_any(A)</literal> may be replaced by <literal>R = or(A,firstnonsingleton(A))</literal> + or by <literal>R = or(A,user_defined_value)</literal> if the first non-singleton dimensions of A is known. + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is less equal to the number of dimensions of A + <literal>R = mtlb_any(A,dim)</literal> may be replaced by <literal>R = or(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is greater than then number of dimensions of A + <literal>R = mtlb_any(A,dim)</literal> may be replaced by <literal>R = A<>0</literal> if A is not an empty matrix or by <literal>R = A</literal> if A is an empty matrix. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_any</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_axis.xml b/modules/compatibility_functions/help/en_US/mtlb_axis.xml new file mode 100755 index 000000000..f588baa2f --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_axis.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_axis"> + <refnamediv> + <refname>mtlb_axis</refname> + <refpurpose>Matlab axis emulation + function + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mtlb_axis(X) + mtlb_axis(st) + mtlb_axis(axeshandle, ...) + [mode,visibility,direction]=mtlb_axis('state') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>a vector of reals ([xmin xmax ymin ymax] or [xmin xmax ymin + ymax zmin zmax]) + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>st</term> + <listitem> + <para>a string ('auto', 'manual', 'tight', 'ij', 'xy', 'equal', + 'square', 'vis3d', 'off', 'on') + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>axeshandle</term> + <listitem> + <para>handle of the current axes entity</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Matlab <literal>axis</literal> have not a Scilab equivalent function. + </para> + <para> + The function <literal>mtlb_axis(...)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>axis(...)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. + This function will determine the correct semantic at run time (axis + <literal>fill</literal>, axis <literal>image</literal> and axis <literal>normal</literal> + are not implemented). If you want to have a more efficient code it is + possible to replace <literal>mtlb_axis</literal> call by <literal>get(axeshandle, + prop) + </literal> + call (prop is an axis property, see + <link linkend="axis_properties">axis_properties</link>) + </para> + <para> + <warning> + Caution: <literal>mtlb_axis</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_beta.xml b/modules/compatibility_functions/help/en_US/mtlb_beta.xml new file mode 100755 index 000000000..b71bcdd57 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_beta.xml @@ -0,0 +1,59 @@ +<?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="en" xml:id="mtlb_beta"> + <refnamediv> + <refname>mtlb_beta</refname> + <refpurpose>Matlab beta emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>beta</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With inputs having different sizes: Matlab <literal>beta</literal> input parameters must have + the same size unless one of them is a scalar. In Scilab <literal>beta</literal> input parameters + must have the same size even if one of them is a scalar. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_beta(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>beta(A,B)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_beta</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar but not <literal>B</literal> + <literal>Y = mtlb_beta(A,B)</literal> may be replaced by <literal>C=B;C(:)=A;Y = mtlb_beta(C,B);</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>B</literal> is a scalar but not <literal>A</literal> + <literal>Y = mtlb_beta(A,B)</literal> may be replaced by <literal>C=A;C(:)=B;Y = mtlb_beta(A,C);</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_beta</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_box.xml b/modules/compatibility_functions/help/en_US/mtlb_box.xml new file mode 100755 index 000000000..71b86f71a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_box.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) 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="en" xml:id="mtlb_box"> + <refnamediv> + <refname>mtlb_box</refname> + <refpurpose>Matlab box emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>box</literal> but it can be easyly replaced. + </para> + <para> + The function <literal>mtlb_box([axes_handle[,val]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>box([axes_handle[,va]]l)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_box</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called without input parameters, + <literal>mtlb_box()</literal> may be replaced by <literal>a=gca();if a.box=="on" then a.box="off";else a.box="on";end;</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>axes_handle</literal> is a character string, + <literal>mtlb_box(axes_handle)</literal> may be replaced by <literal>a=gca();a.box=convstr(axes_handle,"l");</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>axes_handle</literal> is a graphic handle + <literal>mtlb_box(axes_handle)</literal> may be replaced by + <literal>if axes_handle.box=="on" then axes_handle.box="off";else axes_handle.box="on";end;</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>axes_handle</literal> is a graphic handle and <literal>val</literal> is a character string + <literal>mtlb_box(axes_handle,val)</literal> may be replaced by <literal>axes_handle.box=convstr(val,"l");</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_box</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_close.xml b/modules/compatibility_functions/help/en_US/mtlb_close.xml new file mode 100755 index 000000000..d32e22226 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_close.xml @@ -0,0 +1,85 @@ +<?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="en" xml:id="mtlb_close"> + <refnamediv> + <refname>mtlb_close</refname> + <refpurpose>Matlab close emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Scilab equivalent for Matlab <literal>close</literal> is different according to the current figure type (uicontrol or graphic one). + </para> + <itemizedlist> + <listitem> + <para> + When current figure is a uicontrol one: Scilab equivalent for Matlab <literal>close</literal> is <literal>close</literal> + </para> + </listitem> + <listitem> + <para> + When current figure is a graphic one: Scilab equivalent for Matlab <literal>close</literal> + is <literal>xdel</literal> or <literal>delete</literal> + </para> + </listitem> + <listitem> + <para> + In Scilab we do not get an error status. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_close([h])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>close([h])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_close</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>h</literal> is a uicontrol figure + <literal>mtlb_close(h)</literal> may be replaced by <literal>close(h)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>h</literal> is a graphic figure + <literal>mtlb_close(h)</literal> may be replaced by <literal>delete(h)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_close</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="xdel">xdel</link> + </member> + <member> + <link linkend="delete">delete</link> + </member> + <member> + <link linkend="winsid">winsid</link> + </member> + <member> + <link linkend="close">close</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_colordef.xml b/modules/compatibility_functions/help/en_US/mtlb_colordef.xml new file mode 100755 index 000000000..1f37ef0e7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_colordef.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) 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="en" xml:id="mtlb_colordef"> + <refnamediv> + <refname>mtlb_colordef</refname> + <refpurpose>Matlab colordef emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>colordef</literal> but there are equivalent instructions. + </para> + <para> + The function <literal>h = mtlb_colordef(color_option)</literal> or + <literal>h = mtlb_colordef(fig,color_option)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>colordef(color_option)</literal> or + <literal>colordef(fig,color_option)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_colordef</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input parameter, if <literal>color_option</literal> is equal to "black" or "none" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig = gcf();fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input parameter, if <literal>color_option</literal> is equal to "white" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig = gcf();fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + When called with two input parameters, if <literal>fig</literal> is a graphic handle and + <literal>color_option</literal> is equal to "black" or "none" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + When called with two input parameters, if <literal>fig</literal> is a graphic handle and + <literal>color_option</literal> is equal to "white" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + When called with two input parameters, if <literal>fig</literal> is equal to "new" and + <literal>color_option</literal> is equal to "black" or "none" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig = scf(max(winsid())+1);fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + When called with two input parameters, if <literal>fig</literal> is equal to "new" and + <literal>color_option</literal> is equal to "white" + <literal>mtlb_colordef(color_option)</literal> may be replaced by <literal>fig = scf(max(winsid())+1);fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + When called with one output parameter <literal>h</literal>, just add <literal>h = fig;</literal> after equivalent instructions. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_colordef</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="figure_properties">figure_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_cumprod.xml b/modules/compatibility_functions/help/en_US/mtlb_cumprod.xml new file mode 100755 index 000000000..c8350c0e6 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_cumprod.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) 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="en" xml:id="mtlb_cumprod"> + <refnamediv> + <refname>mtlb_cumprod</refname> + <refpurpose>Matlab cumprod emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>cumprod</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When used with one input (<literal>cumprod(A)</literal>), Matlab <literal>cumprod</literal> + treats the values along the first non-singleton dimension of A as vectors while + Scilab <literal>cumprod</literal> treats all A values. + </para> + </listitem> + <listitem> + <para> + When used with two inputs (<literal>cumprod(A,dim)</literal>), Matlab tolerates <literal>dim</literal> + to be greater than the number of dimensions of A while Scilab returns an error message in this case. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>R = mtlb_cumprod(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>cumprod(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_cumprod</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>dim</literal> is less equal to the number of dimensions of A + <literal>R = mtlb_cumprod(A,dim)</literal> may be replaced by <literal>R = cumprod(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is greater than then number of dimensions of A + <literal>R = mtlb_cumprod(A,dim)</literal> may be replaced by <literal>R = A</literal>. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_cumprod</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_cumsum.xml b/modules/compatibility_functions/help/en_US/mtlb_cumsum.xml new file mode 100755 index 000000000..3403f03f7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_cumsum.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) 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="en" xml:id="mtlb_cumsum"> + <refnamediv> + <refname>mtlb_cumsum</refname> + <refpurpose>Matlab cumsum emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>cumsum</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When used with one input (<literal>cumsum(A)</literal>), Matlab <literal>cumsum</literal> + treats the values along the first non-singleton dimension of A as vectors while + Scilab <literal>cumsum</literal> treats all A values. + </para> + </listitem> + <listitem> + <para> + When used with two inputs (<literal>cumsum(A,dim)</literal>), Matlab tolerates <literal>dim</literal> + to be greater than the number of dimensions of A while Scilab returns an error message in this case. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>R = mtlb_cumsum(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>cumsum(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_cumsum</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>dim</literal> is less equal to the number of dimensions of A + <literal>R = mtlb_cumsum(A,dim)</literal> may be replaced by <literal>R = cumsum(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>dim</literal> is greater than then number of dimensions of A + <literal>R = mtlb_cumsum(A,dim)</literal> may be replaced by <literal>R = A</literal>. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_cumsum</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_dec2hex.xml b/modules/compatibility_functions/help/en_US/mtlb_dec2hex.xml new file mode 100755 index 000000000..5665403bf --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_dec2hex.xml @@ -0,0 +1,69 @@ +<?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="en" xml:id="mtlb_dec2hex"> + <refnamediv> + <refname>mtlb_dec2hex</refname> + <refpurpose>Matlab dec2hex emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>dec2hex</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With empty matrix: Matlab <literal>dec2hex</literal> returns "" but in Scilab you get []. + </para> + </listitem> + <listitem> + <para> + With complex inputs: Matlab <literal>dec2hex</literal> automatically removes complex part of inputs but not Scilab one. + </para> + </listitem> + <listitem> + <para> + Matlab <literal>dec2hex</literal> always returns a row vector but in Scilab <literal>dec2hex</literal> + returns a value which have the same size as the input. + </para> + </listitem> + <listitem> + <para> + Matlab <literal>dec2hex</literal> can have two inputs but not Scilab one. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_dec2hex(D[,N])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>dec2hex(D[,N])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_dec2hex</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>D</literal> is not an empty matrix, + <literal>mtlb_dec2hex(D)</literal> may be replaced by + <literal>matrix(dec2hex(real(D)),-1,1)</literal> if <literal>D</literal> is complex and by + <literal>matrix(dec2hex(D),-1,1)</literal> else. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_dec2hex</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_delete.xml b/modules/compatibility_functions/help/en_US/mtlb_delete.xml new file mode 100755 index 000000000..17db373f5 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_delete.xml @@ -0,0 +1,55 @@ +<?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="en" xml:id="mtlb_delete"> + <refnamediv> + <refname>mtlb_delete</refname> + <refpurpose>Matlab delete emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + The function <literal>mtlb_delete(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>delete(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_delete</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string + <literal>mtlb_delete(A)</literal> may be replaced by <literal>mdelete(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a graphic handle + <literal>mtlb_delete(A)</literal> may be replaced by <literal>delete(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_delete</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_diag.xml b/modules/compatibility_functions/help/en_US/mtlb_diag.xml new file mode 100755 index 000000000..0bbd25233 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_diag.xml @@ -0,0 +1,60 @@ +<?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="en" xml:id="mtlb_diag"> + <refnamediv> + <refname>mtlb_diag</refname> + <refpurpose>Matlab diag emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>diag</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string matrices: Scilab <literal>diag</literal> function considers each character string as an object + while Matlab considers each character individually. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>y = mtlb_diag(x[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>y = diag(x[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_diag</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>x</literal> is not a character string matrix + <literal>y = mtlb_diag(x[,dim])</literal> may be replaced by <literal>y = diag(x[,dim])</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_diag</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_diff.xml b/modules/compatibility_functions/help/en_US/mtlb_diff.xml new file mode 100755 index 000000000..4405972dc --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_diff.xml @@ -0,0 +1,65 @@ +<?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="en" xml:id="mtlb_diff"> + <refnamediv> + <refname>mtlb_diff</refname> + <refpurpose>Matlab diff emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>diff</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With two input parameters: Scilab <literal>diff</literal> considers all values of first input as a vector + what Matlab does not. + </para> + </listitem> + <listitem> + <para> + With three input parameters: If dimension of first input along dimension given by third parameter + reaches 1 before n interations + have been made,Matlab switches to next non-singleton dimension what Scilab does not. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_diff(A[,n[,dim]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>diff(A[,n[,dim]])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_diff</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + With two inputs, if <literal>A</literal> is a scalar or a vector + <literal>mtlb_diff(A,n)</literal> may be replaced by <literal>diff(A,n)</literal> + </para> + </listitem> + <listitem> + <para> + With three inputs, if size of A along dimension given by <literal>dim</literal> can not reach 1 + <literal>mtlb_diff(A,n,dim)</literal> may be replaced by <literal>diff(A,n,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_diff</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_dir.xml b/modules/compatibility_functions/help/en_US/mtlb_dir.xml new file mode 100755 index 000000000..9c9f84b0f --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_dir.xml @@ -0,0 +1,44 @@ +<?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="en" xml:id="mtlb_dir"> + <refnamediv> + <refname>mtlb_dir</refname> + <refpurpose>Matlab dir emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>dir</literal> behave differently: + </para> + <itemizedlist> + <listitem> + <para> + When result is stored in a variable: Matlab <literal>dir</literal> returns a structure but Scilab + <literal>dir</literal> returns a 'dir' tlist, so data can not be extracted in the same way. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_dir([path])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>dir([path])</literal> when output is stored in a variable. + There is no replacement possibility for it, else (when <literal>mtlb_dir</literal> is replaced by <literal>dir</literal>) + data can not be extracted like in Matlab. For example, Scilab equivalent for Matlab + <literal>L=dir;file_name=L(1).name;</literal> is <literal>L=dir();file_name=L.name(1);</literal>. + </para> + <para> + <warning> + Caution: <literal>mtlb_dir</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_double.xml b/modules/compatibility_functions/help/en_US/mtlb_double.xml new file mode 100755 index 000000000..a03366b9c --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_double.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) 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="en" xml:id="mtlb_double"> + <refnamediv> + <refname>mtlb_double</refname> + <refpurpose>Matlab double emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>double</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string input: Scilab <literal>double</literal> does not work with this type of input while Matlab <literal>double</literal> returns a matrix of ASCII codes. + </para> + </listitem> + <listitem> + <para> + With boolean input: Scilab <literal>double</literal> does not work with this type of input while Matlab <literal>double</literal> returns a matrix of double values. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_double(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>double(A)</literal> when it was not + possible to know what were theinput while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_double</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string, + <literal>mtlb_double(A)</literal> may be replaced by <literal>asciimat(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a boolean matrix, + <literal>mtlb_double(A)</literal> may be replaced by <literal>bool2s(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a double matrix, + <literal>mtlb_double(A)</literal> may be replaced by <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_double</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="asciimat">asciimat</link> + </member> + <member> + <link linkend="bool2s">bool2s</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_e.xml b/modules/compatibility_functions/help/en_US/mtlb_e.xml new file mode 100755 index 000000000..73a046065 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_e.xml @@ -0,0 +1,82 @@ +<?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="en" xml:id="mtlb_e"> + <refnamediv> + <refname>mtlb_e</refname> + <refpurpose>Matlab extraction emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab extraction behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + When extracting data from a matrix with a vector as index: Matlab returns + a row vector and Scilab returns a column vector. + </para> + </listitem> + <listitem> + <para> + When extracting data from a character string matrix: due to the fact that character string matrices + in Matlab can be addressed as any other matrix (each character can be adressed), extraction in such a type of + matrix does not differ from other. But in Scilab it can't be done so and <literal>part</literal> + function has to be used. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_e(B,k)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A=B(k)</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_e</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>B</literal> is a vector + <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=B(k)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>B</literal> is a matrix + <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=B(k).'</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>B</literal> is a character string matrix and + k is a scalar or a vector + <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=part(B,k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_e</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_echo.xml b/modules/compatibility_functions/help/en_US/mtlb_echo.xml new file mode 100755 index 000000000..2d7f02da3 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_echo.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="en" xml:id="mtlb_echo"> + <refnamediv> + <refname>mtlb_echo</refname> + <refpurpose>Matlab echo emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no equivalent for Matlab <literal>echo</literal> in Scilab but some cases can be replaced by calls to Scilab <literal>mode</literal>: + </para> + <itemizedlist> + <listitem> + <para> + <literal>echo</literal>: is equivalent to Scilab <literal>mode(abs(mode()-1))</literal> for scripts and non-compiled functions + </para> + </listitem> + <listitem> + <para> + <literal>echo on</literal>: is equivalent to Scilab <literal>mode(1)</literal> for scripts and non-compiled functions + </para> + </listitem> + <listitem> + <para> + <literal>echo off</literal>: is equivalent to Scilab <literal>mode(0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_echo(arg1[,arg2])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>echo arg1 [arg2]</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_echo</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>arg1</literal> is equal to "on" + <literal>mtlb_echo(arg1)</literal> may be replaced by <literal>mode(1)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>arg1</literal> is equal to "off" + <literal>mtlb_echo(arg1)</literal> may be replaced by <literal>mode(0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_echo</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mode">mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_eval.xml b/modules/compatibility_functions/help/en_US/mtlb_eval.xml new file mode 100755 index 000000000..d36aa97c6 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_eval.xml @@ -0,0 +1,95 @@ +<?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="en" xml:id="mtlb_eval"> + <refnamediv> + <refname>mtlb_eval</refname> + <refpurpose>Matlab eval emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Scilab equivalent for Matlab <literal>eval</literal> is different according to its inputs and outputs + </para> + <para> + The function <literal>mtlb_eval(str1,str2)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>eval</literal> because it was not possible to know + what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_eval</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input and no output, + <literal>mtlb_eval(str1)</literal> may be replaced by <literal>evstr(str1)</literal> + if <literal>str1</literal> is a valid Scilab expression + or by <literal>execstr(str1)</literal> + if <literal>str1</literal> is a valid Scilab instruction. + </para> + </listitem> + <listitem> + <para> + When called with one input and one output, + <literal>val=mtlb_eval(str1)</literal> may be replaced by <literal>val=evstr(str1)</literal> + if <literal>str1</literal> is a valid Scilab instruction. + </para> + </listitem> + <listitem> + <para> + When called with two inputs and no output, + <literal>mtlb_eval(str1,str2)</literal> may be replaced by: + <literal>if execstr(str1,"errcatch")<>0 then execstr(str2);end</literal> + if <literal>str1</literal> and <literal>str2</literal> are valid Scilab instructions. + </para> + </listitem> + <listitem> + <para> + When called with more than one output and one input, + <literal>[val1,val2,...]=mtlb_eval(str1)</literal> may be replaced by + <literal>execstr("[val1,val2,...]"+str1)</literal> + if <literal>str1</literal> is a valid Scilab instruction. + </para> + </listitem> + <listitem> + <para> + When called with two inputs and more than one output, + <literal>[val1,val2,...]=mtlb_eval(str1,str2)</literal> may be replaced by: + </para> + <programlisting role=""><![CDATA[ +if execstr("[val1,val2,...]"+str1,"errcatch")<>0 then + execstr("[val1,val2,...]"+str2); +end + ]]></programlisting> + <para> + if <literal>str1</literal> and <literal>str2</literal> are valid Scilab instructions. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_eval</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_exist.xml b/modules/compatibility_functions/help/en_US/mtlb_exist.xml new file mode 100755 index 000000000..41d2c49b7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_exist.xml @@ -0,0 +1,53 @@ +<?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="en" xml:id="mtlb_exist"> + <refnamediv> + <refname>mtlb_exist</refname> + <refpurpose>Matlab exist emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>exist</literal> except when input is a variable. + Scilab <literal>mtlb_exist</literal> is a partial emulation of of this function. + </para> + <para> + The function <literal>r = mtlb_exist(nam[,tp])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>exist(nam[,tp])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_exist</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input and if <literal>nam</literal> is a variable name, + <literal>mtlb_exist(nam)</literal> may be replaced by <literal>exists(nam)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_exist</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="exists">exists</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_eye.xml b/modules/compatibility_functions/help/en_US/mtlb_eye.xml new file mode 100755 index 000000000..b1d96949f --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_eye.xml @@ -0,0 +1,57 @@ +<?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="en" xml:id="mtlb_eye"> + <refnamediv> + <refname>mtlb_eye</refname> + <refpurpose>Matlab eye emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>eye</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>eye</literal> returns a n x n matrix while Scilab returns a 1. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_eye(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>eye(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_eye</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_eye(A)</literal> may be replaced by <literal>eye(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_eye(A)</literal> may be replaced by <literal>eye(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_eye</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_false.xml b/modules/compatibility_functions/help/en_US/mtlb_false.xml new file mode 100755 index 000000000..c36431ff7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_false.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) 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="en" xml:id="mtlb_false"> + <refnamediv> + <refname>mtlb_false</refname> + <refpurpose>Matlab false emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>false</literal>. However, Scilab <literal>zeros</literal> + returns a result interpreted in an equivalent way for Scilab. + </para> + <para> + Matlab <literal>false</literal> and Scilab <literal>zeros</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>false</literal> returns a n x n matrix of zeros + while Scilab <literal>zeros</literal> returns a 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_false(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>false(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_false</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_false(A)</literal> may be replaced by <literal>zeros(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_false(A)</literal> may be replaced by <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_false</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fft.xml b/modules/compatibility_functions/help/en_US/mtlb_fft.xml new file mode 100755 index 000000000..4575e6ba2 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fft.xml @@ -0,0 +1,59 @@ +<?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="en" xml:id="mtlb_fft"> + <refnamediv> + <refname>mtlb_fft</refname> + <refpurpose>Matlab fft emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>fft</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With one input parameter: If input is a scalar or vector Scilab equivalent for Matlab <literal>fft</literal> + is <literal>fft(...,-1)</literal> else if input is a matrix Scilab equivalent for Matlab <literal>fft</literal> + is <literal>fft(...,-1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_fft(X[,n,[job]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fft(X[,n,[job]])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_fft</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>X</literal> is a scalar or a vector + <literal>mtlb_fft(X,-1)</literal> may be replaced by <literal>fft(X,-1)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>X</literal> is a matrix + <literal>mtlb_fft(X,-1)</literal> may be replaced by <literal>fft(X,-1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_fft</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fftshift.xml b/modules/compatibility_functions/help/en_US/mtlb_fftshift.xml new file mode 100755 index 000000000..5cc4d2678 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fftshift.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) 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="en" xml:id="mtlb_fftshift"> + <refnamediv> + <refname>mtlb_fftshift</refname> + <refpurpose>Matlab fftshift emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>fftshift</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string input: due to the fact that character strings are not considered in the same way in Matlab and Scilab, results can be different for this kind of input. + </para> + </listitem> + <listitem> + <para> + With two inputs: Matlab <literal>fftshift</literal> can work even if <literal>dim</literal> parameter is greater than number of dimensions of first input. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_fftshift(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fftshift(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_fftshift</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix, + <literal>mtlb_fftshift(A)</literal> may be replaced by <literal>fftshift(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix and <literal>dim</literal> is not greater than <literal>size(size(a),"*")</literal>, + <literal>mtlb_fftshift(A,dim)</literal> may be replaced by <literal>fftshift(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_fftshift</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_find.xml b/modules/compatibility_functions/help/en_US/mtlb_find.xml new file mode 100755 index 000000000..47c766574 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_find.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) 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="en" xml:id="mtlb_find"> + <refnamediv> + <refname>mtlb_find</refname> + <refpurpose>Matlab find emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>find</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With column vectors and matrices as input: Matlab <literal>find</literal> returns column + vectors while Scilab returns row vectors. + </para> + </listitem> + <listitem> + <para> + When called with three outputs: Matlab <literal>find</literal> can have three outputs but Scilab not. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>[i[,j[,v]]] = mtlb_find(B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>[i[,j[,v]]] = find(B)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_find</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one output, if <literal>B</literal> is a row vector + <literal>i = mtlb_find(B)</literal> may be replaced by <literal>i = find(B)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one output, if <literal>B</literal> is not a row vector + <literal>i = mtlb_find(B)</literal> may be replaced by <literal>i = matrix(find(B),-1,1)</literal> + </para> + </listitem> + <listitem> + <para> + When called with two outputs, if <literal>B</literal> is a row vector + <literal>[i,j] = mtlb_find(B)</literal> may be replaced by <literal>[i,j] = find(B)</literal> + </para> + </listitem> + <listitem> + <para> + When called with two outputs, if <literal>B</literal> is not a row vector + <literal>[i,j] = mtlb_find(B)</literal> may be replaced by + <literal>[i,j] = find(B);i = matrix(i,-1,1);j = matrix(j,-1,1);</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_find</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_findstr.xml b/modules/compatibility_functions/help/en_US/mtlb_findstr.xml new file mode 100755 index 000000000..f86da5aa8 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_findstr.xml @@ -0,0 +1,45 @@ +<?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="en" xml:id="mtlb_findstr"> + <refnamediv> + <refname>mtlb_findstr</refname> + <refpurpose>Matlab findstr emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>findstr</literal>. + </para> + <para> + The function <literal>mtlb_findstr(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>findstr(A,B)</literal> when it was not + possible to know what were the operands/inputs[CUSTOM] while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_findstr</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is always longer than <literal>B</literal> + (i.e. <literal>findstr</literal> can be replaced by <literal>strfind</literal> in Matlab, + <literal>mtlb_findstr(A,B)</literal> may be replaced by <literal>strindex(A,B)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_findstr</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fliplr.xml b/modules/compatibility_functions/help/en_US/mtlb_fliplr.xml new file mode 100755 index 000000000..788b789b5 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fliplr.xml @@ -0,0 +1,51 @@ +<?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="en" xml:id="mtlb_fliplr"> + <refnamediv> + <refname>mtlb_fliplr</refname> + <refpurpose>Matlab fliplr emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>fliplr</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string matrices: due to te fact that Scilab and Matlab do not consider character string matrices in the same way, result can be different for input of this type. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_fliplr(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fliplr(A)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_fliplr</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix, + <literal>mtlb_fliplr(A)</literal> may be replaced by <literal>A(:,$:-1:1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_fliplr</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fopen.xml b/modules/compatibility_functions/help/en_US/mtlb_fopen.xml new file mode 100755 index 000000000..c95bbfd09 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fopen.xml @@ -0,0 +1,61 @@ +<?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="en" xml:id="mtlb_fopen"> + <refnamediv> + <refname>mtlb_fopen</refname> + <refpurpose>Matlab fopen emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>fopen</literal> and Scilab <literal>mopen</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + Scilab function returns no usable error message + </para> + </listitem> + <listitem> + <para> + Scilab file identified does not exist in case of error but Matlab one is set to <literal>-1</literal>. + </para> + </listitem> + <listitem> + <para> + Matlab function can work with inputs which do not exist in Scilab such as permission options... + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_fopen(filename,permission)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>mopen(filename,permission)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_fopen</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If error message is not used and no error can occurs, + <literal>mtlb_fopen(filename,permission)</literal> may be replaced by <literal>mopen(filename,permission,0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_fopen</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_format.xml b/modules/compatibility_functions/help/en_US/mtlb_format.xml new file mode 100755 index 000000000..0c7e15952 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_format.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) 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="en" xml:id="mtlb_format"> + <refnamediv> + <refname>mtlb_format</refname> + <refpurpose>Matlab format emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>format</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + Some Matlab formats do not exist in Scilab + </para> + </listitem> + <listitem> + <para> + Calling sequence for <literal>format</literal> is different in Scilab and Matlab + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_format(type,prec)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>format([type prec])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_format</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>type=""</literal> and <literal>prec=""</literal> + <literal>mtlb_format("","")</literal> may be replaced by <literal>format("v",6)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="+"</literal> and <literal>prec=""</literal> + <literal>mtlb_format("+","")</literal> may be replaced by <literal>format(6)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="long"</literal> and <literal>prec=""</literal> + <literal>mtlb_format("long","")</literal> may be replaced by <literal>format(16)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="long"</literal> and <literal>prec="e"</literal> + <literal>mtlb_format("long","e")</literal> may be replaced by <literal>format("e"16)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="long"</literal> and <literal>prec="g"</literal> + <literal>mtlb_format("long","g")</literal> may be replaced by <literal>format("e"16)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="short"</literal> and <literal>prec=""</literal> + <literal>mtlb_format("short","")</literal> may be replaced by <literal>format(6)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="short"</literal> and <literal>prec="e"</literal> + <literal>mtlb_format("short","e")</literal> may be replaced by <literal>format("e"6)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>type="short"</literal> and <literal>prec="g"</literal> + <literal>mtlb_format("short","g")</literal> may be replaced by <literal>format("e"6)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_format</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fprintf.xml b/modules/compatibility_functions/help/en_US/mtlb_fprintf.xml new file mode 100755 index 000000000..74ed3e552 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fprintf.xml @@ -0,0 +1,44 @@ +<?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="en" xml:id="mtlb_fprintf"> + <refnamediv> + <refname>mtlb_fprintf</refname> + <refpurpose>Matlab fprintf emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab exact equivalent for Matlab <literal>fprintf</literal>. Scilab <literal>mfprintf</literal> + and Matlab <literal>fprintf</literal> behave differently in many cases, but they are equivalents in some cases. + </para> + <para> + The function <literal>mtlb_fprintf(varargin)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fprintf</literal>. This function will + determine the correct semantic at run time. It is sometimes possible to replace + calls to <literal>mtlb_fprintf</literal> by calls to <link linkend="mfprintf">mfprintf</link>. + </para> + <para> + <warning> + Caution: <literal>mtlb_fprintf</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fread.xml b/modules/compatibility_functions/help/en_US/mtlb_fread.xml new file mode 100755 index 000000000..b2231f791 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fread.xml @@ -0,0 +1,44 @@ +<?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="en" xml:id="mtlb_fread"> + <refnamediv> + <refname>mtlb_fread</refname> + <refpurpose>Matlab fread emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>fread</literal>. Scilab <literal>mget</literal> + and Matlab <literal>fread</literal> behave differently in many cases, but they are equivalents in some cases. + </para> + <para> + The function <literal>mtlb_fread(varargin)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fread</literal>. This function will + determine the correct semantic at run time. It is sometimes possible to replace + calls to <literal>mtlb_fread</literal> by calls to <link linkend="mget">mget</link>. + </para> + <para> + <warning> + Caution: <literal>mtlb_fread</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mget">mget</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fscanf.xml b/modules/compatibility_functions/help/en_US/mtlb_fscanf.xml new file mode 100755 index 000000000..44ff0fe7f --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fscanf.xml @@ -0,0 +1,44 @@ +<?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="en" xml:id="mtlb_fscanf"> + <refnamediv> + <refname>mtlb_fscanf</refname> + <refpurpose>Matlab fscanf emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab exact equivalent for Matlab <literal>fscanf</literal>. Scilab <literal>mfscanf</literal> + and Matlab <literal>fscanf</literal> behave differently in many cases, but they are equivalents in some cases. + </para> + <para> + The function <literal>mtlb_fscanf(varargin)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fscanf</literal>. This function will + determine the correct semantic at run time. It is sometimes possible to replace + calls to <literal>mtlb_fscanf</literal> by calls to <link linkend="mfscanf">mfscanf</link>. + </para> + <para> + <warning> + Caution: <literal>mtlb_fscanf</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_full.xml b/modules/compatibility_functions/help/en_US/mtlb_full.xml new file mode 100755 index 000000000..3924e8146 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_full.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) 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="en" xml:id="mtlb_full"> + <refnamediv> + <refname>mtlb_full</refname> + <refpurpose>Matlab full emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>full</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character strings input: Matlab <literal>full</literal> can be used with character string input + while Scilab function cannot. + </para> + </listitem> + <listitem> + <para> + With boolean input: Matlab <literal>full</literal> can be used with boolean input + while Scilab function cannot. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_full(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>full(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_full</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a double matrix + <literal>mtlb_full(A)</literal> may be replaced by <literal>full(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a boolean matrix + <literal>mtlb_full(A)</literal> may be replaced by <literal>full(bool2s(A))</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_full</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_fwrite.xml b/modules/compatibility_functions/help/en_US/mtlb_fwrite.xml new file mode 100755 index 000000000..e8bc7bf9a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_fwrite.xml @@ -0,0 +1,44 @@ +<?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="en" xml:id="mtlb_fwrite"> + <refnamediv> + <refname>mtlb_fwrite</refname> + <refpurpose>Matlab fwrite emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>fwrite</literal>. Scilab <literal>mput</literal> + and Matlab <literal>fwrite</literal> behave differently in many cases, but they are equivalents in some cases. + </para> + <para> + The function <literal>mtlb_fwrite(varargin)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>fwrite</literal>. This function will + determine the correct semantic at run time. It is sometimes possible to replace + calls to <literal>mtlb_fwrite</literal> by calls to <link linkend="mput">mput</link>. + </para> + <para> + <warning> + Caution: <literal>mtlb_fwrite</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mput">mput</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_grid.xml b/modules/compatibility_functions/help/en_US/mtlb_grid.xml new file mode 100755 index 000000000..b4711840d --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_grid.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) 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="en" xml:id="mtlb_grid"> + <refnamediv> + <refname>mtlb_grid</refname> + <refpurpose>Matlab grid emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>grid</literal> but there are equivalent instructions. + </para> + <para> + The function <literal>mtlb_grid(flag_or_handle[,flag])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>grid(flag_or_handle[,flag])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_grid</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + With one input, if <literal>flag</literal> is equal to "on" + <literal>mtlb_grid(flag)</literal> may be replaced by <literal>set(gca(),"grid",[1 1])</literal> + </para> + </listitem> + <listitem> + <para> + With one input, if <literal>flag</literal> is equal to "off" + <literal>mtlb_grid(flag)</literal> may be replaced by <literal>set(gca(),"grid",[-1 -1])</literal> + </para> + </listitem> + <listitem> + <para> + With two inputs, if <literal>flag</literal> is equal to "on" + <literal>mtlb_grid(axes_handle,flag)</literal> may be replaced by <literal>axes_handle.grid=[1 1]</literal> + </para> + </listitem> + <listitem> + <para> + With two inputs, if <literal>arg2</literal> is equal to "off" + <literal>mtlb_grid(axes_handle,flag)</literal> may be replaced by <literal>axes_handle.grid=[-1 -1]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_grid</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_hold.xml b/modules/compatibility_functions/help/en_US/mtlb_hold.xml new file mode 100755 index 000000000..71ea7024f --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_hold.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_hold"> + <refnamediv> + <refname>mtlb_hold</refname> + <refpurpose>Matlab hold emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>hold</literal> but there are equivalent instructions. + </para> + <para> + The function <literal>mtlb_hold(flag)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>hold flag</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_hold</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>flag</literal> is equal to "on" + <literal>mtlb_hold(flag)</literal> may be replaced by <literal>set(gca(),"auto_clear","off")</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>flag</literal> is equal to "off" + <literal>mtlb_hold(flag)</literal> may be replaced by <literal>set(gca(),"auto_clear","on")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_hold</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_i.xml b/modules/compatibility_functions/help/en_US/mtlb_i.xml new file mode 100755 index 000000000..1501657bc --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_i.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) 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="en" xml:id="mtlb_i"> + <refnamediv> + <refname>mtlb_i</refname> + <refpurpose>Matlab insertion emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab insertion behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + When inserting a matrix in a variable: Matlab automatically adjusts output + variable to fit with matrix to insert but not Scilab. + For example, with A=1, A([1,2,3,4])=[1,2;3,4]) returns an error in Scilab + while in Matlab we get A=[1,2,3,4]. If values miss comparing to indexes, + Matlab fills output value with 0. + </para> + </listitem> + <listitem> + <para> + When inserting data into a character string matrix: due to the fact that character string matrices + in Matlab can be addressed as any other matrix (each character can be adressed), insertion in such a type of + matrix does not differ from other. But in Scilab it can't be done so...<literal>mtlb_is</literal> is an alternative. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>A=mtlb_i(A,k,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A(k)=B</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_i</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a vector + <literal>A=mtlb_i(A,k,B)</literal> may be replaced by <literal>A(k)=B</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are both row or column vectors + <literal>A=mtlb_i(A,k,B)</literal> may be replaced by <literal>A(k)=B</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_i</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + <member> + <link linkend="mtlb_is">mtlb_is</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_ifft.xml b/modules/compatibility_functions/help/en_US/mtlb_ifft.xml new file mode 100755 index 000000000..a5e874b27 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_ifft.xml @@ -0,0 +1,59 @@ +<?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="en" xml:id="mtlb_ifft"> + <refnamediv> + <refname>mtlb_ifft</refname> + <refpurpose>Matlab ifft emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>ifft</literal> and Scilab <literal>fft</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With one input parameter: If input is a scalar or vector Scilab equivalent for Matlab <literal>ifft(A)</literal> + is <literal>fft(A,1)</literal> else if input is a matrix Scilab equivalent for Matlab <literal>fft</literal> + is <literal>fft(A,1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_ifft(X[,n,[job]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>ifft(X[,n,[job]])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_ifft</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>X</literal> is a scalar or a vector + <literal>mtlb_ifft(X,1)</literal> may be replaced by <literal>fft(X,1)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>X</literal> is a matrix + <literal>mtlb_ifft(X,1)</literal> may be replaced by <literal>fft(X,1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_ifft</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_imp.xml b/modules/compatibility_functions/help/en_US/mtlb_imp.xml new file mode 100755 index 000000000..f2657c116 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_imp.xml @@ -0,0 +1,50 @@ +<?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="en" xml:id="mtlb_imp"> + <refnamediv> + <refname>mtlb_imp</refname> + <refpurpose>Matlab colon emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab colon behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With empty matrices: The <literal>:</literal> operator must be used with scalars in Scilab and + gives an error message when used with empty matrices while Matlab returns [] in these cases. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_imp(A,B[,C])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A:B[:C]</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_imp</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal>, <literal>B</literal> and <literal>C</literal> are not empty matrices + <literal>mtlb_imp(A,B[,C])</literal> may be replaced by <literal>A:B[:C]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_imp</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_int16.xml b/modules/compatibility_functions/help/en_US/mtlb_int16.xml new file mode 100755 index 000000000..8e9461464 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_int16.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_int16"> + <refnamediv> + <refname>mtlb_int16</refname> + <refpurpose>Matlab int16 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>int16</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>int16</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>int16</literal> returns 32767 and Scilab returns -32768. + </para> + </listitem> + <listitem> + <para> + With <literal>%nan</literal>: Matlab <literal>int16</literal> returns 0 and Scilab returns -32768. + </para> + </listitem> + <listitem> + <para> + With <literal>-%nan</literal>: Matlab <literal>int16</literal> returns 0 and Scilab returns -32768. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_int16(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>int16(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_int16</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal>, <literal>%nan</literal> or <literal>-%nan</literal> values + <literal>mtlb_int16(A)</literal> may be replaced by <literal>int16(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_int16</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_int32.xml b/modules/compatibility_functions/help/en_US/mtlb_int32.xml new file mode 100755 index 000000000..c1f17c4d4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_int32.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_int32"> + <refnamediv> + <refname>mtlb_int32</refname> + <refpurpose>Matlab int32 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>int32</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>int32</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>int32</literal> returns 2147483647 and Scilab returns -2147483648. + </para> + </listitem> + <listitem> + <para> + With <literal>%nan</literal>: Matlab <literal>int32</literal> returns 0 and Scilab returns -2147483648. + </para> + </listitem> + <listitem> + <para> + With <literal>-%nan</literal>: Matlab <literal>int32</literal> returns 0 and Scilab returns -2147483648. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_int32(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>int32(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_int32</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal>, <literal>%nan</literal> or <literal>-%nan</literal> values + <literal>mtlb_int32(A)</literal> may be replaced by <literal>int32(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_int32</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_int8.xml b/modules/compatibility_functions/help/en_US/mtlb_int8.xml new file mode 100755 index 000000000..fc5d90710 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_int8.xml @@ -0,0 +1,61 @@ +<?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="en" xml:id="mtlb_int8"> + <refnamediv> + <refname>mtlb_int8</refname> + <refpurpose>Matlab int8 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>int8</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>int8</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>int8</literal> returns 127 and Scilab returns 0. + </para> + </listitem> + <listitem> + <para> + With <literal>-%inf</literal>: Matlab <literal>int8</literal> returns -128 and Scilab returns 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_int8(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>int8(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_int8</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal> or <literal>-%inf</literal> values + <literal>mtlb_int8(A)</literal> may be replaced by <literal>int8(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_int8</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_is.xml b/modules/compatibility_functions/help/en_US/mtlb_is.xml new file mode 100755 index 000000000..007dc4f9a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_is.xml @@ -0,0 +1,46 @@ +<?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="en" xml:id="mtlb_is"> + <refnamediv> + <refname>mtlb_is</refname> + <refpurpose>Matlab string insertion emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab insertion behave differently for strings due to the fact + that they do not consider character strings in the same way. + </para> + <para> + The function <literal>str = mtlb_is(sto,sfrom,i,j)</literal> is used by + <literal>mfile2sci</literal> to replace insertion operations for character strings. This function will + determine the correct semantic at run time. There is no replacement possibility for it. + </para> + <para> + <warning> + Caution: <literal>mtlb_is</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + <member> + <link linkend="mtlb_i">mtlb_i</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_isa.xml b/modules/compatibility_functions/help/en_US/mtlb_isa.xml new file mode 100755 index 000000000..636a0ef8d --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_isa.xml @@ -0,0 +1,121 @@ +<?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="en" xml:id="mtlb_isa"> + <refnamediv> + <refname>mtlb_isa</refname> + <refpurpose>Matlab isa emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>isa</literal> but some equivalent expressions can be used when the object "class" exists in Scilab. + </para> + <para> + The function <literal>mtlb_isa(OBJ,class)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>isa(OBJ,class)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_isa</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>class</literal> is equal to "logical", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==4</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "char", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==10</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "numeric", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>or(type(OBJ)==[1,5,8])</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "intX" (X being equal to 8, 16, or 32), + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>typeof(OBJ)=="intX"</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "uintX" (X being equal to 8, 16, or 32), + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>typeof(OBJ)=="uintX"</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "single", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==1</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "double", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==1</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "cell", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>typeof(OBJ)=="ce"</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "struct", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>typeof(OBJ)=="st"</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "function_handle", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==13</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "sparse", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>type(OBJ)==5</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>class</literal> is equal to "lti", + <literal>mtlb_isa(OBJ,class)</literal> may be replaced by <literal>typeof(OBJ)=="state-space"</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_isa</literal> has not to be used for hand coded functions. + </warning> + </para> + </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> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_isfield.xml b/modules/compatibility_functions/help/en_US/mtlb_isfield.xml new file mode 100755 index 000000000..e3de8eae9 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_isfield.xml @@ -0,0 +1,65 @@ +<?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="en" xml:id="mtlb_isfield"> + <refnamediv> + <refname>mtlb_isfield</refname> + <refpurpose>Matlab isfield emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>isfield(st,f)</literal> and equivalent expressions behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>st</literal> is not a structure: Scilab equivalent returns an error message but Matlab returns <literal>0</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_isfield(st,f)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>isfield(st,f)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_isfield</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>st</literal> is a structure + <literal>tf = mtlb_isfield(st,f)</literal> may be replaced by <literal>allf=getfield(1,st);tf=or(allf(3:$)==f);</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>st</literal> is not a structure + <literal>tf = mtlb_isfield(st,f)</literal> may be replaced by <literal>tf=%F;</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_isfield</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getfield">getfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_isletter.xml b/modules/compatibility_functions/help/en_US/mtlb_isletter.xml new file mode 100755 index 000000000..bb450e86a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_isletter.xml @@ -0,0 +1,46 @@ +<?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="en" xml:id="mtlb_isletter"> + <refnamediv> + <refname>mtlb_isletter</refname> + <refpurpose>Matlab isletter emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>isletter</literal> and equivalent instructions are quite ugly, so + <literal>mfile2sci</literal> uses <literal>mtlb_isletter(A)</literal> to replace <literal>isletter(A)</literal>. If you want to have a + more efficient code it is possible to replace <literal>mtlb_isletter</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a character string + <literal>tf = mtlb_isletter(A)</literal> may be replaced by <literal>tf = zeros(A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a character string + <literal>tf = mtlb_isletter(A)</literal> may be replaced by + <literal>tf = (asciimat(A)>=65&asciimat(A)<=90)|(asciimat(A)>=97&asciimat(A)<=122)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_isletter</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_isspace.xml b/modules/compatibility_functions/help/en_US/mtlb_isspace.xml new file mode 100755 index 000000000..77a65133d --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_isspace.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_isspace"> + <refnamediv> + <refname>mtlb_isspace</refname> + <refpurpose>Matlab isspace emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab function equivalent for Matlab <literal>isspace</literal> but its behavior can be reproduced. + </para> + <para> + The function <literal>mtlb_isspace(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>isspace(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_isspace</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string matrix + <literal>mtlb_isspace(A)</literal> may be replaced by <literal>asciimat(A)==32</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix + <literal>mtlb_isspace(A)</literal> may be replaced by <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_isspace</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="asciimat">asciimat</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_l.xml b/modules/compatibility_functions/help/en_US/mtlb_l.xml new file mode 100755 index 000000000..dce980550 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_l.xml @@ -0,0 +1,51 @@ +<?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="en" xml:id="mtlb_l"> + <refnamediv> + <refname>mtlb_l</refname> + <refpurpose>Matlab left division emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab left division behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With character string operands: The <literal>\</literal> + operator can not be used into Scilab with character strings, while + in Matlab it can. And in this case, result is transposed in a very strange way... + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_l(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A\B</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_l</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If both <literal>A</literal> and <literal>B</literal> are not character strings + <literal>mtlb_l(A,B)</literal> may be replaced by <literal>A\B</literal>. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_l</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_legendre.xml b/modules/compatibility_functions/help/en_US/mtlb_legendre.xml new file mode 100755 index 000000000..35a79b2d4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_legendre.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_legendre"> + <refnamediv> + <refname>mtlb_legendre</refname> + <refpurpose>Matlab legendre emulation + function + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>P = mtlb_legendre(n,X) + P = mtlb_legendre(n,X[,normflag]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>a scalar, vector, matrix or hypermatrix with elements in + [-1,1] + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para>a positive scalar integer</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>normflag</term> + <listitem> + <para>a string ('sch' or 'norm')</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>legendre</literal> behave differently in some + particular cases: + </para> + <itemizedlist> + <listitem> + <para> + Scilab <literal>legendre(m,n,X)</literal> evaluates the + <literal>legendre</literal> function of degree n and order n for the + <literal>X</literal> elements. Matlab <literal>legendre(n,X)</literal> + evaluates the Legendre functions of degree <literal>n</literal> and + order <literal>m</literal>=0,1,...,n. (emulated by mtlb_legendre) for + the <literal>X</literal> elements. + </para> + </listitem> + <listitem> + <para> + The option normflag= <literal>'sch'</literal> does not exist for + Scilab legendre (emulated) + </para> + </listitem> + <listitem> + <para> + If <literal>X</literal> is a hypermatrix then Scilab + <literal>legendre(n,X)</literal> does not work (emulated) + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_legendre(n,X[,normflag])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>legendre(n,X[,normflag])</literal> + when it was not possible to know what were the inputs while porting Matlab + code to Scilab. This function will determine the correct semantic at run + time. If you want to have a more efficient code it is possible to replace + <literal>mtlb_legendre</literal> call: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>X</literal> is a scalar, a vector or a matrix + <literal>mtlb_legendre(n,X[,'norm']) </literal>may be replaced by + <literal>legendre(n,0:n,X[,'norm'])</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_legendre</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_linspace.xml b/modules/compatibility_functions/help/en_US/mtlb_linspace.xml new file mode 100755 index 000000000..dbc63578d --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_linspace.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_linspace"> + <refnamediv> + <refname>mtlb_linspace</refname> + <refpurpose>Matlab linspace emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>linspace</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string inputs: Matlab <literal>linspace(A,B[,n])</literal> returns a character string vector if <literal>A</literal> + and/or <literal>B</literal> are character strings, but Scilab function does not work with such inputs. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_linspace(A,B[,n])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>linspace(A,B[,n])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_linspace</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are not character strings + <literal>mtlb_linspace(A,B[,n])</literal> may be replaced by <literal>linspace(A,B[,n])</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> or <literal>B</literal> are character strings + <literal>mtlb_linspace(A,B[,n])</literal> may be replaced by <literal>ascii(linspace(ascii(A),ascii(B)[,n]))</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_linspace</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ascii">ascii</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_logic.xml b/modules/compatibility_functions/help/en_US/mtlb_logic.xml new file mode 100755 index 000000000..55d3c1b1e --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_logic.xml @@ -0,0 +1,61 @@ +<?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="en" xml:id="mtlb_logic"> + <refnamediv> + <refname>mtlb_logic</refname> + <refpurpose>Matlab logical operators emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab logical operator behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With complex operands: The <literal><</literal>, <literal><=</literal>, <literal>></literal> and <literal>>=</literal> + operators can not be used into Scilab with complex operands, while + in Matlab they can. And in this case, only real part of complex operands is compared. + </para> + </listitem> + <listitem> + <para> + With empty matrices: If both operands of <literal><</literal>, <literal><=</literal>, + <literal>></literal> and <literal>>=</literal> + operators are empty matrices, Scilab returns an error message, while + Matlab returns an empty matrix. For operators <literal>==</literal> and <literal>~=</literal>, + if at least one operand is an empty matrix, Matlab returns [] while Scilab returns a boolean value %T or %F. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_logic(A,symbol,B)</literal> (with "symbol" a character string + containing the operator symbol) is used by + <literal>mfile2sci</literal> to replace <literal>A symbol B</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_logic</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If both <literal>A</literal> and <literal>B</literal> are not complex values nor empty matrices + <literal>mtlb_logic(A,symbol,B)</literal> may be replaced by <literal>A symbol B</literal>. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_logic</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_logical.xml b/modules/compatibility_functions/help/en_US/mtlb_logical.xml new file mode 100755 index 000000000..cf007b9f0 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_logical.xml @@ -0,0 +1,56 @@ +<?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="en" xml:id="mtlb_logical"> + <refnamediv> + <refname>mtlb_logical</refname> + <refpurpose>Matlab logical emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent function for Matlab <literal>logical</literal> but its behavior can be easyly reproduced. + </para> + <para> + The function <literal>mtlb_logical(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>logical(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_logical</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a boolean matrix + <literal>mtlb_logical(A)</literal> may be replaced by <literal>A</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not an empty matrix + <literal>mtlb_logical(A)</literal> may be replaced by <literal>A<>[]</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is an empty matrix + <literal>mtlb_logical(A)</literal> may be replaced by <literal>[]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_logical</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_lower.xml b/modules/compatibility_functions/help/en_US/mtlb_lower.xml new file mode 100755 index 000000000..88eea9338 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_lower.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_lower"> + <refnamediv> + <refname>mtlb_lower</refname> + <refpurpose>Matlab lower emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>lower(A)</literal> and Scilab <literal>convstr(A,"l")</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a chacarter string matrix: Matlab <literal>lower</literal> can be used with a + not-character-string <literal>A</literal> but not Scilab <literal>convstr</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_lower(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>lower(A)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_lower</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string matrix + <literal>mtlb_lower(A)</literal> may be replaced by <literal>convstr(A,"l")</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix + <literal>mtlb_lower(A)</literal> may be replaced by <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_lower</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="convstr">convstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_max.xml b/modules/compatibility_functions/help/en_US/mtlb_max.xml new file mode 100755 index 000000000..90eec163d --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_max.xml @@ -0,0 +1,94 @@ +<?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="en" xml:id="mtlb_max"> + <refnamediv> + <refname>mtlb_max</refname> + <refpurpose>Matlab max emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>max</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex values: Matlab <literal>max</literal> can be used with complex values but not Scilab function. + </para> + </listitem> + <listitem> + <para> + When called with one input: Matlab <literal>max</literal> threats values along the first + non-singleton dimension but Scilab threats all input values. + </para> + </listitem> + <listitem> + <para> + When called with two inputs: if one is an empty matrix, Scilab returns an error message but Matlab returns []. + </para> + </listitem> + <listitem> + <para> + When called with three inputs: if <literal>dim</literal> parameter is greater than number of + dimensions of first input, Scilab returns an error message and Matlab returns the first input. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>[r[,k]] = mtlb_max(A[,B[,dim]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>[r[,k]] = max(A[,B[,dim]])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_max</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a vector or a scalar + <literal>[r[,k]] = mtlb_max(A)</literal> may be replaced by <literal>max(A)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a matrix + <literal>[r[,k]] = mtlb_max(A)</literal> may be replaced by <literal>max(A,"r")</literal> + </para> + </listitem> + <listitem> + <para> + When called with two inputs, if <literal>A</literal> and <literal>B</literal> are real matrices and not empty matrices + <literal>[r[,k]] = mtlb_max(A,B)</literal> may be replaced by <literal>max(A,B)</literal> + </para> + </listitem> + <listitem> + <para> + When called with three inputs, if <literal>dim</literal> is lesser than the number of dimensions of <literal>A</literal> + <literal>[r[,k]] = mtlb_max(A,[],dim)</literal> may be replaced by <literal>max(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_max</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_min.xml b/modules/compatibility_functions/help/en_US/mtlb_min.xml new file mode 100755 index 000000000..ff819b1b6 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_min.xml @@ -0,0 +1,94 @@ +<?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="en" xml:id="mtlb_min"> + <refnamediv> + <refname>mtlb_min</refname> + <refpurpose>Matlab min emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>min</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex values: Matlab <literal>min</literal> can be used with complex values but not Scilab function. + </para> + </listitem> + <listitem> + <para> + When called with one input: Matlab <literal>min</literal> threats values along the first + non-singleton dimension but Scilab threats all input values. + </para> + </listitem> + <listitem> + <para> + When called with two inputs: if one is an empty matrix, Scilab returns an error message but Matlab returns []. + </para> + </listitem> + <listitem> + <para> + When called with three inputs: if <literal>dim</literal> parameter is greater than number of + dimensions of first input, Scilab returns an error message and Matlab returns the first input. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>[r[,k]] = mtlb_min(A[,B[,dim]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>[r[,k]] = min(A[,B[,dim]])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_min</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a vector or a scalar + <literal>[r[,k]] = mtlb_min(A)</literal> may be replaced by <literal>min(A)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a matrix + <literal>[r[,k]] = mtlb_min(A)</literal> may be replaced by <literal>min(A,"r")</literal> + </para> + </listitem> + <listitem> + <para> + When called with two inputs, if <literal>A</literal> and <literal>B</literal> are real matrices and not empty matrices + <literal>[r[,k]] = mtlb_min(A,B)</literal> may be replaced by <literal>min(A,B)</literal> + </para> + </listitem> + <listitem> + <para> + When called with three inputs, if <literal>dim</literal> is lesser than the number of dimensions of <literal>A</literal> + <literal>[r[,k]] = mtlb_min(A,[],dim)</literal> may be replaced by <literal>min(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_min</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_mode.xml b/modules/compatibility_functions/help/en_US/mtlb_mode.xml new file mode 100755 index 000000000..31db33177 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_mode.xml @@ -0,0 +1,82 @@ +<?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="mtlb_mode"> + <refnamediv> + <refname>mtlb_mode</refname> + <refpurpose>switch Matlab like operations</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mmode = mtlb_mode() + mtlb_mode(mmode) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>mmode</term> + <listitem> + <para>boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Scilab and Matlab additions and subtractions work differently + when used with empty matrices: + </para> + <variablelist> + <varlistentry> + <term>Scilab</term> + <listitem> + <para></para> + <programlisting role = ""><![CDATA[ +a=1; +a+[] +// -->a + + +a-[] +// -->a + + +[]+a +// -->a + + +[]-a +// -->-a + ]]></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Matlab</term> + <listitem> + <programlisting role = "no-scilab-exec"><![CDATA[ +a+[] -->[] +a-[] -->[] +[]+a -->[] +[]-a -->[] + ]]></programlisting> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>mtlb_mode(%t)</code> switches to Matlab evaluation mode for additions and + subtractions. <code>mtlb_mode(%f)</code> switches back to Scilab mode. + </para> + <para> + <code>mtlb_mode()</code> returns the current <varname>mmode</varname>' value (<constant>%t</constant>=Matlab, <constant>%f</constant>=Scilab). + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="empty">empty</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_more.xml b/modules/compatibility_functions/help/en_US/mtlb_more.xml new file mode 100755 index 000000000..f848039a4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_more.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) 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="en" xml:id="mtlb_more"> + <refnamediv> + <refname>mtlb_more</refname> + <refpurpose>Matlab more emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>more</literal> and Scilab <literal>lines</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character strings as input: Matlab <literal>more</literal> can take "on" + and "off" as input but not Scilab <literal>lines</literal> but there are equivalents (0 and 60). + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_more(in)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>more(in)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_more</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>in</literal> is equal to "on" + <literal>mtlb_more(in)</literal> may be replaced by <literal>lines(60)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>in</literal> is equal to "off" + <literal>mtlb_more(in)</literal> may be replaced by <literal>lines(0)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>in</literal> is a double value + <literal>mtlb_more(in)</literal> may be replaced by <literal>lines(in)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_more</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_num2str.xml b/modules/compatibility_functions/help/en_US/mtlb_num2str.xml new file mode 100755 index 000000000..ea193da74 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_num2str.xml @@ -0,0 +1,69 @@ +<?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="en" xml:id="mtlb_num2str"> + <refnamediv> + <refname>mtlb_num2str</refname> + <refpurpose>Matlab num2str emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>num2str</literal> and Scilab equivalents (<literal>string</literal>, <literal>msprintf</literal>) behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With two input parameters, the second giving precision: There is no Scilab equivalent function, but + <literal>msprintf</literal> can be used to emulate. + </para> + </listitem> + <listitem> + <para> + With two input parameters, the second giving format: Scilab equivalent for Matlab + <literal>num2string(a,format)</literal> is <literal>msprintf(format,a)</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_num2str(x,f)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>num2str(x,f)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_num2str</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>f</literal> is a character string + <literal>mtlb_num2str(x,f)</literal> may be replaced by <literal>msprintf(f,x)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_num2str</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="msprintf">msprintf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_ones.xml b/modules/compatibility_functions/help/en_US/mtlb_ones.xml new file mode 100755 index 000000000..b11c56694 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_ones.xml @@ -0,0 +1,57 @@ +<?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="en" xml:id="mtlb_ones"> + <refnamediv> + <refname>mtlb_ones</refname> + <refpurpose>Matlab ones emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>ones</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>ones</literal> returns a n x n matrix while Scilab returns a 1. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_ones(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>ones(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_ones</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_ones(A)</literal> may be replaced by <literal>ones(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_ones(A)</literal> may be replaced by <literal>ones(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_ones</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_plot.xml b/modules/compatibility_functions/help/en_US/mtlb_plot.xml new file mode 100755 index 000000000..a4c066957 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_plot.xml @@ -0,0 +1,65 @@ +<?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="en" xml:id="mtlb_plot"> + <refnamediv> + <refname>mtlb_plot</refname> + <refpurpose>Matlab plot emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>plot</literal> and Scilab <literal>plot2d</literal> behave differently. + </para> + <para> + The function <literal>mtlb_plot(varargin)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>plot(varargin)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_plot</literal> calls when there is no output value, + however in this case, you have to set colors manualy: + </para> + <itemizedlist> + <listitem> + <para> + With one input, if <literal>Y</literal> is real, + <literal>mtlb_plot(Y)</literal> may be replaced by <literal>plot2d(Y)</literal> + </para> + </listitem> + <listitem> + <para> + With one input, if <literal>Y</literal> is complex, + <literal>mtlb_plot(Y)</literal> may be replaced by <literal>plot2d(real(Y),imag(Y))</literal> + </para> + </listitem> + <listitem> + <para> + With two inputs <literal>X</literal> and <literal>Y</literal>, if <literal>Y</literal> is not a character string, + <literal>mtlb_plot(X,Y)</literal> may be replaced by <literal>plot2d(X,Y)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_plot</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="plot2d">plot2d</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_prod.xml b/modules/compatibility_functions/help/en_US/mtlb_prod.xml new file mode 100755 index 000000000..ba1b0e761 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_prod.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) 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="en" xml:id="mtlb_prod"> + <refnamediv> + <refname>mtlb_prod</refname> + <refpurpose>Matlab prod emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>prod</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input: Matlab <literal>prod</literal> threts the values along the first + non-singleton dimension of input while Scilab <literal>prod</literal> threats all values of input. + </para> + </listitem> + <listitem> + <para> + When called with two inputs: Matlab <literal>prod</literal> can be used with second input giving + a non-existing dimension of first input while Scilab <literal>prod</literal> returns an error message. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_prod(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>prod(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_prod</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input, if <literal>A</literal> is an empty matrix, a scalar or a vector, + <literal>mtlb_prod(A)</literal> may be replaced by <literal>prod(A)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a not-empty matrix, + <literal>mtlb_prod(A)</literal> may be replaced by <literal>prod(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a multidimensional array, + <literal>mtlb_prod(A)</literal> may be replaced by <literal>prod(A,firstnonsingleton(A))</literal> + </para> + </listitem> + <listitem> + <para> + When called with two inputs, if <literal>dim</literal> is lesser than the number of dimensions of <literal>A</literal> + <literal>mtlb_prod(A,dim)</literal> may be replaced by <literal>prod(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_prod</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_rand.xml b/modules/compatibility_functions/help/en_US/mtlb_rand.xml new file mode 100755 index 000000000..bb9793ba2 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_rand.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_rand"> + <refnamediv> + <refname>mtlb_rand</refname> + <refpurpose>Matlab rand emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>rand</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>rand</literal> returns a n x n matrix + while Scilab returns a scalar. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_rand(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>rand(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_rand</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_rand(A)</literal> may be replaced by <literal>rand(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_rand(A)</literal> may be replaced by <literal>rand(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_rand</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_randn.xml b/modules/compatibility_functions/help/en_US/mtlb_randn.xml new file mode 100755 index 000000000..739ef2ac7 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_randn.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_randn"> + <refnamediv> + <refname>mtlb_randn</refname> + <refpurpose>Matlab randn emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>rand</literal> and Scilab <literal>rand(...,"normal")</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>randn</literal> returns a n x n matrix + while Scilab <literal>rand(...,"normal")</literal> returns a scalar. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_randn(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>randn(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_randn</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_randn(A)</literal> may be replaced by <literal>rand(A,A,"normal")</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_randn(A)</literal> may be replaced by <literal>rand(A,"normal")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_randn</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_rcond.xml b/modules/compatibility_functions/help/en_US/mtlb_rcond.xml new file mode 100755 index 000000000..4d6fdb056 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_rcond.xml @@ -0,0 +1,52 @@ +<?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="en" xml:id="mtlb_rcond"> + <refnamediv> + <refname>mtlb_rcond</refname> + <refpurpose>Matlab rcond emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>rcond</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With empty matrix: Matlab <literal>rcond</literal> returns <literal>Inf</literal> and + Scilab <literal>rcond</literal> returns <literal>[]</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_rcond(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>rcond(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_rcond</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not an empty matrix, + <literal>mtlb_rcond(A)</literal> may be replaced by <literal>rcond(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_rcond</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_realmax.xml b/modules/compatibility_functions/help/en_US/mtlb_realmax.xml new file mode 100755 index 000000000..7a2587834 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_realmax.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_realmax"> + <refnamediv> + <refname>mtlb_realmax</refname> + <refpurpose>Matlab realmax emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Scilab equivalent for Matlab <literal>realmax</literal> is + <literal>number_properties</literal> but not all cases are implemented: + </para> + <itemizedlist> + <listitem> + <para> + Scilab equivalent for Matlab <literal>realmax</literal> or + <literal>realmax('double')</literal> is <literal>number_properties("huge")</literal>. + </para> + </listitem> + <listitem> + <para> + There is no Scilab equivalent for Matlab <literal>realmax('single')</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_realmax(prec)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>realmax(prec)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_realmax</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>prec</literal> is equal to <literal>"double"</literal> + <literal>mtlb_realmax(prec)</literal> may be replaced by <literal>number_properties("huge")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_realmax</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="number_properties">number_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_realmin.xml b/modules/compatibility_functions/help/en_US/mtlb_realmin.xml new file mode 100755 index 000000000..d4eb982f9 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_realmin.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_realmin"> + <refnamediv> + <refname>mtlb_realmin</refname> + <refpurpose>Matlab realmin emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Scilab equivalent for Matlab <literal>realmin</literal> is + <literal>number_properties</literal> but not all cases are implemented: + </para> + <itemizedlist> + <listitem> + <para> + Scilab equivalent for Matlab <literal>realmin</literal> or + <literal>realmin('double')</literal> is <literal>number_properties("tiny")</literal>. + </para> + </listitem> + <listitem> + <para> + There is no Scilab equivalent for Matlab <literal>realmin('single')</literal> + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_realmin(prec)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>realmin(prec)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_realmin</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>prec</literal> is equal to <literal>"double"</literal> + <literal>mtlb_realmin(prec)</literal> may be replaced by <literal>number_properties("tiny")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_realmin</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="number_properties">number_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_s.xml b/modules/compatibility_functions/help/en_US/mtlb_s.xml new file mode 100755 index 000000000..2445ea4cf --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_s.xml @@ -0,0 +1,83 @@ +<?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="en" xml:id="mtlb_s"> + <refnamediv> + <refname>mtlb_s</refname> + <refpurpose>Matlab subtraction emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab subtraction behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With character string operands: The <literal>-</literal> + operator can not be used into Scilab with character strings, while + Matlab realizes the subtraction of the operands ASCII codes. + </para> + </listitem> + <listitem> + <para> + With empty matrix: In Scilab, if one of the + operands is an empty matrix the result of the subtraction is the + other operand. In Matlab if one of the operand is an empty + matrix the result of the subtraction should be an error or an empty + matrix. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_s(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A-B</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_s</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are character strings, + <literal>mtlb_s(A,B)</literal> may be replaced by <literal>asciimat(A)-asciimat(B)</literal> + </para> + </listitem> + <listitem> + <para> + If both <literal>A</literal> and <literal>B</literal> are not empty matrices + <literal>mtlb_s(A,B)</literal> may be replaced by <literal>A-B</literal>, + else <literal>mtlb_s(A,B)</literal> may be replaced by + <literal>[]</literal>. + </para> + </listitem> + <listitem> + <para> + If mtlb_mode()==%T, then <literal>mtlb_s(A,B)</literal> + may be replaced by <literal>A-B</literal> in any case where + <literal>A</literal> and <literal>B</literal> are not character string matrices. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_s</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mtlb_mode">mtlb_mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_setstr.xml b/modules/compatibility_functions/help/en_US/mtlb_setstr.xml new file mode 100755 index 000000000..e333007ff --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_setstr.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_setstr"> + <refnamediv> + <refname>mtlb_setstr</refname> + <refpurpose>Matlab setstr emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>setstr</literal> and Scilab <literal>ascii</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With character string input: Matlab <literal>setstr</literal> returns a character string + while Scilab <literal>ascii</literal> returns ASCII codes. + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + With double matrix input: Matlab <literal>setstr</literal> returns a character matrix + having the same size as input while Scilab <literal>ascii</literal> returns a single character string + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_setstr(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>setstr(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_setstr</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string or a character string matrix + <literal>mtlb_setstr(A)</literal> may be replaced by <literal>A</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is a double row vector + <literal>mtlb_setstr(A)</literal> may be replaced by <literal>ascii(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_setstr</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_size.xml b/modules/compatibility_functions/help/en_US/mtlb_size.xml new file mode 100755 index 000000000..be592e8e4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_size.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_size"> + <refnamediv> + <refname>mtlb_size</refname> + <refpurpose>Matlab size emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>size</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With two inputs: Matlab <literal>size</literal> can be used with second parameter giving + a not-existing dimension of first parameter (returns 1 in this case) but not Scilab one. + </para> + </listitem> + <listitem> + <para> + With more than one output: if number of output is lesser than number of dimensions, + last output is the product of all remaining dimensions in Matlab but not in Scilab. + If number of output is greater than number of dimensions, outputs corresponding to a + not-existing dimension are set to 1 in Matlab but Scilab gives an error in this case. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>[d1,[d2,...]] = mtlb_size(X[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>[d1,[d2,...]] = size(X[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_size</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + With two inputs: if <literal>dim</literal> gives an existing dimension of <literal>X</literal> + <literal>mtlb_size(X,dim)</literal> may be replaced by <literal>size(X,dim)</literal> + </para> + </listitem> + <listitem> + <para> + With more than one outputs: if the number of outputs is equal to the number of dimensions of <literal>X</literal> + <literal>[d1,[d2,...]] = mtlb_size(X)</literal> may be replaced by <literal>[d1,[d2,...]] = size(X)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_size</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_sort.xml b/modules/compatibility_functions/help/en_US/mtlb_sort.xml new file mode 100755 index 000000000..4340ce28e --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_sort.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_sort"> + <refnamediv> + <refname>mtlb_sort</refname> + <refpurpose>Matlab sort emulation + function + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>P = mtlb_sort(X) + P = mtlb_sort(X,dim[,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>a scalar, vector, matrix of reals, booleans or a string</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>dim</term> + <listitem> + <para>a positive scalar integer</para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para>a string ("ascend" or "descend")</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Matlab <literal>sort</literal> and Scilab <literal>gsort</literal> behave + differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + For a vector <literal>X</literal> the Matlab + <literal>sort(X,'g','i')</literal> function call is equivalent to the + Scilab <literal>gsort(X)</literal> function call. + </para> + </listitem> + <listitem> + <para> + The value <literal>1</literal> (resp. <literal>2</literal>) of the Matlab + dim is equivalent to the Scilab <literal>"r"</literal> flag (resp. + <literal>"c"</literal>). + </para> + </listitem> + <listitem> + <para> + The Matlab "<literal>ascend"</literal> (resp. + <literal>"descend"</literal>) mode is equivalent to the Scilab + <literal>"i"</literal> (resp. <literal>"d"</literal>) flag. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_sort(X[,dim[,mode]])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>sort(X[,dim[,mode]])</literal> when + it was not possible to know what were the inputs while porting Matlab code + to Scilab. This function will determine the correct semantic at run time. + If you want to have a more efficient code it is possible to replace + <literal>mtlb_sort</literal> call by <link linkend="gsort">gsort</link> call. + </para> + <para> + <warning> + Caution: <literal>mtlb_sort</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_strcmp.xml b/modules/compatibility_functions/help/en_US/mtlb_strcmp.xml new file mode 100755 index 000000000..0d0433148 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_strcmp.xml @@ -0,0 +1,50 @@ +<?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="en" xml:id="mtlb_strcmp"> + <refnamediv> + <refname>mtlb_strcmp</refname> + <refpurpose>Matlab strcmp emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab function equivalent for Matlab <literal>strcmp</literal>, there is equivalent instructions. + </para> + <para> + The function <literal>mtlb_strcmp(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>strcmp(A,B)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_strcmp</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are character strings + <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>A==B</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> and/or <literal>B</literal> is not a character string + <literal>mtlb_strcmp(A,B)</literal> may be replaced by <literal>0</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_strcmp</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_strcmpi.xml b/modules/compatibility_functions/help/en_US/mtlb_strcmpi.xml new file mode 100755 index 000000000..4ad99575a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_strcmpi.xml @@ -0,0 +1,50 @@ +<?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="en" xml:id="mtlb_strcmpi"> + <refnamediv> + <refname>mtlb_strcmpi</refname> + <refpurpose>Matlab strcmpi emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab function equivalent for Matlab <literal>strcmpi</literal>, there is equivalent instructions. + </para> + <para> + The function <literal>mtlb_strcmpi(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>strcmpi(A,B)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_strcmpi</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are character strings + <literal>mtlb_strcmpi(A,B)</literal> may be replaced by <literal>convstr(A)==convstr(B)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> and/or <literal>B</literal> is not a character string + <literal>mtlb_strcmpi(A,B)</literal> may be replaced by <literal>0</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_strcmpi</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_strfind.xml b/modules/compatibility_functions/help/en_US/mtlb_strfind.xml new file mode 100755 index 000000000..50b7afe5a --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_strfind.xml @@ -0,0 +1,52 @@ +<?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="en" xml:id="mtlb_strfind"> + <refnamediv> + <refname>mtlb_strfind</refname> + <refpurpose>Matlab strfind emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>strfind</literal> and Scilab <literal>strindex</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With inputs which not character strings: Matlab <literal>strfind</literal> can be used + with not character strings inputs but not Scilab <literal>strindex</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_strfind(A,B)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>strfind(A,B)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_strfind</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> and <literal>B</literal> are character strings + <literal>mtlb_strfind(A,B)</literal> may be replaced by <literal>strindex(A,B)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_strfind</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_strrep.xml b/modules/compatibility_functions/help/en_US/mtlb_strrep.xml new file mode 100755 index 000000000..68b94d3c4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_strrep.xml @@ -0,0 +1,52 @@ +<?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="en" xml:id="mtlb_strrep"> + <refnamediv> + <refname>mtlb_strrep</refname> + <refpurpose>Matlab strrep emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>strrep</literal> and Scilab <literal>strsubst</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With inputs which not character strings: Matlab <literal>strrep</literal> can be used + with not character strings inputs but not Scilab <literal>strsubst</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_strrep(A,B,C)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>strrep(A,B,C)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_strrep</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal>, <literal>B</literal> and <literal>C</literal> are character strings + <literal>mtlb_strrep(A,B,C)</literal> may be replaced by <literal>strsubst(A,B,C)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_strrep</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_sum.xml b/modules/compatibility_functions/help/en_US/mtlb_sum.xml new file mode 100755 index 000000000..fad5f006e --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_sum.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) 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="en" xml:id="mtlb_sum"> + <refnamediv> + <refname>mtlb_sum</refname> + <refpurpose>Matlab sum emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>sum</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input: Matlab <literal>sum</literal> threts the values along the first + non-singleton dimension of input while Scilab <literal>sum</literal> threats all values of input. + </para> + </listitem> + <listitem> + <para> + When called with two inputs: Matlab <literal>sum</literal> can be used with second input giving + a non-existing dimension of first input while Scilab <literal>sum</literal> returns an error message. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_sum(A[,dim])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>sum(A[,dim])</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_sum</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input, if <literal>A</literal> is an empty matrix, a scalar or a vector, + <literal>mtlb_sum(A)</literal> may be replaced by <literal>sum(A)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a not-empty matrix, + <literal>mtlb_sum(A)</literal> may be replaced by <literal>sum(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + When called with one input, if <literal>A</literal> is a multidimensional array, + <literal>mtlb_sum(A)</literal> may be replaced by <literal>sum(A,firstnonsingleton(A))</literal> + </para> + </listitem> + <listitem> + <para> + When called with two inputs, if <literal>dim</literal> is lesser than the number of dimensions of <literal>A</literal> + <literal>mtlb_sum(A,dim)</literal> may be replaced by <literal>sum(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_sum</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_t.xml b/modules/compatibility_functions/help/en_US/mtlb_t.xml new file mode 100755 index 000000000..6be1dad19 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_t.xml @@ -0,0 +1,58 @@ +<?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="en" xml:id="mtlb_t"> + <refnamediv> + <refname>mtlb_t</refname> + <refpurpose>Matlab transposition emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Matlab and Scilab transposition behave differently in some particular cases:</para> + <itemizedlist> + <listitem> + <para> + With character strings operands: The <literal>'</literal> operator is used to transpose whole + character strings in Scilab while Matlab realizes the transposition of each character. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_t(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>A'</literal> when it was not + possible to know what were the operands while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_t</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix + <literal>mtlb_t(A)</literal> may be replaced by <literal>A'</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_t</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_toeplitz.xml b/modules/compatibility_functions/help/en_US/mtlb_toeplitz.xml new file mode 100755 index 000000000..fc9114857 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_toeplitz.xml @@ -0,0 +1,65 @@ +<?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="en" xml:id="mtlb_toeplitz"> + <refnamediv> + <refname>mtlb_toeplitz</refname> + <refpurpose>Matlab toeplitz emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>toeplitz</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With one input parameter: if this parameter is complex or is a matrix, output value of + Matlab and Scilab <literal>toeplitz</literal> can be different. + </para> + </listitem> + <listitem> + <para> + With two input parameters: if they are vectors and their first elements are not equal, + Scilab returns an error but Matlab gives priority to the column element. If they are matrices, output value of + Matlab and Scilab <literal>toeplitz</literal> are different. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_toeplitz(c[,r])</literal> is used by + <literal>mfile2sci</literal> to replace <literal>toeplitz(c[,r])</literal> when it was not + possible to know what were the operands/inputs[CUSTOM] while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_toeplitz</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + When called with one input, if <literal>c</literal> is a real scalar or vector + <literal>mtlb_toeplitz(c)</literal> may be replaced by <literal>toeplitz(c)</literal> + </para> + </listitem> + <listitem> + <para> + When called with two inputs, if <literal>c</literal> and <literal>r</literal> are scalars or vectors and their first elements are equal + <literal>mtlb_toeplitz(c,r)</literal> may be replaced by <literal>toeplitz(c,r)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_toeplitz</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_tril.xml b/modules/compatibility_functions/help/en_US/mtlb_tril.xml new file mode 100755 index 000000000..aa74b3d23 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_tril.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) 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="en" xml:id="mtlb_tril"> + <refnamediv> + <refname>mtlb_tril</refname> + <refpurpose>Matlab tril emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>tril</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>tril</literal> can be used with complex data but not Scilab one. + </para> + </listitem> + <listitem> + <para> + With character strings inputs: due to the fact the Matlab and Scilab do not consider character + strings in the same way, Scilab and Matlab <literal>tril</literal> do not give the same results + for this type of input. + </para> + </listitem> + <listitem> + <para> + With boolean inputs: Matlab <literal>tril</literal> can be used with boobean data but not Scilab one. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_tril(x,k)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>tril(x,k)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_tril</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>X</literal> contains real double values + <literal>mtlb_tril(x,k)</literal> may be replaced by <literal>tril(x,k)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>X</literal> contains boolean values + <literal>mtlb_tril(x,k)</literal> may be replaced by <literal>tril(bool2s(x),k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_tril</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_triu.xml b/modules/compatibility_functions/help/en_US/mtlb_triu.xml new file mode 100755 index 000000000..ce779eae8 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_triu.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) 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="en" xml:id="mtlb_triu"> + <refnamediv> + <refname>mtlb_triu</refname> + <refpurpose>Matlab triu emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>triu</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>triu</literal> can be used with complex data but not Scilab one. + </para> + </listitem> + <listitem> + <para> + With character strings inputs: due to the fact the Matlab and Scilab do not consider character + strings in the same way, Scilab and Matlab <literal>triu</literal> do not give the same results + for this type of input. + </para> + </listitem> + <listitem> + <para> + With boolean inputs: Matlab <literal>triu</literal> can be used with boobean data but not Scilab one. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_triu(x,k)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>triu(x,k)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_triu</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>X</literal> contains real double values + <literal>mtlb_triu(x,k)</literal> may be replaced by <literal>triu(x,k)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>X</literal> contains boolean values + <literal>mtlb_triu(x,k)</literal> may be replaced by <literal>triu(bool2s(x),k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_triu</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_true.xml b/modules/compatibility_functions/help/en_US/mtlb_true.xml new file mode 100755 index 000000000..3e002933e --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_true.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) 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="en" xml:id="mtlb_true"> + <refnamediv> + <refname>mtlb_true</refname> + <refpurpose>Matlab true emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + There is no Scilab equivalent for Matlab <literal>true</literal>. However, Scilab <literal>ones</literal> + returns a result interpreted in an equivalent way for Scilab. + </para> + <para> + Matlab <literal>true</literal> and Scilab <literal>ones</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>true</literal> returns a n x n matrix of ones + while Scilab <literal>ones</literal> returns a 1. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_true(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>true(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_true</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_true(A)</literal> may be replaced by <literal>ones(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_true(A)</literal> may be replaced by <literal>ones(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_true</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_uint16.xml b/modules/compatibility_functions/help/en_US/mtlb_uint16.xml new file mode 100755 index 000000000..a73b730fd --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_uint16.xml @@ -0,0 +1,56 @@ +<?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="en" xml:id="mtlb_uint16"> + <refnamediv> + <refname>mtlb_uint16</refname> + <refpurpose>Matlab uint16 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>uint16</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>uint16</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>uint16</literal> returns 65535 and Scilab returns 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_uint16(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>uint16(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_uint16</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal> values + <literal>mtlb_uint16(A)</literal> may be replaced by <literal>uint16(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_uint16</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_uint32.xml b/modules/compatibility_functions/help/en_US/mtlb_uint32.xml new file mode 100755 index 000000000..7efaaeb69 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_uint32.xml @@ -0,0 +1,56 @@ +<?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="en" xml:id="mtlb_uint32"> + <refnamediv> + <refname>mtlb_uint32</refname> + <refpurpose>Matlab uint32 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>uint32</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>uint32</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>uint32</literal> returns 4294967295 and Scilab returns 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_uint32(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>uint32(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_uint32</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal> values + <literal>mtlb_uint32(A)</literal> may be replaced by <literal>uint32(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_uint32</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_uint8.xml b/modules/compatibility_functions/help/en_US/mtlb_uint8.xml new file mode 100755 index 000000000..bbc493477 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_uint8.xml @@ -0,0 +1,56 @@ +<?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="en" xml:id="mtlb_uint8"> + <refnamediv> + <refname>mtlb_uint8</refname> + <refpurpose>Matlab uint8 emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>uint8</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With complex input: Matlab <literal>uint8</literal> can be used with complex values what Scilab function can not. + </para> + </listitem> + <listitem> + <para> + With <literal>%inf</literal>: Matlab <literal>uint8</literal> returns 255 and Scilab returns 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_uint8(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>uint8(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_uint8</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> does not contain <literal>%inf</literal> values + <literal>mtlb_uint8(A)</literal> may be replaced by <literal>uint8(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_uint8</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_upper.xml b/modules/compatibility_functions/help/en_US/mtlb_upper.xml new file mode 100755 index 000000000..0a48e7e83 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_upper.xml @@ -0,0 +1,66 @@ +<?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="en" xml:id="mtlb_upper"> + <refnamediv> + <refname>mtlb_upper</refname> + <refpurpose>Matlab upper emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab <literal>upper(A)</literal> and Scilab <literal>convstr(A,"u")</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is not a chacarter string matrix: Matlab <literal>upper</literal> can be used with a + not-character-string <literal>A</literal> but not Scilab <literal>convstr</literal>. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_upper(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>upper(A)</literal> when it was not + possible to know what were the inputs while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_upper</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a character string matrix + <literal>mtlb_upper(A)</literal> may be replaced by <literal>convstr(A,"u")</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a character string matrix + <literal>mtlb_upper(A)</literal> may be replaced by <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_upper</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="convstr">convstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_var.xml b/modules/compatibility_functions/help/en_US/mtlb_var.xml new file mode 100755 index 000000000..fd2f52626 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_var.xml @@ -0,0 +1,119 @@ +<?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="en" xml:id="mtlb_var"> + <refnamediv> + <refname>mtlb_var</refname> + <refpurpose>Matlab var emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a real or a complex vector or matrix.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para>a real scalar or real vector.</para> + <itemizedlist> + <listitem> + <para>If x is a vector, s is the variance of x.</para> + </listitem> + <listitem> + <para>If x is a matrix, s is a row vector containing the variance of each column of x.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>w</term> + <listitem> + <para>type of normalization to use. Valid values are, depending on the number of columns m of x :</para> + <itemizedlist> + <listitem> + <para>w = 0 : normalizes with m-1, provides the best unbiased estimator of the variance (this is the default).</para> + </listitem> + <listitem> + <para>w = 1: normalizes with m, this provides the second moment around the mean. </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>dim</term> + <listitem> + <para>the dimension along which the variance is computed (default is 1, i.e. column by column). + If dim is 2, the variance is computed row by row. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This function computes the variance of the values of a vector or matrix x. + It provides the same service as Octave and Matlab. + It differs from Scilab's variance primitive: + </para> + <itemizedlist> + <listitem> + <para>mtlb_var returns a real (i.e. with a zero imaginary part) variance, + even if x is a complex vector or matrix. The Scilab variance + primitive returns a complex value if the input vector x is complex and + if no option additional is used. + </para> + </listitem> + <listitem> + <para>Whatever the type of the input data x (i.e. vector or matrix), + mtlb_var computes the variance either on dimension 1 or on dimension 2 while, + if no option is passed to the Scilab's variance primitive, the variance is computed + on all dimension at once. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Examples</title> + <para>The following 3 examples illustrates the use of the mtlb_var function. + In the first case, a column vector is passed to the function, which returns the value 750. + In the second case, a matrix is passed to the function, which returns the row vector + [0.16 0.09]. + In the third case, a complex column vector is passed to the function, which + returns a value close to 2. + </para> + <programlisting role="example"><![CDATA[ +x = [10; 20; 30; 40; 50; 60; 70; 80; 90]; +computed = mtlb_var(x); + +x = [0.9 0.7 + 0.1 0.1 + 0.5 0.4]; +computed = mtlb_var(x); + +N=1000; +x = grand(N,1,'nor',0,1) + %i*grand(N,1,'nor',0,1); +computed = mtlb_var(x); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="variance">variance</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/en_US/mtlb_zeros.xml b/modules/compatibility_functions/help/en_US/mtlb_zeros.xml new file mode 100755 index 000000000..cacf5b3f4 --- /dev/null +++ b/modules/compatibility_functions/help/en_US/mtlb_zeros.xml @@ -0,0 +1,57 @@ +<?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="en" xml:id="mtlb_zeros"> + <refnamediv> + <refname>mtlb_zeros</refname> + <refpurpose>Matlab zeros emulation function</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Matlab and Scilab <literal>zeros</literal> behave differently in some particular cases: + </para> + <itemizedlist> + <listitem> + <para> + With a scalar input: Matlab <literal>zeros</literal> returns a n x n matrix while Scilab returns a 0. + </para> + </listitem> + </itemizedlist> + <para> + The function <literal>mtlb_zeros(A)</literal> is used by + <literal>mfile2sci</literal> to replace <literal>zeros(A)</literal> when it was not + possible to know what was the input while porting Matlab code to Scilab. This function will + determine the correct semantic at run time. If you want to have a + more efficient code it is possible to replace <literal>mtlb_zeros</literal> calls: + </para> + <itemizedlist> + <listitem> + <para> + If <literal>A</literal> is a scalar + <literal>mtlb_zeros(A)</literal> may be replaced by <literal>zeros(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + If <literal>A</literal> is not a scalar + <literal>mtlb_zeros(A)</literal> may be replaced by <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Caution: <literal>mtlb_zeros</literal> has not to be used for hand coded functions. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/addchapter.sce b/modules/compatibility_functions/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..b27802bb1 --- /dev/null +++ b/modules/compatibility_functions/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("Fonctions de compatibilité",SCI+"/modules/compatibility_functions/help/fr_FR",%T); + diff --git a/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml b/modules/compatibility_functions/help/fr_FR/firstnonsingleton.xml new file mode 100755 index 000000000..e56bcdb3a --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/firstnonsingleton.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) 2002-2004 - 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="firstnonsingleton"> + <refnamediv> + <refname>firstnonsingleton</refname> + <refpurpose>Trouve la première dimension qui n'est pas 1</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>dim</term> + <listitem> + <para>première dimension de A qui n'est pas 1</para> + </listitem> + </varlistentry> + <varlistentry> + <term>A</term> + <listitem> + <para>une variable de n'importe quel type de donnée Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>une chaîne de caractères qui précise le type de la variable de sortie que l'on veut</para> + <variablelist> + <varlistentry> + <term>"num"</term> + <listitem> + <para>la valeur retournée est une valeur numérique</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"str"</term> + <listitem> + <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> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Cette fonction est utilisée par <literal>mfile2sci</literal> pour émuler le comportement de Matlab sous Scilab, + en particulier pour les fonctions qui traitent les valeurs suivant la première dimension de A qui n'est pas 1 + en Matlab alors que dans Scilab elles traitent toutes les valeurs de A. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +A = [1 2 3;4 5 6]; +// max Scilab +M = max(A) +// Emulation du max Matlab +M = max(A,firstnonsingleton(A)) + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mstr2sci.xml b/modules/compatibility_functions/help/fr_FR/mstr2sci.xml new file mode 100755 index 000000000..09db1869c --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mstr2sci.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mstr2sci"> + <refnamediv> + <refname>mstr2sci</refname> + <refpurpose>conversion d'une matrice de chaînes en matrice de caractères</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>a=mstr2sci(txt)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>txt</term> + <listitem> + <para>chaîne de caractères ou matrice de chaînes</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a</term> + <listitem> + <para>vecteur ou matrice de caractères</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Cette fonction convertit une chaîne de caractères Scilab en vecteur de caractères. + Le résultat est l'équivalent pour Scilab d'une chaîne de caractères Matlab. + </para> + <para> + <warning> + Attention : <literal>mstr2sci</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_0.xml b/modules/compatibility_functions/help/fr_FR/mtlb_0.xml new file mode 100755 index 000000000..644eb85de --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_0.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_0"> + <refnamediv> + <refname>mtlb_0</refname> + <refpurpose>Fonction d'émulation de la transposition non-conjuguée de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, la transposition non-conjuguée se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes de type chaîne de caractère : L'opérateur <literal>.'</literal> est utilisé dans Scilab + pour transposer des chaînes de caractères entières alors que Matlab fait la transposition caractère par caractère. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_0(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A.'</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_0</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères + <literal>mtlb_0(A)</literal> peut être remplacé par <literal>A.'</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_0</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_a.xml b/modules/compatibility_functions/help/fr_FR/mtlb_a.xml new file mode 100755 index 000000000..20f80cf41 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_a.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_a"> + <refnamediv> + <refname>mtlb_a</refname> + <refpurpose>Fonction d'émulation de l'addition Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, l'addition se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes de type chaîne de caractères : L'opérateur <literal>+</literal> + est utilisé dans Scilab pour concaténer des chaînes de caractères alors que + Matlab calcule la somme des codes ASCII des opérandes. + </para> + </listitem> + <listitem> + <para> + Avec une matrice vide : Dans Scilab, si une des + opérandes est une matrice vide alors le résultat de l'addition est + l'autre opérande. Dans Matlab si une des opérandes est une matrice + vide alors le résultat de l'addition est soit une erreur (la seconde opérande n'est pas un scalaire) + soit une matrice vide. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_a(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A+B</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_a</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des chaînes de caractères, + <literal>mtlb_a(A,B)</literal> peut être remplacé par <literal>asciimat(A)+asciimat(B)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> ne sont pas des matrices vides + <literal>mtlb_a(A,B)</literal> peut être remplacé par <literal>A+B</literal>, + sinon <literal>mtlb_a(A,B)</literal> peut être remplacé par + <literal>[]</literal>. + </para> + </listitem> + <listitem> + <para> + Si mtlb_mode()==%T, alors <literal>mtlb_a(A,B)</literal> + peut être remplacé par <literal>A+B</literal> dans tous les cas où + <literal>A</literal> et <literal>B</literal> ne sont pas des chaînes de caractères. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_a</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mtlb_mode">mtlb_mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_all.xml b/modules/compatibility_functions/help/fr_FR/mtlb_all.xml new file mode 100755 index 000000000..be917dc99 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_all.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_all"> + <refnamediv> + <refname>mtlb_all</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab all</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, les fonctions <literal>all</literal> de Matlab et + <literal>and</literal> de Scilab se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec un argument d'entrée (<literal>all(A)</literal>), la fonction <literal>all</literal> de Matlab traite + les valeurs selon la première dimension de A qui n'est pas 1 comme un vecteur + alors que Scilab traite toutes les valeurs de A. + </para> + </listitem> + <listitem> + <para> + Avec deux arguments d'entrée (<literal>all(A,dim)</literal>), Matlab + tolère une valeur de <literal>dim</literal> supérieure au + nombre de dimensions de A alors que Scilab renvoie un message d'erreur dans ce cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_all(A[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>all(A[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_all</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire ou un vecteur + <literal>R = mtlb_all(A)</literal> peut être remplacé par <literal>R = and(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice + <literal>R = mtlb_all(A)</literal> peut être remplacé par <literal>R = and(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une hypermatrice + <literal>R = mtlb_all(A)</literal> peut être remplacé par <literal>R = and(A,firstnonsingleton(A))</literal> + ou par <literal>R = and(A,user_defined_value)</literal> si la première dimension non-égale à 1 de A est connue. + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est inférieur ou égal au nombre de dimensions de A + <literal>R = mtlb_all(A,dim)</literal> peut être remplacé par <literal>R = and(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est supérieur au nombre de dimensions de A + <literal>R = mtlb_all(A,dim)</literal> peut être remplacé par <literal>R = A<>0</literal> si A n'est pas + une matrice vide ou par <literal>R = A</literal> si A est une matrice vide. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention: <literal>mtlb_all</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_any.xml b/modules/compatibility_functions/help/fr_FR/mtlb_any.xml new file mode 100755 index 000000000..ecfbbf235 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_any.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_any"> + <refnamediv> + <refname>mtlb_any</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab any</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, les fonctions <literal>any</literal> de Matlab et + <literal>or</literal> de Scilab se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec un argument d'entrée (<literal>any(A)</literal>), la fonction <literal>any</literal> de Matlab traite + les valeurs selon la première dimension de A qui n'est pas 1 comme un vecteur + alors que Scilab traite toutes les valeurs de A. + </para> + </listitem> + <listitem> + <para> + Avec deux arguments d'entrée (<literal>any(A,dim)</literal>), Matlab + tolère une valeur de <literal>dim</literal> supérieure au + nombre de dimensions de A alors que Scilab renvoie un message d'erreur dans ce cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_any(A[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>any(A[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_any</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire ou un vecteur + <literal>R = mtlb_any(A)</literal> peut être remplacé par <literal>R = or(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice + <literal>R = mtlb_any(A)</literal> peut être remplacé par <literal>R = o(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une hypermatrice + <literal>R = mtlb_any(A)</literal> peut être remplacé par <literal>R = or(A,firstnonsingleton(A))</literal> + ou par <literal>R = or(A,user_defined_value)</literal> si la première dimension non-égale à 1 de A est connue. + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est inférieur ou égal au nombre de dimensions de A + <literal>R = mtlb_any(A,dim)</literal> peut être remplacé par <literal>R = or(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est supérieur au nombre de dimensions de A + <literal>R = mtlb_any(A,dim)</literal> peut être remplacé par <literal>R = A<>0</literal> si A n'est pas + une matrice vide ou par <literal>R = A</literal> si A est une matrice vide. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention: <literal>mtlb_any</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_axis.xml b/modules/compatibility_functions/help/fr_FR/mtlb_axis.xml new file mode 100755 index 000000000..540d8b2a6 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_axis.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) 2004-2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_axis"> + <refnamediv> + <refname>mtlb_axis</refname> + <refpurpose>Fonction d'émulation de la fonction + Matlab axis + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>mtlb_axis(X) + mtlb_axis(st) + mtlb_axis(axeshandle, ...) + [mode,visibility,direction]=mtlb_axis('state') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>un vecteur de réels ([xmin xmax ymin ymax] ou [xmin xmax ymin + ymax zmin zmax]) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>st</term> + <listitem> + <para>une chaine de caractères ('auto', 'manual', 'tight', 'ij', + 'xy', 'equal', 'square', 'vis3d', 'off', 'on') + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>axeshandle</term> + <listitem> + <para>handle sur l'axe courant</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + La fonction Matlab<literal> axis</literal> n'a pas de fonction Scilab + équivalente : + </para> + <para> + La fonction <literal>mtlb_axis(n,X[,normflag])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>axis(...)</literal> quand il + n'était pas possible de savoir ce qu'étaient les paramètres d'entrée + pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. + (<literal>'fill'</literal> , <literal>'image' </literal> et <literal>'normal'</literal> ne + sont pas implémentés).Pour obtenir un code plus performant on peut + remplacer les appels à <literal>mtlb_axis</literal> par les appels à + get(axeshandle,prop), ou prop est une propriété des axes (see + <link linkend="axis_properties">axis_properties</link>) + </para> + <para> + <warning> + Attention : <literal>mtlb_axis</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_beta.xml b/modules/compatibility_functions/help/fr_FR/mtlb_beta.xml new file mode 100755 index 000000000..3249d8637 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_beta.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_beta"> + <refnamediv> + <refname>mtlb_beta</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab beta</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>beta</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des paramètres d'entrée de tailles différentes : les paramètres d'entrée de la fonction + <literal>beta</literal> de Matlab doivent être de même taille sauf si l'un d'entre eux est un scalaire. + Les paramètres d'entrée de la fonction <literal>beta</literal> de Scilab doivent être de même taille + même si l'un d'entre eux est un scalaire. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_beta(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>beta(A,B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_beta</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire mais pas <literal>B</literal> + <literal>Y = mtlb_beta(A,B)</literal> peut être remplacé par <literal>C=B;C(:)=A;Y = mtlb_beta(C,B);</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>B</literal> est un scalaire mais pas <literal>A</literal> + <literal>Y = mtlb_beta(A,B)</literal> peut être remplacé par <literal>C=A;C(:)=B;Y = mtlb_beta(A,C);</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_beta</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_box.xml b/modules/compatibility_functions/help/fr_FR/mtlb_box.xml new file mode 100755 index 000000000..36d7e0205 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_box.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) 2002-2004 - 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="mtlb_box"> + <refnamediv> + <refname>mtlb_box</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab box</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>box</literal> mais elle peut facilement être remplacée. + </para> + <para> + La fonction <literal>mtlb_box([axes_handle[,val]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>box([axes_handle[,val]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_box</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Pour un appel sans paramètre d'entrée, + <literal>mtlb_box()</literal> peut être remplacé par <literal>a=gca();if a.box=="on" then a.box="off";else a.box="on";end;</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>axes_handle</literal> est une chaîne de caractères, + <literal>mtlb_box(axes_handle)</literal> peut être remplacé par <literal>a=gca();a.box=convstr(axes_handle,"l");</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>axes_handle</literal> est un handle graphique, + <literal>mtlb_box(axes_handle)</literal> peut être remplacé par + <literal>if axes_handle.box=="on" then axes_handle.box="off";else axes_handle.box="on";end;</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>axes_handle</literal> est un handle graphique et <literal>val</literal> est une chaîne de caractères, + <literal>mtlb_box(axes_handle,val)</literal> peut être remplacé par <literal>axes_handle.box=convstr(val,"l");</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_box</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_close.xml b/modules/compatibility_functions/help/fr_FR/mtlb_close.xml new file mode 100755 index 000000000..511d03823 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_close.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) 2002-2004 - 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="mtlb_close"> + <refnamediv> + <refname>mtlb_close</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab close</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Suivant le type de la figure courante (uicontrol ou graphique), l'équivalent Scilab pour + la fonction Matlab <literal>close</literal> est différent : + </para> + <itemizedlist> + <listitem> + <para> + Si la figure courante est de type uicontrol : l'équivalent Scilab pour la fonction Matlab + <literal>close</literal> est <literal>close</literal> + </para> + </listitem> + <listitem> + <para> + Si la fenêtre courante est une fenêtre graphique : l'équivalent Scilab pour la fonction Matlab + <literal>close</literal> est <literal>xdel</literal> ou <literal>delete</literal> + </para> + </listitem> + <listitem> + <para> + Dans Scilab on ne récupère pas de statut d'erreur. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_close([h])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>close([h])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_close</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>h</literal> est une figure de type uicontrol, + <literal>mtlb_close(h)</literal> peut être remplacé par <literal>close(h)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>h</literal> est une figure graphique, + <literal>mtlb_close(h)</literal> peut être remplacé par <literal>delete(h)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_close</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="xdel">xdel</link> + </member> + <member> + <link linkend="delete">delete</link> + </member> + <member> + <link linkend="winsid">winsid</link> + </member> + <member> + <link linkend="close">close</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_colordef.xml b/modules/compatibility_functions/help/fr_FR/mtlb_colordef.xml new file mode 100755 index 000000000..7289c1326 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_colordef.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_colordef"> + <refnamediv> + <refname>mtlb_colordef</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab colordef</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>colordef</literal> mais il existe + des instructions équivalentes. + </para> + <para> + La fonction <literal>h = mtlb_colordef(color_option)</literal> ou + <literal>h = mtlb_colordef(fig,color_option)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>colordef(color_option)</literal> ou + <literal>colordef(fig,color_option)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_colordef</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Pour les appels avec un paramètre d'entrée, si <literal>color_option</literal> est égal à "black" ou "none" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig = gcf();fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec un paramètre d'entrée, si <literal>color_option</literal> est égal à "white" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig = gcf();fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux paramètres d'entrée, si <literal>fig</literal> est un handle graphique et + <literal>color_option</literal> est égal à "black" ou "none" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux paramètres d'entrée, si <literal>fig</literal> est un handle graphique et + <literal>color_option</literal> est égal à "white" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux paramètres d'entrée, si <literal>fig</literal> est égal à "new" et + <literal>color_option</literal> est égal à "black" ou "none" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig = scf(max(winsid())+1);fig.background = -1;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux paramètres d'entrée, si <literal>fig</literal> est égal à "new" et + <literal>color_option</literal> est égal à "white" + <literal>mtlb_colordef(color_option)</literal> peut être remplacé par <literal>fig = scf(max(winsid())+1);fig.background = -2;</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec un paramètre de sortie <literal>h</literal>, ajouter <literal>h = fig;</literal> à la suite des instructions équivalentes. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_colordef</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="figure_properties">figure_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_cumprod.xml b/modules/compatibility_functions/help/fr_FR/mtlb_cumprod.xml new file mode 100755 index 000000000..5446ba6a4 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_cumprod.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) 2002-2004 - 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="mtlb_cumprod"> + <refnamediv> + <refname>mtlb_cumprod</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab cumprod</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>cumprod</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un argument d'entrée (<literal>cumsum(A)</literal>) : La fonction <literal>cumprod</literal> de Matlab + traite les valeurs suivant la première dimension qui n'est pas 1 comme des vecteurs alors + que Scilab traite toutes les valeurs de A. + </para> + </listitem> + <listitem> + <para> + Avec deux arguments d'entrée (<literal>cumprod(A,dim)</literal>) : Matlab tolère une valeur de + <literal>dim</literal> supérieure au nombre de dimensions de A alors que Scilab renvoie un + message d'erreur dans ce cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>R = mtlb_cumprod(A,[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>cumprod(A,[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_cumprod</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>dim</literal> est inférieure ou égale au nombre de dimensiopns de A + <literal>R = mtlb_cumprod(A,dim)</literal> peut être remplacé par <literal>R = cumprod(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est supérieure au nombre de dimensiopns de A + <literal>R = mtlb_cumprod(A,dim)</literal> peut être remplacé par <literal>R = A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_cumprod</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_cumsum.xml b/modules/compatibility_functions/help/fr_FR/mtlb_cumsum.xml new file mode 100755 index 000000000..590eb6d38 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_cumsum.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) 2002-2004 - 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="mtlb_cumsum"> + <refnamediv> + <refname>mtlb_cumsum</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab cumsum</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>cumsum</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un argument d'entrée (<literal>cumsum(A)</literal>) : La fonction <literal>cumsum</literal> de Matlab + traite les valeurs suivant la première dimension qui n'est pas 1 comme des vecteurs alors + que Scilab traite toutes les valeurs de A. + </para> + </listitem> + <listitem> + <para> + Avec deux arguments d'entrée (<literal>cumsum(A,dim)</literal>) : Matlab tolère une valeur de + <literal>dim</literal> supérieure au nombre de dimensions de A alors que Scilab renvoie un + message d'erreur dans ce cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>R = mtlb_cumsum(A,[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>cumsum(A,[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_cumsum</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>dim</literal> est inférieure ou égale au nombre de dimensiopns de A + <literal>R = mtlb_cumsum(A,dim)</literal> peut être remplacé par <literal>R = cumsum(A,dim)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>dim</literal> est supérieure au nombre de dimensiopns de A + <literal>R = mtlb_cumsum(A,dim)</literal> peut être remplacé par <literal>R = A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_cumsum</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_dec2hex.xml b/modules/compatibility_functions/help/fr_FR/mtlb_dec2hex.xml new file mode 100755 index 000000000..a9246f50f --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_dec2hex.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) 2002-2004 - 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="mtlb_dec2hex"> + <refnamediv> + <refname>mtlb_dec2hex</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab dec2hex</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>dec2hex</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec la matrice vide : La fonction Matlab <literal>dec2hex</literal> retourne "" mais la fonction Scilab renvoie []. + </para> + </listitem> + <listitem> + <para> + Avec des paramètres d'entrée complexes : La fonction Matlab <literal>dec2hex</literal> enl�ve + automatiquement la partie imaginaire mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + La fonction Matlab <literal>dec2hex</literal> renvoie toujours un vecteur colonne mais + la fonction Scilab renvoie un matrice de la même taille que le paramètre d'entrée. + </para> + </listitem> + <listitem> + <para> + La fonction Matlab <literal>dec2hex</literal> peut avoir deux paramètres d'entrée mais pas dans Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_dec2hex(D[,N])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>dec2hex(D[,N])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_dec2hex</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>D</literal> n'est pas une matrice vide, + <literal>mtlb_dec2hex(D)</literal> peut être remplacé par + <literal>matrix(dec2hex(real(D)),-1,1)</literal> si <literal>D</literal> est complexe et par + <literal>matrix(dec2hex(D),-1,1)</literal> dans les autres cas. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_dec2hex</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_delete.xml b/modules/compatibility_functions/help/fr_FR/mtlb_delete.xml new file mode 100755 index 000000000..d728f056a --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_delete.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_delete"> + <refnamediv> + <refname>mtlb_delete</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab delete</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + La fonction <literal>mtlb_delete(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>delete(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_delete</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une chaîne de caractères + <literal>mtlb_delete(A)</literal> peut être remplacé par <literal>mdelete(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est un handle graphique + <literal>mtlb_delete(A)</literal> peut être remplacé par <literal>delete(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_delete</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_diag.xml b/modules/compatibility_functions/help/fr_FR/mtlb_diag.xml new file mode 100755 index 000000000..9cdbf0290 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_diag.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_diag"> + <refnamediv> + <refname>mtlb_diag</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab diag</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>diag</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des matrices de chaînes de caractères : La fonction <literal>diag</literal> de Scilab considère + les chaînes comme des objets alors que Matlab considère chaque caractère séparément. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>y = mtlb_diag(x[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>y = diag(x[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_diag</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>x</literal> n'est pas une matrice de chaînes de caractères + <literal>y = mtlb_diag(x,dim)</literal> peut être remplacé par <literal>y = diag(x[,dim])</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_diag</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_diff.xml b/modules/compatibility_functions/help/fr_FR/mtlb_diff.xml new file mode 100755 index 000000000..f9acf79aa --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_diff.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_diff"> + <refnamediv> + <refname>mtlb_diff</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab diff</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>diff</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec deux paramètres d'entrée : la fonction <literal>diff</literal> de Scilab considère + toutes les valeurs du premier paramètre comm un vecteur ce que Matlab ne fait pas. + </para> + </listitem> + <listitem> + <para> + Avec trois paramètres d'entrée : si la dimension du premier paramètre suivant la dimension + donnée par le troisième paramètre atteint 1 avant que la fin des n itérations, Matlab passe + à la dimension suivante n'étant pas un 1 ce que Scilab ne fait pas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_diff(A[,n[,dim]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>diff(A[,n[,dim]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les entrées pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_diff</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Avec deux entrées, si <literal>A</literal> est un scalaire ou un vecteur + <literal>mtlb_diff(A,n)</literal> peut être remplacé par <literal>diff(A,n)</literal> + </para> + </listitem> + <listitem> + <para> + Avec deux entrées, si la taille de A suivant la dimension donnée par <literal>dim</literal> ne peut pas atteindre 1 + <literal>mtlb_diff(A,n,dim)</literal> peut être remplacé par <literal>diff(A,n,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_diff</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_dir.xml b/modules/compatibility_functions/help/fr_FR/mtlb_dir.xml new file mode 100755 index 000000000..6f74479bb --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_dir.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_dir"> + <refnamediv> + <refname>mtlb_dir</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab dir</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + La fonction <literal>dir</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Quand le résultat est stocké dans une variable: La fonction Matlab <literal>dir</literal> renvoie une structure + mais la fonction Scilab retourne une tlist de type 'dir', ce qui fait que les données ne peuvent être + extraites de la même manière. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_dir([path])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>dir([path])</literal> quand la sortie est stockée dans une variable. + Il n'est pas possible de remplacer cette fonction, sinon (si on la remplace par <literal>dir</literal>) + les données ne pourront pas être extraites comme dans Matlab. Par exemple, l'équivalent Scilab pour l'instruction Matlab + <literal>L=dir;file_name=L(1).name;</literal> est <literal>L=dir();file_name=L.name(1);</literal>. + </para> + <para> + <warning> + Attention : <literal>mtlb_dir</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_double.xml b/modules/compatibility_functions/help/fr_FR/mtlb_double.xml new file mode 100755 index 000000000..8d92bb5f9 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_double.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_double"> + <refnamediv> + <refname>mtlb_double</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab double</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>double</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée de type chaîne de caractère : La fonction <literal>double</literal> de Scilab + ne tolère pas ce type d'entrée alors que la fonction <literal>double</literal> de Matlab retourne + une matrice de codes ASCII. + </para> + </listitem> + <listitem> + <para> + Avec un paramètre d'entrée de type booléen : La fonction <literal>double</literal> de Scilab + ne tolère pas ce type d'entrée alors que la fonction <literal>double</literal> de Matlab retourne + une matrice de doubles. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_double(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>double(A)</literal> quand il n'était pas + possible de savoir ce qu'était <literal>A</literal> pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_double</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une chaîne de caractère + <literal>mtlb_double(A)</literal> peut être remplacé par <literal>asciimat(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice de booléens + <literal>mtlb_double(A)</literal> peut être remplacé par <literal>bool2s(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice de doubles + <literal>mtlb_double(A)</literal> peut être remplacé par <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_double</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="asciimat">asciimat</link> + </member> + <member> + <link linkend="bool2s">bool2s</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_e.xml b/modules/compatibility_functions/help/fr_FR/mtlb_e.xml new file mode 100755 index 000000000..5e97b42b9 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_e.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_e"> + <refnamediv> + <refname>mtlb_e</refname> + <refpurpose>Fonction d'émulation de l'extraction Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, l'extraction se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Lors de l'extraction de données d'une matrice avec comme indice un vecteur : + Matlab retourne un vecteur ligne alors que Scilab retourne un vecteur colonne. + </para> + </listitem> + <listitem> + <para> + Lors de l'extraction de données d'une matrice d'une chaîne de caractères : étant donné que + les matrices de chaînes de caractères peuvent être adressées comme tout autre type de + matrice dans Matlab (chaque caractère peut être adressé), + l'extraction à partir d'une telle matrice ne change pas des autres types. Mais dans Scilab + ceci ne peut être fait de la même manière et la fonction <literal>part</literal> doit être utilisée. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_e(B,k)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A=B(k)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_e</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>B</literal> est un vecteur + <literal>A=mtlb_e(B,k)</literal> peut être remplacé par <literal>A=B(k)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>B</literal> est une matrice + <literal>A=mtlb_e(B,k)</literal> peut être remplacé par <literal>A=B(k).'</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>B</literal> est une chaîne de caractères et + k est une scalaire ou un vecteur + <literal>A=mtlb_e(B,k)</literal> peut être remplacé par <literal>A=part(B,k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_e</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_echo.xml b/modules/compatibility_functions/help/fr_FR/mtlb_echo.xml new file mode 100755 index 000000000..ad305a451 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_echo.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) 2002-2004 - 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="mtlb_echo"> + <refnamediv> + <refname>mtlb_echo</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab echo</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>echo</literal> mais quelques cas particuliers peuvent être remplacés par des appels à la fonction Scilab <literal>mode</literal>: + </para> + <itemizedlist> + <listitem> + <para> + <literal>echo</literal> : est équivalent à <literal>mode(abs(mode()-1))</literal> dans Scilab pour les scripts et les fonctions non-compilées + </para> + </listitem> + <listitem> + <para> + <literal>echo on</literal> : est équivalent à <literal>mode(1)</literal> dans Scilab pour les scripts et les fonctions non-compilées + </para> + </listitem> + <listitem> + <para> + <literal>echo off</literal> : est équivalent à <literal>mode(0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_echo(arg1[,arg2])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>echo arg1 [arg2]</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_echo</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>arg1</literal> est égal à "on" + <literal>mtlb_echo(arg1)</literal> peut être remplacé par <literal>mode(1)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>arg1</literal> est égal à "off" + <literal>mtlb_echo(arg1)</literal> peut être remplacé par <literal>mode(0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_echo</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mode">mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_eval.xml b/modules/compatibility_functions/help/fr_FR/mtlb_eval.xml new file mode 100755 index 000000000..04308f95f --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_eval.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_eval"> + <refnamediv> + <refname>mtlb_eval</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab eval</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + L'équivalent Scilab pour la fonction Matlab <literal>eval</literal> est différent suivant ses entrées et sorties. + </para> + <para> + La fonction <literal>mtlb_eval(str1,str2)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>eval</literal> parce qu'il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_eval</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Pour les appels avec une entrée et pas de sortie, + <literal>mtlb_eval(str1)</literal> peut être remplacé par <literal>evstr(str1)</literal> + si <literal>str1</literal> est une expression Scilab valid + ou par <literal>execstr(str1)</literal> + si <literal>str1</literal> est une instruction Scilab valid. + </para> + </listitem> + <listitem> + <para> + Pour les appels avec une entrée et une sortie, + <literal>val=mtlb_eval(str1)</literal> peut être remplacé par <literal>val=evstr(str1)</literal> + si <literal>str1</literal> est une instruction Scilab valid. + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux entrées et une sortie, + <literal>mtlb_eval(str1,str2)</literal> peut être remplacé par: + <literal> + if execstr(str1,"errcatch")<>0 then + execstr(str2); + end + </literal> + si <literal>str1</literal> et <literal>str2</literal> sont des instructions Scilab valides. + </para> + </listitem> + <listitem> + <para> + Pour les appels avec une entrée et plus d'une sortie, + <literal>[val1,val2,...]=mtlb_eval(str1)</literal> peut être remplacé par: + <literal>execstr("[val1,val2,...]"+str1)</literal> + si <literal>str1</literal> est une instruction Scilab valide. + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux entrées et plus d'une sortie, + <literal>[val1,val2,...]=mtlb_eval(str1,str2)</literal> peut être remplacé par: + <literal> + if execstr("[val1,val2,...]"+str1,"errcatch")<>0 then + execstr("[val1,val2,...]"+str2); + end + </literal> + si <literal>str1</literal> et <literal>str2</literal> sont des instructions Scilab valides. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_eval</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_exist.xml b/modules/compatibility_functions/help/fr_FR/mtlb_exist.xml new file mode 100755 index 000000000..d994df896 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_exist.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_exist"> + <refnamediv> + <refname>mtlb_exist</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab exist</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>exist</literal> sauf si l'entrée est une variable. + La fonction Scilab <literal>mtlb_exist</literal> est une émulation partielle de cette fonction. + </para> + <para> + La fonction <literal>r = mtlb_exist(nam[,tp])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>exist(nam[,tp])</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_exist</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée et si <literal>nam</literal> est un nom de variable, + <literal>mtlb_exist(nam)</literal> peut être remplacé par <literal>exists(nam)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_exist</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="exists">exists</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_eye.xml b/modules/compatibility_functions/help/fr_FR/mtlb_eye.xml new file mode 100755 index 000000000..e29b29097 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_eye.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_eye"> + <refnamediv> + <refname>mtlb_eye</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab eye</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>eye</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>eye</literal> retourne une + matrice n x n alors que Scilab retourne 1. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_eye(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>eye(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_eye</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_eye(A)</literal> peut être remplacé par <literal>eye(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_eye(A)</literal> peut être remplacé par <literal>eye(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_eye</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_false.xml b/modules/compatibility_functions/help/fr_FR/mtlb_false.xml new file mode 100755 index 000000000..d8044032c --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_false.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) 2002-2004 - 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="mtlb_false"> + <refnamediv> + <refname>mtlb_false</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab false</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>false</literal>, cependant la fonction + Scilab <literal>zeros</literal> retourne un résultat interprété de la même façon pour Scilab. + </para> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>false</literal> et la fonction Scilab <literal>zeros</literal>se comporte différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>false</literal> retourne une + matrice n x n alors que la fonction Scilab <literal>zeros</literal> retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_false(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>false(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_false</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_false(A)</literal> peut être remplacé par <literal>zeros(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_false(A)</literal> peut être remplacé par <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_false</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fft.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fft.xml new file mode 100755 index 000000000..460a03529 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fft.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_fft"> + <refnamediv> + <refname>mtlb_fft</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fft</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>fft</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée : si ce paramètre est un scalaire ou un vecteur l'équivalent Scilab + pour la fonction Matlab <literal>fft</literal> est <literal>fft(...,-1)</literal> + et si ce paramètre est une matrice l'équivalent Scilab pour l'appel Matlab à <literal>fft</literal> + est <literal>fft(...,-1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_fft(X[,n,[job]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fft(X[,n,[job]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les entrées pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_fft</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>X</literal> est un scalaire ou un vecteur + <literal>mtlb_fft(X,-1)</literal> peut être remplacé par <literal>fft(X,-1)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>X</literal> est une matrice + <literal>mtlb_fft(X,-1)</literal> peut être remplacé par <literal>fft(X,-1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_fft</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fftshift.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fftshift.xml new file mode 100755 index 000000000..f74d037a3 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fftshift.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) 2002-2004 - 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="mtlb_fftshift"> + <refnamediv> + <refname>mtlb_fftshift</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fftshift</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>fftshift</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec les chaînes de caractère : étant donné que les chaînes de caractères sont vues différemment par Matlab et Scilab, le résultat peut être différent pour ce type d'entrée. + </para> + </listitem> + <listitem> + <para> + Avec deux paramètres d'entrée : Matlab autorise <literal>dim</literal> a être supérieur au nombre de dimension de <literal>A</literal> mais pas Scilab (message d'erreur). + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_fftshift(A,[dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fftshift(A,[dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_fftshift</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères, + <literal>mtlb_fftshift(A)</literal> peut être remplacé par <literal>fftshift(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères et <literal>dim</literal> est inférieur ou égal au nombre de dimension de <literal>A</literal>, + <literal>mtlb_fftshift(A,dim)</literal> peut être remplacé par <literal>fftshift(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_fftshift</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_find.xml b/modules/compatibility_functions/help/fr_FR/mtlb_find.xml new file mode 100755 index 000000000..635a7c201 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_find.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) 2002-2004 - 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="mtlb_find"> + <refnamediv> + <refname>mtlb_find</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab find</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>find</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée qui est un vecteur colonne ou une matrice : La fonction Matlab <literal>find</literal> + retourne un(des) vecteur(s) colonne alors que Scilab retourne un(des) vecteur(s) ligne. + </para> + </listitem> + <listitem> + <para> + Avec trois paramètres de sortie : La fonction Matlab <literal>find</literal> peut retourner trois valeurs + mais pas la fonction Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>[i[,j[,v]]] = mtlb_find(B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>[i[,j[,v]]] = find(B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_find</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Pour un appel avec un seul paramètre de sortie, si <literal>B</literal> est un vecteur ligne, + <literal>i = mtlb_find(B)</literal> peut être remplacé par <literal>i = find(B)</literal> + </para> + </listitem> + <listitem> + <para> + Pour un appel avec un seul paramètre de sortie, si <literal>B</literal> n'est pas un vecteur ligne, + <literal>i = mtlb_find(B)</literal> peut être remplacé par <literal>i = matrix(find(B),-1,1)</literal> + </para> + </listitem> + <listitem> + <para> + Pour un appel avec deux paramètres de sortie, si <literal>B</literal> est un vecteur ligne, + <literal>[i,j] = mtlb_find(B)</literal> peut être remplacé par <literal>[i,j] = find(B)</literal> + </para> + </listitem> + <listitem> + <para> + Pour un appel avec un seul paramètre de sortie, si <literal>B</literal> n'est pas un vecteur ligne, + <literal>[i,j] = mtlb_find(B)</literal> peut être remplacé par + <literal>[i,j] = find(B);i = matrix(i,-1,1);j = matrix(j,-1,1);</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_find</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_findstr.xml b/modules/compatibility_functions/help/fr_FR/mtlb_findstr.xml new file mode 100755 index 000000000..28f3c3581 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_findstr.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_findstr"> + <refnamediv> + <refname>mtlb_findstr</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab findstr</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>findstr</literal>. + </para> + <para> + La fonction <literal>mtlb_findstr(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>findstr(A,B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_findstr</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est toujours plus longue que <literal>B</literal> + (i.e. <literal>strfind</literal> peut remplacer <literal>findstr</literal> en Matlab), + <literal>mtlb_findstr(A,B)</literal> peut être remplacé par <literal>strindex(A,B)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_findstr</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fliplr.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fliplr.xml new file mode 100755 index 000000000..6cf28c019 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fliplr.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_fliplr"> + <refnamediv> + <refname>mtlb_fliplr</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fliplr</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>fliplr</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée de type chaîne de caractère : étant donné que Scilab et Matlab ne considèrent pas les chaînes de caractère de la même façon, le résultat pout être différent pour une entrée de ce type. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_fliplr(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fliplr(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_fliplr</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères, + <literal>mtlb_fliplr(A)</literal> peut être remplacé par <literal>fliplr(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_fliplr</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fopen.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fopen.xml new file mode 100755 index 000000000..669af1fb5 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fopen.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) 2002-2004 - 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="mtlb_fopen"> + <refnamediv> + <refname>mtlb_fopen</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fopen</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>fopen</literal> et la fonction Scilab <literal>mopen</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + La fonction Scilab ne renvoie pas de pessage d'erreur utilisable + </para> + </listitem> + <listitem> + <para> + L'indentifieur de fichier n'est pas initialisé dans Scilab en cas d'erreur alors que Matlab lui fixe la valeur <literal>-1</literal> + </para> + </listitem> + <listitem> + <para> + La fonction Matlab peut fonctionner avec des arguments qui n'existent pas en Scilab : options de permission... + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_fopen(filename,permission)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fopen(filename,permission)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_fopen</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si le message d'erreur n'est pas utilisé et si aucune erreur ne peut avoir lieu, + <literal>mtlb_fopen(filename,permission)</literal> peut être remplacé par <literal>mopen(filename,permission,0)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_fopen</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_format.xml b/modules/compatibility_functions/help/fr_FR/mtlb_format.xml new file mode 100755 index 000000000..038b5ea2f --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_format.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) 2002-2004 - 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="mtlb_format"> + <refnamediv> + <refname>mtlb_format</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab format</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>format</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Certains formats Matlab n'existent pas en Scilab. + </para> + </listitem> + <listitem> + <para> + La séquence d'appel de <literal>format</literal> est différente en Scilab et Matlab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_format(type,prec)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>format([type prec])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_format</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>type=""</literal> et <literal>prec=""</literal> + <literal>mtlb_format("","")</literal> peut être remplacé par <literal>format("v",6)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="+"</literal> et <literal>prec=""</literal> + <literal>mtlb_format("+","")</literal> peut être remplacé par <literal>format(6)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="long"</literal> et <literal>prec=""</literal> + <literal>mtlb_format("long","")</literal> peut être remplacé par <literal>format(16)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="long"</literal> et <literal>prec="e"</literal> + <literal>mtlb_format("long","e")</literal> peut être remplacé par <literal>format("e"16)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="long"</literal> et <literal>prec="g"</literal> + <literal>mtlb_format("long","g")</literal> peut être remplacé par <literal>format("e"16)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="short"</literal> et <literal>prec=""</literal> + <literal>mtlb_format("short","")</literal> peut être remplacé par <literal>format(6)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="short"</literal> et <literal>prec="e"</literal> + <literal>mtlb_format("short","e")</literal> peut être remplacé par <literal>format("e"6)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>type="short"</literal> et <literal>prec="g"</literal> + <literal>mtlb_format("short","g")</literal> peut être remplacé par <literal>format("e"6)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_format</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fprintf.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fprintf.xml new file mode 100755 index 000000000..cbb6b1e69 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fprintf.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_fprintf"> + <refnamediv> + <refname>mtlb_fprintf</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fprintf</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab exact pour la fonction Matlab <literal>fprintf</literal>. La fonction Scilab <literal>mfprintf</literal> + et la fonction Matlab <literal>fprintf</literal> se comportent différemment dans beaucoup de cas mais sont équivalentes dans plusieurs cas. + </para> + <para> + La fonction <literal>mtlb_fprintf(varargin)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fprintf</literal>. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Il est quelquefois possible de remplacer les appels à + <literal>mtlb_fprintf</literal> par des appels à <link linkend="mfprintf">mfprintf</link>. + </para> + <para> + <warning> + Attention : <literal>mtlb_fprintf</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fread.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fread.xml new file mode 100755 index 000000000..4929db11c --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fread.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_fread"> + <refnamediv> + <refname>mtlb_fread</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fread</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>fread</literal>. La fonction Scilab <literal>mget</literal> + et la fonction Matlab <literal>fread</literal> se comportent différemment dans beaucoup de cas mais sont équivalentes dans plusieurs cas. + </para> + <para> + La fonction <literal>mtlb_fread(varargin)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fread</literal>. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Il est quelquefois possible de remplacer les appels à + <literal>mtlb_fread</literal> par des appels à <link linkend="mget">mget</link>. + </para> + <para> + <warning> + Attention : <literal>mtlb_fread</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mget">mget</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fscanf.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fscanf.xml new file mode 100755 index 000000000..8cdf29939 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fscanf.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_fscanf"> + <refnamediv> + <refname>mtlb_fscanf</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab fscanf</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab exact pour la fonction Matlab <literal>fscanf</literal>. La fonction Scilab <literal>mfscanf</literal> + et la fonction Matlab <literal>fscanf</literal> se comportent différemment dans beaucoup de cas mais sont équivalentes dans plusieurs cas. + </para> + <para> + La fonction <literal>mtlb_fscanf(varargin)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>fscanf</literal>. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Il est quelquefois possible de remplacer les appels à + <literal>mtlb_fscanf</literal> par des appels à <link linkend="mfscanf">mfscanf</link>. + </para> + <para> + <warning> + Attention : <literal>mtlb_fscanf</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_full.xml b/modules/compatibility_functions/help/fr_FR/mtlb_full.xml new file mode 100755 index 000000000..61ae779ed --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_full.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) 2002-2004 - 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="mtlb_full"> + <refnamediv> + <refname>mtlb_full</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab full</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>full</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée de type chaîne de caractère : La fonction Matlab <literal>full</literal> + peut être utilisée avec des chaînes de caractères ce qui n'est pas possible dans Scilab. + </para> + </listitem> + <listitem> + <para> + Avec un paramètre d'entrée de type booléen : La fonction Matlab <literal>full</literal> + peut être utilisée avec des booléens ce qui n'est pas possible dans Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_full(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>full(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_full</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une matrice de doubles + <literal>mtlb_full(A)</literal> peut être remplacé par <literal>full(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice de booléens + <literal>mtlb_full(A)</literal> peut être remplacé par <literal>full(bool2s(A))</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_full</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_fwrite.xml b/modules/compatibility_functions/help/fr_FR/mtlb_fwrite.xml new file mode 100755 index 000000000..a0a08ca46 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_fwrite.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_write"> + <refnamediv> + <refname>mtlb_write</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab write</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>write</literal>. La fonction Scilab <literal>mput</literal> + et la fonction Matlab <literal>write</literal> se comportent différemment dans beaucoup de cas mais sont équivalentes dans plusieurs cas. + </para> + <para> + La fonction <literal>mtlb_write(varargin)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>write</literal>. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Il est quelquefois possible de remplacer les appels à + <literal>mtlb_write</literal> par des appels à <link linkend="mput">mput</link>. + </para> + <para> + <warning> + Attention : <literal>mtlb_write</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mput">mput</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_grid.xml b/modules/compatibility_functions/help/fr_FR/mtlb_grid.xml new file mode 100755 index 000000000..ddd8ea866 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_grid.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) 2002-2004 - 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="mtlb_grid"> + <refnamediv> + <refname>mtlb_grid</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab grid</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab equivalente à la fonction Matlab <literal>grid</literal> mais il existe des instructions équivalentes + </para> + <para> + La fonction <literal>mtlb_grid(flag_or_handle[,flag])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>grid(flag_or_handle[,flag])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_grid</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée, si <literal>flag</literal> est égal à "on" + <literal>mtlb_grid(flag)</literal> peut être remplacé par <literal>set(gca(),"grid",[1 1])</literal> + </para> + </listitem> + <listitem> + <para> + Avec un paramètre d'entrée, si <literal>flag</literal> est égal à "off" + <literal>mtlb_grid(flag)</literal> peut être remplacé par <literal>set(gca(),"grid",[-1 -1])</literal> + </para> + </listitem> + <listitem> + <para> + Avec deux paramètres d'entrée, si <literal>flag</literal> est égal à "on" + <literal>mtlb_grid(axes_handle,flag)</literal> peut être remplacé par <literal>axes_handle.grid=[1 1]</literal> + </para> + </listitem> + <listitem> + <para> + Avec un paramètre d'entrée, si <literal>flag</literal> est égal à "off" + <literal>mtlb_grid(axes_handle,flag)</literal> peut être remplacé par <literal>axes_handle.grid=[-1 -1]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_grid</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_hold.xml b/modules/compatibility_functions/help/fr_FR/mtlb_hold.xml new file mode 100755 index 000000000..46fb3dccb --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_hold.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_hold"> + <refnamediv> + <refname>mtlb_hold</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab hold</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab equivalente à la fonction Matlab <literal>hold</literal> mais il existe des instructions équivalentes + </para> + <para> + La fonction <literal>mtlb_hold(flag)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>hold flag</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_hold</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>flag</literal> est égal à "on" + <literal>mtlb_hold(flag)</literal> peut être remplacé par <literal>set(gca(),"auto_clear","off")</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>flag</literal> est égal à "off" + <literal>mtlb_hold(flag)</literal> peut être remplacé par <literal>set(gca(),"auto_clear","on")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_hold</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="axes_properties">axes_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_i.xml b/modules/compatibility_functions/help/fr_FR/mtlb_i.xml new file mode 100755 index 000000000..8af56d13b --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_i.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) 2002-2004 - 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="mtlb_i"> + <refnamediv> + <refname>mtlb_i</refname> + <refpurpose>Fonction d'émulation de l'insertion de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, l'insertion se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + En insérant une matrice dans une variable : Matlab ajuste automatiquement la taille + de la variable de retour pour qu'elle corresponde avec la matrice à insérer mais pas Scilab. + Par exemple, avec A=1, A([1,2,3,4])=[1,2;3,4]) retourne un message d'erreur dans Scilab + alors que dans Matlab on obtient A=[1,2,3,4]. Si des valeurs manquent par rapport aux + indices donnés pour insérer, Matlab remplit la valeur de retour avec des zéros. + </para> + </listitem> + <listitem> + <para> + Lors de l'insertion de données d'une matrice d'une chaîne de caractères : étant donné que + les matrices de chaînes de caractères peuvent être adressées comme tout autre type de + matrice dans Matlab (chaque caractère peut être adressé), + l'insertion à partir dans une telle matrice ne change pas des autres types. Mais dans Scilab + ceci ne peut être fait de la même manière... <literal>mtlb_is</literal> est une alternative. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>A=mtlb_i(A,k,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A(k)=B</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_i</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas un vecteur + <literal>A=mtlb_i(A,k,B)</literal> peut être remplacé par <literal>A(k)=B</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des vecteurs lignes ou colonnes + <literal>A=mtlb_i(A,k,B)</literal> peut être remplacé par <literal>A(k)=B</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_i</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + <member> + <link linkend="mtlb_is">mtlb_is</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_ifft.xml b/modules/compatibility_functions/help/fr_FR/mtlb_ifft.xml new file mode 100755 index 000000000..e6af2f3f4 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_ifft.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_ifft"> + <refnamediv> + <refname>mtlb_fft</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab ifft</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>ifft</literal> et la fonction Scilab <literal>fft</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée : si ce paramètre est un scalaire ou un vecteur l'équivalent Scilab + pour la fonction Matlab <literal>ifft(A)</literal> est <literal>fft(A,1)</literal> + et si ce paramètre est une matrice l'équivalent Scilab pour l'appel Matlab à <literal>ifft</literal> + est <literal>fft(A,1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_ifft(X[,n,[job]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>ifft(X[,n,[job]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les entrées pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_ifft</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>X</literal> est un scalaire ou un vecteur + <literal>mtlb_ifft(X,1)</literal> peut être remplacé par <literal>fft(X,1)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>X</literal> est une matrice + <literal>mtlb_ifft(X,1)</literal> peut être remplacé par <literal>fft(X,1,2,1)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_ifft</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_imp.xml b/modules/compatibility_functions/help/fr_FR/mtlb_imp.xml new file mode 100755 index 000000000..bf55e46b0 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_imp.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_imp"> + <refnamediv> + <refname>mtlb_imp</refname> + <refpurpose>Fonction d'émulation de l'opérateur "deux points" de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, l'opérateur "deux points" se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des matrices vides : L'opérateur <literal>:</literal> doit être utilisé avec des scalaires dans Scilab + et retourne un message d'erreur quand on l'utilise avec des matrices vides alors que Matlab renvoie [] + dans tous ces cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_imp(A,B[,C])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A:B[:C]</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_imp</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal>, <literal>B</literal> et <literal>C</literal> ne sont pas des matrices vides + <literal>mtlb_imp(A,B[,C])</literal> peut être remplacé par <literal>A:B[:C]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_imp</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_int16.xml b/modules/compatibility_functions/help/fr_FR/mtlb_int16.xml new file mode 100755 index 000000000..1c964a6a2 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_int16.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_int16"> + <refnamediv> + <refname>mtlb_int16</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab int16</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>int16</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>int16</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 32767 alors que Scilab retourne -32768. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%nan</literal> : Matlab retourne 0 alors que Scilab retourne -32768. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>-%nan</literal> : Matlab retourne 0 alors que Scilab retourne -32768. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_int16(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>int16(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_int16</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal>, <literal>%nan</literal> ou <literal>-%nan</literal> + <literal>mtlb_int16(A)</literal> peut être remplacé par <literal>int16(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_int16</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_int32.xml b/modules/compatibility_functions/help/fr_FR/mtlb_int32.xml new file mode 100755 index 000000000..a77e40e67 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_int32.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_int32"> + <refnamediv> + <refname>mtlb_int32</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab int32</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>int32</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>int32</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 2147483647 alors que Scilab retourne -2147483648. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%nan</literal> : Matlab retourne 0 alors que Scilab retourne -2147483648. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>-%nan</literal> : Matlab retourne 0 alors que Scilab retourne -2147483648. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_int32(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>int32(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_int32</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal>, <literal>%nan</literal> ou <literal>-%nan</literal> + <literal>mtlb_int32(A)</literal> peut être remplacé par <literal>int32(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_int32</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_int8.xml b/modules/compatibility_functions/help/fr_FR/mtlb_int8.xml new file mode 100755 index 000000000..edbccd8a7 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_int8.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) 2002-2004 - 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="mtlb_int8"> + <refnamediv> + <refname>mtlb_int8</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab int8</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>int8</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>int8</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 127 alors que Scilab retourne 0. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>-%inf</literal> : Matlab retourne -128 alors que Scilab retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_int8(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>int8(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_int8</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal> ou <literal>-%inf</literal> + <literal>mtlb_int8(A)</literal> peut être remplacé par <literal>int8(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_int8</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_is.xml b/modules/compatibility_functions/help/fr_FR/mtlb_is.xml new file mode 100755 index 000000000..03737ede5 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_is.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_is"> + <refnamediv> + <refname>mtlb_is</refname> + <refpurpose>Fonction d'émulation de l'insertion dans une chaîne de caractères de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + L'insertion se comporte différemment dans Matlab et dans Scilab pour les chaînes de caractères + étant donné que celles-ci ne sont pas considérées de la même façon. + </para> + <para> + La fonction <literal>str = mtlb_is(sto,sfrom,i,j)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer les opérations d'insertion dans des + chaînes de caractères. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Elle ne peut être remplacée. + </para> + <para> + <warning> + Attention : <literal>mtlb_is</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + <member> + <link linkend="mtlb_i">mtlb_i</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_isa.xml b/modules/compatibility_functions/help/fr_FR/mtlb_isa.xml new file mode 100755 index 000000000..1bfaa1ad7 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_isa.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_isa"> + <refnamediv> + <refname>mtlb_isa</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab isa</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>isa</literal> mais quand la "classe" d'objet recherchée existe dans Scilab, des expressions équivalentes existent. + </para> + <para> + La fonction <literal>mtlb_isa(OBJ,class)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>isa(OBJ,class)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_isa</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>class</literal> est égal à "logical", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==4</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "char", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==10</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "numeric", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>or(type(OBJ)==[1,5,8])</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "intX" (X valant 8, 16 ou 32), + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>typeof(OBJ)=="intX"</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "uintX" (X valant 8, 16 ou 32), + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>typeof(OBJ)=="uintX"</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "single", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==1</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "double", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==1</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "cell", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>typeof(OBJ)=="ce"</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "struct", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>typeof(OBJ)=="st"</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "function_handle", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==13</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "sparse", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>type(OBJ)==5</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>class</literal> est égal à "lti", + <literal>mtlb_isa(OBJ,class)</literal> peut être remplacé par <literal>typeof(OBJ)=="state-space"</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_isa</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </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> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_isfield.xml b/modules/compatibility_functions/help/fr_FR/mtlb_isfield.xml new file mode 100755 index 000000000..750de433f --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_isfield.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_isfield"> + <refnamediv> + <refname>mtlb_isfield</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab isfield</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab equivalente à la fonctions Matlab <literal>isfield(st,f)</literal> et l'expression équivalente se comporte différemment dans certains cas particuliers: + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>st</literal> n'est pas une structure : l'équivalent Scilab retourne une erreur alors que Matlab renvoie <literal>0</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_isfield(st,f)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>isfield(st,f)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_isfield</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>st</literal> est une structure + <literal>tf = mtlb_isfield(st,f)</literal> peut être remplacé par <literal>allf=getfield(1,st);tf=or(allf(3:$)==f);</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>st</literal> n'est pas une structure + <literal>tf = mtlb_isfield(st,f)</literal> peut être remplacé par <literal>tf=%F;</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_isfield</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="getfield">getfield</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_isletter.xml b/modules/compatibility_functions/help/fr_FR/mtlb_isletter.xml new file mode 100755 index 000000000..1b1239a1f --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_isletter.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) 2002-2004 - 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="mtlb_isletter"> + <refnamediv> + <refname>mtlb_isletter</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab isletter</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>isletter</literal> et les + expressions équivalentes sont assez compliquées, donc + <literal>mfile2sci</literal> utilise <literal>mtlb_isletter(A)</literal>pour remplacer <literal>isletter(A)</literal>. + Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_isletter</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une chaîne de caractères + <literal>tf = mtlb_isletter(A)</literal> peut être remplacé par <literal>tf = zeros(A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une chaîne de caractères + <literal>tf = mtlb_isletter(A)</literal> peut être remplacé par + <literal>tf = (asciimat(A)>=65&asciimat(A)<=90)|(asciimat(A)>=97&asciimat(A)<=122)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_isletter</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_isspace.xml b/modules/compatibility_functions/help/fr_FR/mtlb_isspace.xml new file mode 100755 index 000000000..43a2e3804 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_isspace.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_isspace"> + <refnamediv> + <refname>mtlb_isspace</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab isspace</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalente à la fonction Matlab <literal>isspace</literal> + mais son comportement peut être reproduit. + </para> + <para> + La fonction <literal>mtlb_isspace(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>isspace(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_isspace</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une matrice de chaînes de caractères + <literal>mtlb_isspace(A)</literal> peut être remplacé par <literal>asciimat(A)==32</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères + <literal>mtlb_isspace(A)</literal> peut être remplacé par <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_isspace</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="asciimat">asciimat</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_l.xml b/modules/compatibility_functions/help/fr_FR/mtlb_l.xml new file mode 100755 index 000000000..7dd14b3fe --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_l.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_l"> + <refnamediv> + <refname>mtlb_l</refname> + <refpurpose>Fonction d'émulation de la division à gauche de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, la division à gauche se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes de type chaîne de caractères : L'opérateur <literal>\</literal> + ne peut pas être utilisé dans Scilab avec des chaînes de caractères, alors que + dans Matlab c'est possible. Et dans ce cas, le résultat donné par matlab est + tranposé d'une manière très floue... + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_l(a,b)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A\B</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_l</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> ne sont pas des chaînes de caractères + <literal>mtlb_l(A,B)</literal> peut être remplacé par <literal>A\B</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_l</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_legendre.xml b/modules/compatibility_functions/help/fr_FR/mtlb_legendre.xml new file mode 100755 index 000000000..de804e8f1 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_legendre.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2004-2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_legendre"> + <refnamediv> + <refname>mtlb_legendre</refname> + <refpurpose>Fonction d'émulation de la fonction + Matlab legendre + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>P=mtlb_legendre(n,X) + P=mtlb_legendre(n,X[,normflag]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>un scalaire, un vecteur, une matrice ou hypermatrice + d'elements compris dans [-1 1] + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>n</term> + <listitem> + <para>un entier positif</para> + </listitem> + </varlistentry> + <varlistentry> + <term>normflag</term> + <listitem> + <para> + une chaine de caracteres (<literal>'sch'</literal> ou + <literal>'norm'</literal>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>legendre</literal> se + comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + L'appel de fonction Scilab <literal>legendre(m,n,X)</literal> évalue + la fonction de legendre de degré <literal>n </literal> et d'ordre + <literal>m </literal>pour tous les éléments de <literal>X</literal>. Par + contre l'appel de fonction Scilab <literal>legendre(m,n,X)</literal> + évalue la fonction de legendre de degré <literal>n</literal> et d'ordre + <literal>m=0,1,...,n </literal>pour tous les éléments de + <literal>X</literal>. + </para> + </listitem> + <listitem> + <para> + Le mode <literal>normflag='sch'</literal> n'est pas implémenté avec + Scilab + </para> + </listitem> + <listitem> + <para>La fonction legendre de Scilab ne fonctionne pas si + <literal>X</literal> est une hypermatrice + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_legendre(n,X[,normflag])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer + <literal>legendre(n,X[,normflag])</literal> quand il n'était pas possible de + savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un + code Matlab vers Scilab. Cette fonction va déterminer la sémantique + correcte pendant l'exécution. Pour obtenir un code plus performant on peut + remplacer les appels à <literal>mtlb_legendre</literal> : + </para> + <itemizedlist> + <listitem> + <para>If X is a scalar, a vector or a matrix + <literal>mtlb_legendre(n,X[,'norm']) </literal> may be replaced by + <literal>legendre(n,0:n,X[,'norm'])</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_legendre</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_linspace.xml b/modules/compatibility_functions/help/fr_FR/mtlb_linspace.xml new file mode 100755 index 000000000..c637ce16a --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_linspace.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_linspace"> + <refnamediv> + <refname>mtlb_linspace</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab linspace</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>linspace</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec les chaînes de caractère: La fonction Matlab <literal>linspace(A,B[,n])</literal> renvoie un vecteur de caractères si <literal>A</literal> ou <literal>B</literal> est une chaîne de caractère, mais la fonction Scilab ne marche pas avec des entrées de ce type. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_linspace(A,B[,n])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>linspace(A,B[,n])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_linspace</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> ne sont pas des chaînes de caractères, + <literal>mtlb_linspace(A,B[,n])</literal> peut être remplacé par <literal>linspace(A,B[,n])</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> ou <literal>B</literal> est une chaîne de caractères, + <literal>mtlb_linspace(A,B[,n])</literal> peut être remplacé par <literal>ascii(linspace(ascii(A),ascii(B)[,n]))</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_linspace</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="ascii">ascii</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_logic.xml b/modules/compatibility_functions/help/fr_FR/mtlb_logic.xml new file mode 100755 index 000000000..5002e58c2 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_logic.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) 2002-2004 - 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="mtlb_logic"> + <refnamediv> + <refname>mtlb_logic</refname> + <refpurpose>Fonction d'émulation des opérateurs logiques de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, les opérateurs logiques se comportent différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes complexes : Les opérateurs <literal><</literal>, <literal><=</literal>, + <literal>></literal> et <literal>>=</literal> ne peuvent pas être utilisés dans Scilab + avec des opérandes complexes alors que cela est possible dans Matlab. Dans ce cas, + seule la partie réelle des opérandes est comparée. + </para> + </listitem> + <listitem> + <para> + Avec des matrices vides : Si les deux opérandes des opérateurs <literal><</literal>, <literal><=</literal>, + <literal>></literal> and <literal>>=</literal> sont des matrices vides, Scilab renvoie un message d'erreur + alors que Matlab retourne une matrice vide. Pour les opérateurs <literal>==</literal> et <literal>~=</literal>, + si au moins une opérande est une matrice vide alors Matlab renvoie [] alors que Scilab + retourne un booléen %T ou %F. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_logic(A,symbol,B)</literal> (avec "symbol" une chaîne de caractères contenant + le symbole de l'opérateur) est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A symbol B</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_logic</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> ne sont pas des complexes ni des matrices vides + <literal>mtlb_logic(A,symbol,B)</literal> peut être remplacé par <literal>A symbol B</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_logic</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_logical.xml b/modules/compatibility_functions/help/fr_FR/mtlb_logical.xml new file mode 100755 index 000000000..37fde8336 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_logical.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_logical"> + <refnamediv> + <refname>mtlb_logical</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab logical</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas de fonction Scilab équivalent à la fonction Matlab <literal>logical</literal> mais sont comportement peut être reproduit. + </para> + <para> + La fonction <literal>mtlb_logical(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>logical(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_logical</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une matrice de booléens + <literal>mtlb_logical(A)</literal> peut être remplacé par <literal>A</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice vide + <literal>mtlb_logical(A)</literal> peut être remplacé par <literal>A<>[]</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est une matrice vide + <literal>mtlb_logical(A)</literal> peut être remplacé par <literal>[]</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_logical</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_lower.xml b/modules/compatibility_functions/help/fr_FR/mtlb_lower.xml new file mode 100755 index 000000000..b7c7fa406 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_lower.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_lower"> + <refnamediv> + <refname>mtlb_lower</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab lower</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>lower(A)</literal> et la fonction Scilab + <literal>convstr(A,"l")</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une chaîne de caractères : la fonction Matlab <literal>lower</literal> peut être utilisée + avec <literal>A</literal> n'étant pas une chaîne de caractères mais pas la fonction Scilab <literal>convstr</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_lower(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>lower(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_lower</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une matrice de chaînes de caractères + <literal>mtlb_lower(A)</literal> peut être remplacé par <literal>convstr(A,"l")</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères + <literal>mtlb_lower(A)</literal> peut être remplacé par <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_lower</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="convstr">convstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_max.xml b/modules/compatibility_functions/help/fr_FR/mtlb_max.xml new file mode 100755 index 000000000..8073820ff --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_max.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) 2002-2004 - 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="mtlb_max"> + <refnamediv> + <refname>mtlb_max</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab max</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>max</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des valeurs complexes : La fonction Matlab <literal>max</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : La fonction Matlab <literal>max</literal> traite les valeurs + suivant la première dimension qui n'est pas 1 alors que Scilab traite l'ensemble des valeurs de l'entrée. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : si l'une d'elles est une matrice vide, Scilab + retourne un message d'erreur alors que Matlab renvoie []. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec trois paramètres d'entrée : si le paramètre <literal>dim</literal> est plus grand que + le nombre de dimensions de le première entrée, Scilab retourne un message d'erreur alors que Matlab + retourne le premier paramètre. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>[r[,k]] = mtlb_max(A[,B[,dim]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>[r[,k]] = max(A[,B[,dim]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_max</literal> : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est un scalaire ou un vecteur + <literal>[r[,k]] = mtlb_max(A)</literal> peut être remplacé par <literal>max(A)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice + <literal>[r[,k]] = mtlb_max(A)</literal> peut être remplacé par <literal>max(A,"r")</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée, si <literal>A</literal> et <literal>B</literal> + sont des matrices réelles et ne sont pas des matrices vides, + <literal>[r[,k]] = mtlb_max(A,B)</literal> peut être remplacé par <literal>max(A,B)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec trois paramètres d'entrée, si <literal>dim</literal> est inférieur + au nombre de dimensions de <literal>A</literal>, + <literal>[r[,k]] = mtlb_max(A,[],dim)</literal> peut être remplacé par <literal>max(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_max</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_min.xml b/modules/compatibility_functions/help/fr_FR/mtlb_min.xml new file mode 100755 index 000000000..30050b30e --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_min.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) 2002-2004 - 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="mtlb_min"> + <refnamediv> + <refname>mtlb_min</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab min</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>min</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des valeurs complexes : La fonction Matlab <literal>min</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : La fonction Matlab <literal>min</literal> traite les valeurs + suivant la première dimension qui n'est pas 1 alors que Scilab traite l'ensemble des valeurs de l'entrée. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : si l'une d'elles est une matrice vide, Scilab + retourne un message d'erreur alors que Matlab renvoie []. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec trois paramètres d'entrée : si le paramètre <literal>dim</literal> est plus grand que + le nombre de dimensions de le première entrée, Scilab retourne un message d'erreur alors que Matlab + retourne le premier paramètre. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>[r[,k]] = mtlb_min(A[,B[,dim]])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>[r[,k]] = min(A[,B[,dim]])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_min</literal> : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est un scalaire ou un vecteur + <literal>[r[,k]] = mtlb_min(A)</literal> peut être remplacé par <literal>min(A)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice + <literal>[r[,k]] = mtlb_min(A)</literal> peut être remplacé par <literal>min(A,"r")</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée, si <literal>A</literal> et <literal>B</literal> + sont des matrices réelles et ne sont pas des matrices vides, + <literal>[r[,k]] = mtlb_min(A,B)</literal> peut être remplacé par <literal>min(A,B)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec trois paramètres d'entrée, si <literal>dim</literal> est inférieur + au nombre de dimensions de <literal>A</literal>, + <literal>[r[,k]] = mtlb_min(A,[],dim)</literal> peut être remplacé par <literal>min(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_min</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_mode.xml b/modules/compatibility_functions/help/fr_FR/mtlb_mode.xml new file mode 100755 index 000000000..8415287ca --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_mode.xml @@ -0,0 +1,78 @@ +<?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="mtlb_mode"> + <refnamediv> + <refname>mtlb_mode</refname> + <refpurpose>choisit le mode de compatibilité Matlab </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>mmode = mtlb_mode() + mtlb_mode(mmode) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>mmode </term> + <listitem> + <para>un booléen + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Les additions et soustractions fonctionnent différemment dans Scilab et Matlab quand un des opérandes est une matrice vide : + </para> + <variablelist> + <varlistentry> + <term>Scilab</term> + <listitem> + <para/> + <programlisting role=""><![CDATA[ +a=1; +a+[] +// -->a + +a-[] +// -->a + +[]+a +// -->a + +[]-a +// -->-a + ]]></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Matlab</term> + <listitem> + <programlisting role="no-scilab-exec"><![CDATA[ +a+[] -->[] +a-[] -->[] +[]+a -->[] +[]-a -->[] + ]]></programlisting> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>mtlb_mode(%t)</code> passe au mode de compatibilité Matlab pour les additions et les soustractions. <code>mtlb_mode(%f)</code> retourne au mode Scilab. + </para> + <para> + <code>mtlb_mode()</code> renvoie la valeur du mode de compatibilité courant (<constant>%t</constant>=Matlab, <constant>%f</constant>=Scilab). + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="empty">empty</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_more.xml b/modules/compatibility_functions/help/fr_FR/mtlb_more.xml new file mode 100755 index 000000000..be998fbe0 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_more.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_more"> + <refnamediv> + <refname>mtlb_more</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab more</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>more</literal> et la fonction Scilab + <literal>lines</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec des chaînes de caractères comme entrée : La fonction Matlab <literal>more</literal> accepte + "on" et "off" comme entrée mais pas la fonction Scilab <literal>lines</literal>, + il existe des équivalents (0 et 60). + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_more(in)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>more(in)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_more</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>in</literal> est égal à "on" + <literal>mtlb_more(in)</literal> peut être remplacé par <literal>lines(60)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>in</literal> est égal à "off" + <literal>mtlb_more(in)</literal> peut être remplacé par <literal>lines(0)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>in</literal> est un double + <literal>mtlb_more(in)</literal> peut être remplacé par <literal>lines(in)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_more</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_num2str.xml b/modules/compatibility_functions/help/fr_FR/mtlb_num2str.xml new file mode 100755 index 000000000..3c8db7483 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_num2str.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) 2002-2004 - 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="mtlb_num2str"> + <refnamediv> + <refname>mtlb_num2str</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab num2str</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>num2str</literal> et ses équivalents Scilab + (<literal>string</literal>, <literal>msprintf</literal>) se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec deux paramètres d'entrée, le second donnant une précision : Il n'y a pas de fonction Scilab équivalente + mais <literal>msprintf</literal> peut être utilisée pour émuler ce cas. + </para> + </listitem> + <listitem> + <para> + Avec deux paramètres d'entrée, le second donnant un format : l'équivalent Scilab pour l'expression Matlab + <literal>num2string(a,format)</literal> est <literal>msprintf(format,a)</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_num2str(x,f)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>num2str(x,f)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_num2str</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>f</literal> est une chaîne de caractères, + <literal>mtlb_num2str(x,f)</literal> peut être remplacé par <literal>msprintf(f,x)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_num2str</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="msprintf">msprintf</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_ones.xml b/modules/compatibility_functions/help/fr_FR/mtlb_ones.xml new file mode 100755 index 000000000..5cdbb73ec --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_ones.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_ones"> + <refnamediv> + <refname>mtlb_ones</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab ones</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>ones</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>ones</literal> retourne une + matrice n x n alors que Scilab retourne 1. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_ones(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>ones(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_ones</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_ones(A)</literal> peut être remplacé par <literal>ones(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_ones(A)</literal> peut être remplacé par <literal>ones(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_ones</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_plot.xml b/modules/compatibility_functions/help/fr_FR/mtlb_plot.xml new file mode 100755 index 000000000..dced16f74 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_plot.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_plot"> + <refnamediv> + <refname>mtlb_plot</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab plot</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + La fonction Matlab <literal>plot</literal> et la fonction Scilab <literal>plot2d</literal> se comportent différemment. + </para> + <para> + La fonction <literal>mtlb_plot(...)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>plot(...)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_plot</literal> quand il n'y a pas de valeur de sortie, + dans ce cas, les couleurs doivent être changées par l'utilisateur: + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée, si <literal>Y</literal> est réel + <literal>mtlb_plot(Y)</literal> peut être remplacé par <literal>plot2d(Y)</literal> + </para> + </listitem> + <listitem> + <para> + Avec un paramètre d'entrée, si <literal>Y</literal> est complex + <literal>mtlb_plot(Y)</literal> peut être remplacé par <literal>plot2d(real(Y),imag(Y))</literal> + </para> + </listitem> + <listitem> + <para> + Avec deux paramètres d'entrée <literal>X</literal> et <literal>Y</literal>, si <literal>Y</literal> n'est pas une chaîne de caractères, + <literal>mtlb_plot(X,Y)</literal> peut être remplacé par <literal>plot2d(X,Y)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_plot</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="plot2d">plot2d</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_prod.xml b/modules/compatibility_functions/help/fr_FR/mtlb_prod.xml new file mode 100755 index 000000000..970200d54 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_prod.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) 2002-2004 - 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="mtlb_prod"> + <refnamediv> + <refname>mtlb_prod</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab prod</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>prod</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée : La fonction Matlab <literal>prod</literal> traite + les valeurs en suivant la première dimension qui n'est pas 1 alors que la fonction Scilab + <literal>prod</literal> traite toutes les valeurs de l'entrée. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : La fonction Matlab <literal>prod</literal> peut être + utilisée avec le second paramètre donnant une dimension du premier paramètre qui n'existe pas + alors que la fonction Scilab <literal>prod</literal> retourne un message d'erreur. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_prod(A[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>prod(A[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_prod</literal> : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice vide, un scalaire ou un vecteur, + <literal>mtlb_prod(A)</literal> peut être remplacé par <literal>prod(A)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice non-vide, + <literal>mtlb_prod(A)</literal> peut être remplacé par <literal>prod(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est hypermatrice, + <literal>mtlb_prod(A)</literal> peut être remplacé par <literal>prod(A,firstnonsingleton(A))</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée, si <literal>dim</literal> est inférieure au nombre + de dimensions de <literal>A</literal> + <literal>mtlb_prod(A,dim)</literal> peut être remplacé par <literal>prod(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_prod</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_rand.xml b/modules/compatibility_functions/help/fr_FR/mtlb_rand.xml new file mode 100755 index 000000000..0d254529d --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_rand.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_rand"> + <refnamediv> + <refname>mtlb_rand</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab rand</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>rand</literal> se comporte différemment + dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>rand</literal> retourne une + matrice n x n alors que la fonction Scilab retourne un scalaire. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_rand(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>rand(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_rand</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_rand(A)</literal> peut être remplacé par <literal>rand(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_rand(A)</literal> peut être remplacé par <literal>rand(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_rand</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_randn.xml b/modules/compatibility_functions/help/fr_FR/mtlb_randn.xml new file mode 100755 index 000000000..705c91d03 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_randn.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_randn"> + <refnamediv> + <refname>mtlb_randn</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab randn</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>randn</literal> et la fonction Scilab + <literal>rand(...,"normal")</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>randn</literal> retourne une + matrice n x n alors que la fonction Scilab <literal>rand(...,"normal")</literal> retourne un scalaire. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_randn(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>randn(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_randn</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_randn(A)</literal> peut être remplacé par <literal>rand(A,A,"normal")</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_randn(A)</literal> peut être remplacé par <literal>rand(A,"normal")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_randn</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_rcond.xml b/modules/compatibility_functions/help/fr_FR/mtlb_rcond.xml new file mode 100755 index 000000000..674c00d53 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_rcond.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_rcond"> + <refnamediv> + <refname>mtlb_rcond</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab rcond</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>rcond</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec une matrice vide : La fonction Matlab <literal>rcond</literal> retourne <literal>Inf</literal> + et Scilab retourne <literal>[]</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_rcond(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>rcond(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_rcond</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice vide + <literal>mtlb_rcond(A)</literal> peut être remplacé par <literal>rcond(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_rcond</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_realmax.xml b/modules/compatibility_functions/help/fr_FR/mtlb_realmax.xml new file mode 100755 index 000000000..e250fc657 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_realmax.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) 2002-2004 - 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="mtlb_realmax"> + <refnamediv> + <refname>mtlb_realmax</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab realmax</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + L'équivalent Scilab de la fonction Matlab <literal>realmax</literal> + est <literal>number_properties</literal> mais tous les cas ne sont pas + implémentés : + </para> + <itemizedlist> + <listitem> + <para> + L'équivalent Scilab de l'expression Matlab + <literal>realmax</literal> ou <literal>realmax('double')</literal> est <literal>number_properties("huge")</literal> + </para> + </listitem> + <listitem> + <para> + Il n'y a pas d'équivalent Scilab pour l'expression Matlab <literal>realmax('single')</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_realmax(prec)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>realmax(prec)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_realmax</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>prec</literal> est égale à <literal>"double"</literal> + <literal>mtlb_realmax(prec)</literal> peut être remplacé par <literal>number_properties("huge")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_realmax</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="number_properties">number_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_realmin.xml b/modules/compatibility_functions/help/fr_FR/mtlb_realmin.xml new file mode 100755 index 000000000..754deccfa --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_realmin.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) 2002-2004 - 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="mtlb_realmin"> + <refnamediv> + <refname>mtlb_realmin</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab realmin</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + L'équivalent Scilab de la fonction Matlab <literal>realmin</literal> + est <literal>number_properties</literal> mais tous les cas ne sont pas + implémentés : + </para> + <itemizedlist> + <listitem> + <para> + L'équivalent Scilab de l'expression Matlab + <literal>realmin</literal> ou <literal>realmin('double')</literal> est <literal>number_properties("tiny")</literal> + </para> + </listitem> + <listitem> + <para> + Il n'y a pas d'équivalent Scilab pour l'expression Matlab <literal>realmin('single')</literal> + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_realmin(prec)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>realmin(prec)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_realmin</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>prec</literal> est égale à <literal>"double"</literal> + <literal>mtlb_realmin(prec)</literal> peut être remplacé par <literal>number_properties("tiny")</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_realmin</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="number_properties">number_properties</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_s.xml b/modules/compatibility_functions/help/fr_FR/mtlb_s.xml new file mode 100755 index 000000000..8d6f1c607 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_s.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_s"> + <refnamediv> + <refname>mtlb_s</refname> + <refpurpose>Fonction d'émulation de la soustraction Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, la soustraction se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes de type chaîne de caractères : L'opérateur <literal>-</literal> + ne peut pas être utilisé dans Scilab avec des chaînes de caractère, alors que + Matlab réalise dans ce cas la soustraction des codes ASCII des opérandes. + </para> + </listitem> + <listitem> + <para> + Avec une matrice vide : Dans Scilab, si une des + opérandes est une matrice vide alors le résultat de la soustraction est + l'autre opérande. Dans Matlab si une des opérandes est une matrice + vide alors le résultat de la soustraction est soit une erreur (la seconde opérande n'est pas un scalaire) + soit une matrice vide. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_s(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A-B</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_s</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des chaînes de caractères, + <literal>mtlb_s(A,B)</literal> peut être remplacé par <literal>asciimat(A)-asciimat(B)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> ne sont pas des matrices vides + <literal>mtlb_s(A,B)</literal> peut être remplacé par <literal>A-B</literal>, + sinon <literal>mtlb_s(A,B)</literal> peut être remplacé par + <literal>[]</literal>. + </para> + </listitem> + <listitem> + <para> + Si mtlb_mode()==%T, alors <literal>mtlb_s(A,B)</literal> + peut être remplacé par <literal>A-B</literal> dans tous les cas où + <literal>A</literal> et <literal>B</literal> ne sont pas des chaînes de caractères. + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_s</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="mtlb_mode">mtlb_mode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_setstr.xml b/modules/compatibility_functions/help/fr_FR/mtlb_setstr.xml new file mode 100755 index 000000000..e3f137f2c --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_setstr.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_setstr"> + <refnamediv> + <refname>mtlb_setstr</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab setstr</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>setstr</literal> et la fonction Scilab + <literal>ascii</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec les chaînes de caractère : la fonction Matlab <literal>setstr</literal> retourne une chaîne de caractères + alors que la fonction Scilab <literal>ascii</literal> retourne uen matrice de doubles. + </para> + </listitem> + <listitem> + <para> + Avec les matrices de doubles : la fonction Matlab <literal>setstr</literal> retourne une matrice + de caractères alors que la fonction Scilab <literal>ascii</literal> retourne une chaine de caractères. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_setstr(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>setstr(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_setstr</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une chaîne de caractères ou une matrice de chaînes + <literal>mtlb_setstr(A)</literal> peut être remplacé par <literal>A</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> est un vecteur ligne de doubles + <literal>mtlb_setstr(A)</literal> peut être remplacé par <literal>ascii(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_setstr</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_size.xml b/modules/compatibility_functions/help/fr_FR/mtlb_size.xml new file mode 100755 index 000000000..2d641edf9 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_size.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) 2002-2004 - 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="mtlb_size"> + <refnamediv> + <refname>mtlb_size</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab size</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>size</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec deux paramètres d'entrée : La fonction Matlab <literal>size</literal> peut être + utilisée avec le second paramètre donnant donnant une dimension du premier paramètre + qui n'existe pas (retourne 1 dans ce cas) mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec plus d'une paramètre de sortie : si le nombre de paramètres de sortie est plus + petit que le nombre de dimension, la dernière sortie est égale au produit de toutes + les dimensions restantes dans Matlab mais pas dans Scilab. Si le nombre de sorties + est plus grand que le nombre de dimensions, toutes les sorties correspondant à une + dimension qui n'existe pas sont égales à 1 en Matlab mais Scilab retourne une erreur dans ce cas. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>[d1,[d2,...]] = mtlb_size(X[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>[d1,[d2,...]] = mtlb_size(X[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_size</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Avec deux paramètres d'entrée : si <literal>dim</literal> correspond à une dimension de <literal>X</literal> qui existe + <literal>mtlb_size(X,dim)</literal> peut être remplacé par <literal>size(X,dim)</literal> + </para> + </listitem> + <listitem> + <para> + Avec plus d'un paramètre de sortie : si le nombre des sorties est égal au nombre de dimensions de <literal>X</literal> + <literal>[d1,[d2,...]] = mtlb_size(X)</literal> peut être remplacé par <literal>[d1,[d2,...]] = size(X)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_size</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_sort.xml b/modules/compatibility_functions/help/fr_FR/mtlb_sort.xml new file mode 100755 index 000000000..cc95faa0b --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_sort.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2004-2006 - INRIA - Farid BELAHCENE + * + * 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="mtlb_sort"> + <refnamediv> + <refname>mtlb_sort</refname> + <refpurpose>Fonction d'émulation de la fonction + Matlab sort + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>P = mtlb_sort(X) + P = mtlb_sort(X,dim[,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>X</term> + <listitem> + <para>un scalaire, un vecteur, une matrice ou hypermatrice + d'elements compris dans [-1 1]un scalaire, un vecteur ou une matrice + de réels, de booléens ou une string + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ndim</term> + <listitem> + <para>un entier positif</para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para> + une chaine de caracteres (<literal>"ascend"</literal> or + <literal>"descend"</literal>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>sort</literal> de + Matlab et la fonction <literal>gsort</literal> de Scilab se comportent + différemment : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>X</literal> est un vecteur alors l'appel de la fonction + <literal>sort(X) </literal>de Matlab est équivalent à l'appel de la + fonction <literal>sort(X,'g','i')</literal> de Scilab. + </para> + </listitem> + <listitem> + <para> + <literal>dim=1</literal> (resp. <literal>2</literal>) de Matlab est + equivalent au flag <literal>'r'</literal> (resp.<literal> 'c'</literal>) de + Scilab. + </para> + </listitem> + <listitem> + <para> + <literal>mode="ascend"</literal> (resp. <literal>"descend"</literal>) est + équivalent au flag <literal>'i'</literal> (resp <literal>'d'</literal>) de + Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_sort(X,dim[,mode])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>sort(X,dim[,mode])</literal> + quand il n'était pas possible de savoir ce qu'étaient les paramètres + d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette + fonction va déterminer la sémantique correcte pendant l'exécution. Pour + obtenir un code plus performant on peut remplacer les appels à + <literal>mtlb_sort</literal> par des appels <link linkend="gsort">gsort</link>. + </para> + <para> + <warning> + Attention : <literal>mtlb_sort</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_strcmp.xml b/modules/compatibility_functions/help/fr_FR/mtlb_strcmp.xml new file mode 100755 index 000000000..7db76d403 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_strcmp.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_strcmp"> + <refnamediv> + <refname>mtlb_strcmp</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab strcmp</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas dans Scilab de fonction équivalente à la fonction Matlab <literal>strcmp</literal> mais il existe des instructions équivalentes. + </para> + <para> + La fonction <literal>mtlb_strcmp(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>strcmp(A,B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_strcmp</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des chaînes de caractères + <literal>mtlb_strcmp(A,B)</literal> peut être remplacé par <literal>A==B</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> et/ou <literal>B</literal> n'est pas une chaîne de caractères + <literal>mtlb_strcmp(A,B)</literal> peut être remplacé par <literal>0</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_strcmp</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_strcmpi.xml b/modules/compatibility_functions/help/fr_FR/mtlb_strcmpi.xml new file mode 100755 index 000000000..5e4ac60f4 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_strcmpi.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_strcmpi"> + <refnamediv> + <refname>mtlb_strcmpi</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab strcmpi</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas dans Scilab de fonction équivalente à la fonction Matlab <literal>strcmpi</literal> mais il existe des instructions équivalentes. + </para> + <para> + La fonction <literal>mtlb_strcmpi(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>strcmpi(A,B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_strcmpi</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des chaînes de caractères + <literal>mtlb_strcmpi(A,B)</literal> peut être remplacé par <literal>convstr(A)==convstr(B)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> et/ou <literal>B</literal> n'est pas une chaîne de caractères + <literal>mtlb_strcmpi(A,B)</literal> peut être remplacé par <literal>0</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_strcmpi</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_strfind.xml b/modules/compatibility_functions/help/fr_FR/mtlb_strfind.xml new file mode 100755 index 000000000..5367d0d1a --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_strfind.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_strfind"> + <refnamediv> + <refname>mtlb_strfind</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab strfind</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>strfind</literal> et la fonction Scilab + <literal>strindex</literal> se comportent différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des paramètres d'entrée n'étant pas des chaînes de caractère : La fonction Matlab <literal>strfind</literal> + peut être utilisée avec des entrées n'étant pas des chaînes de caractères mais pas la fonction + Scilab <literal>strindex</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_strfind(A,B)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>strfind(A,B)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_strfind</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> et <literal>B</literal> sont des chaînes de caractères + <literal>mtlb_strfind(A,B)</literal> peut être remplacé par <literal>strindex(A,B)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_strfind</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_strrep.xml b/modules/compatibility_functions/help/fr_FR/mtlb_strrep.xml new file mode 100755 index 000000000..aa896a249 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_strrep.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_strrep"> + <refnamediv> + <refname>mtlb_strrep</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab strrep</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>strrep</literal> et la fonction Scilab + <literal>strsubst</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec des paramètres d'entrée n'étant pas des chaînes de caractère : La fonction Matlab <literal>strrep</literal> + peut être utilisée avec des entrées n'étant pas des chaînes de caractères mais pas la fonction + Scilab <literal>strsubst</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_strrep(A,B,C)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>strrep(A,B,C)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_strrep</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal>, <literal>B</literal> et <literal>C</literal> sont des chaînes de caractères + <literal>y = mtlb_strrep(A,B,C)</literal> peut être remplacé par <literal>strsubst(A,B,C)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_strrep</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_sum.xml b/modules/compatibility_functions/help/fr_FR/mtlb_sum.xml new file mode 100755 index 000000000..4b8b4b6c2 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_sum.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) 2002-2004 - 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="mtlb_sum"> + <refnamediv> + <refname>mtlb_sum</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab sum</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>sum</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée : La fonction Matlab <literal>sum</literal> traite + les valeurs en suivant la première dimension qui n'est pas 1 alors que la fonction Scilab + <literal>sum</literal> traite toutes les valeurs de l'entrée. + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée : La fonction Matlab <literal>sum</literal> peut être + utilisée avec le second paramètre donnant une dimension du premier paramètre qui n'existe pas + alors que la fonction Scilab <literal>sum</literal> retourne un message d'erreur. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_sum(A[,dim])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>sum(A[,dim])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_sum</literal> : + </para> + <itemizedlist> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice vide, un scalaire ou un vecteur, + <literal>mtlb_sum(A)</literal> peut être remplacé par <literal>sum(A)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est une matrice non-vide, + <literal>mtlb_sum(A)</literal> peut être remplacé par <literal>sum(A,1)</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec un paramètre d'entrée, si <literal>A</literal> est hypermatrice, + <literal>mtlb_sum(A)</literal> peut être remplacé par <literal>sum(A,firstnonsingleton(A))</literal> + </para> + </listitem> + <listitem> + <para> + En cas d'appel avec deux paramètres d'entrée, si <literal>dim</literal> est inférieure au nombre + de dimensions de <literal>A</literal> + <literal>mtlb_sum(A,dim)</literal> peut être remplacé par <literal>sum(A,dim)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_sum</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="firstnonsingleton">firstnonsingleton</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_t.xml b/modules/compatibility_functions/help/fr_FR/mtlb_t.xml new file mode 100755 index 000000000..3d9e52bc7 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_t.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_t"> + <refnamediv> + <refname>mtlb_t</refname> + <refpurpose>Fonction d'émulation de la transposition de Matlab</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Dans plusieurs cas particuliers, la transposition se comporte différemment dans Matlab et dans Scilab :</para> + <itemizedlist> + <listitem> + <para> + Avec des opérandes de type chaîne de caractère : L'opérateur <literal>'</literal> est utilisé dans Scilab + pour transposer des chaînes de caractères entières alors que Matlab fait la transposition caractère par caractère. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_t(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>A'</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_t</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères + <literal>mtlb_t(A)</literal> peut être remplacé par <literal>A'</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_t</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_toeplitz.xml b/modules/compatibility_functions/help/fr_FR/mtlb_toeplitz.xml new file mode 100755 index 000000000..ca6da0277 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_toeplitz.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_toeplitz"> + <refnamediv> + <refname>mtlb_toeplitz</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab toeplitz</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>toeplitz</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée : si celui-ci est complexe ou si c'est une matrice, la valeur de sortie + des fonctions <literal>toeplitz</literal> de Matlab et Scilab sera différente. + </para> + </listitem> + <listitem> + <para> + Avec deux paramètres d'entrée : si ce sont des vecteurs et que leurs premiers éléments sont différents, + Scilab renvoie un message d'erreur alors que Matlab donne priorité à l'élément colonne. Si ce sont des matrices, + la valeur retournée par la fonction <literal>toeplitz</literal> sera différente dans Matlab et dans Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_toeplitz(c[,r])</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>toeplitz(c[,r])</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code + Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_toeplitz</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Pour les appels avec un paramètre d'entrée, si <literal>c</literal> est un scalaire ou un vecteur réel, + <literal>mtlb_toeplitz(c)</literal> peut être remplacé par <literal>toeplitz(c)</literal> + </para> + </listitem> + <listitem> + <para> + Pour les appels avec deux paramètres d'entrée, si <literal>c</literal> et <literal>r</literal> sont des scalaires ou des vecteurs + et que leurs premiers éléments sont égaux, + <literal>mtlb_toeplitz(c,r)</literal> peut être remplacé par <literal>toeplitz(c,r)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_toeplitz</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_tril.xml b/modules/compatibility_functions/help/fr_FR/mtlb_tril.xml new file mode 100755 index 000000000..1e8e40038 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_tril.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) 2002-2004 - 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="mtlb_tril"> + <refnamediv> + <refname>mtlb_tril</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab tril</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>tril</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des paramètres d'entrée complexes : La fonction Matlab <literal>tril</literal> peut être + utilisée avec des données complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec des paramètres d'entrée de type chaîne de caractère : étant donné que Matlab et Scilab + ne considèrent pas les chaînes de caractères de la même façon, la fonction <literal>tril</literal> + ne donne pas le même résultat pour ce type d'entrée dans Scilab et dans Matlab. + </para> + </listitem> + <listitem> + <para> + Avec des paramètres d'entrée booléens : La fonction Matlab <literal>tril</literal> peut être + utilisée avec des données booléennes mais pas la fonction Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_tril(x,k)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>tril(x,k)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_tril</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>X</literal> contient des doubles réels + <literal>mtlb_tril(x,k)</literal> peut être remplacé par <literal>tril(x,k)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>X</literal> contient des booléens + <literal>mtlb_tril(x,k)</literal> peut être remplacé par <literal>tril(bool2s(x),k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_tril</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_triu.xml b/modules/compatibility_functions/help/fr_FR/mtlb_triu.xml new file mode 100755 index 000000000..0c5163483 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_triu.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) 2002-2004 - 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="mtlb_triu"> + <refnamediv> + <refname>mtlb_triu</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab triu</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>triu</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec des paramètres d'entrée complexes : La fonction Matlab <literal>triu</literal> peut être + utilisée avec des données complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec des paramètres d'entrée de type chaîne de caractère : étant donné que Matlab et Scilab + ne considèrent pas les chaînes de caractères de la même façon, la fonction <literal>triu</literal> + ne donne pas le même résultat pour ce type d'entrée dans Scilab et dans Matlab. + </para> + </listitem> + <listitem> + <para> + Avec des paramètres d'entrée booléens : La fonction Matlab <literal>triu</literal> peut être + utilisée avec des données booléennes mais pas la fonction Scilab. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_triu(x,k)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>triu(x,k)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_triu</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>X</literal> contient des doubles réels + <literal>mtlb_triu(x,k)</literal> peut être remplacé par <literal>triu(x,k)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>X</literal> contient des booléens + <literal>mtlb_triu(x,k)</literal> peut être remplacé par <literal>triu(bool2s(x),k)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_triu</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="Chaines_de_caracteres_MatlabScilab">Chaines_de_caracteres_Matlab-Scilab</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_true.xml b/modules/compatibility_functions/help/fr_FR/mtlb_true.xml new file mode 100755 index 000000000..7fbfff8cf --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_true.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) 2002-2004 - 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="mtlb_true"> + <refnamediv> + <refname>mtlb_true</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab true</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Il n'y a pas d'équivalent Scilab pour la fonction Matlab <literal>true</literal>, cependant la fonction + Scilab <literal>ones</literal> retourne un résultat interprété de la même façon pour Scilab. + </para> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>true</literal> et la fonction Scilab <literal>ones</literal>se comporte différemment : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>true</literal> retourne une + matrice n x n alors que la fonction Scilab <literal>ones</literal> retourne 1. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_true(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>true(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_true</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_true(A)</literal> peut être remplacé par <literal>ones(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_true(A)</literal> peut être remplacé par <literal>ones(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_true</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_uint16.xml b/modules/compatibility_functions/help/fr_FR/mtlb_uint16.xml new file mode 100755 index 000000000..d86d5faf3 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_uint16.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_uint16"> + <refnamediv> + <refname>mtlb_uint16</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab uint16</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>uint16</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>uint16</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 65535 alors que Scilab retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_uint16(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>uint16(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_uint16</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal>, <literal>%nan</literal> ou <literal>-%nan</literal> + <literal>mtlb_uint16(A)</literal> peut être remplacé par <literal>uint16(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_uint16</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_uint32.xml b/modules/compatibility_functions/help/fr_FR/mtlb_uint32.xml new file mode 100755 index 000000000..873699011 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_uint32.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_uint32"> + <refnamediv> + <refname>mtlb_uint32</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab uint32</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>uint32</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>uint32</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 4294967295 alors que Scilab retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_uint32(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>uint32(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_uint32</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal>, <literal>%nan</literal> ou <literal>-%nan</literal> + <literal>mtlb_uint32(A)</literal> peut être remplacé par <literal>uint32(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_uint32</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_uint8.xml b/modules/compatibility_functions/help/fr_FR/mtlb_uint8.xml new file mode 100755 index 000000000..223983295 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_uint8.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_uint8"> + <refnamediv> + <refname>mtlb_uint8</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab uint8</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>uint8</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec un paramètre d'entrée complexe : La fonction Matlab <literal>uint8</literal> peut être utilisée + avec des complexes mais pas la fonction Scilab. + </para> + </listitem> + <listitem> + <para> + Avec la valeur <literal>%inf</literal> : Matlab retourne 255 alors que Scilab retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_uint8(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>uint8(A)</literal> quand il n'était pas + possible de savoir ce qu'était le paramètre d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_uint8</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> ne contient pas de valeur <literal>%inf</literal>, <literal>%nan</literal> ou <literal>-%nan</literal> + <literal>mtlb_uint8(A)</literal> peut être remplacé par <literal>uint8(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_uint8</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_upper.xml b/modules/compatibility_functions/help/fr_FR/mtlb_upper.xml new file mode 100755 index 000000000..7e79f3145 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_upper.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_upper"> + <refnamediv> + <refname>mtlb_upper</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab upper</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction Matlab <literal>upper(A)</literal> et la fonction Scilab + <literal>convstr(A,"u")</literal> se comportent différemment : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> n'est pas une chaîne de caractères : la fonction Matlab <literal>upper</literal> peut être utilisée + avec <literal>A</literal> n'étant pas une chaîne de caractères mais pas la fonction Scilab <literal>convstr</literal>. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_upper(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>upper(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les paramètres d'entrée pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_upper</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est une matrice de chaînes de caractères + <literal>mtlb_upper(A)</literal> peut être remplacé par <literal>convstr(A,"u")</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas une matrice de chaînes de caractères + <literal>mtlb_upper(A)</literal> peut être remplacé par <literal>A</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_upper</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="convstr">convstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/fr_FR/mtlb_zeros.xml b/modules/compatibility_functions/help/fr_FR/mtlb_zeros.xml new file mode 100755 index 000000000..76e4780d3 --- /dev/null +++ b/modules/compatibility_functions/help/fr_FR/mtlb_zeros.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2002-2004 - 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="mtlb_zeros"> + <refnamediv> + <refname>mtlb_zeros</refname> + <refpurpose>Fonction d'émulation de la fonction Matlab zeros</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Dans plusieurs cas particuliers, la fonction <literal>zeros</literal> se comporte différemment dans Matlab et dans Scilab : + </para> + <itemizedlist> + <listitem> + <para> + Avec une entrée qui est un scalaire : La fonction Matlab <literal>zeros</literal> retourne une + matrice n x n alors que Scilab retourne 0. + </para> + </listitem> + </itemizedlist> + <para> + La fonction <literal>mtlb_zeros(A)</literal> est utilisée par + <literal>mfile2sci</literal> pour remplacer <literal>zeros(A)</literal> quand il n'était pas + possible de savoir ce qu'étaient les opérandes pendant la conversion d'un code Matlab vers Scilab. Cette fonction va + déterminer la sémantique correcte pendant l'exécution. Pour obtenir un code plus performant + on peut remplacer les appels à <literal>mtlb_zeros</literal> : + </para> + <itemizedlist> + <listitem> + <para> + Si <literal>A</literal> est un scalaire + <literal>mtlb_zeros(A)</literal> peut être remplacé par <literal>zeros(A,A)</literal> + </para> + </listitem> + <listitem> + <para> + Si <literal>A</literal> n'est pas un scalaire + <literal>mtlb_zeros(A)</literal> peut être remplacé par <literal>zeros(A)</literal> + </para> + </listitem> + </itemizedlist> + <para> + <warning> + Attention : <literal>mtlb_zeros</literal> ne doit pas être utilisée pour une programmation manuelle. + </warning> + </para> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/ja_JP/addchapter.sce b/modules/compatibility_functions/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..76cce23cb --- /dev/null +++ b/modules/compatibility_functions/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("Compatibility Functions",SCI+"/modules/compatibility_functions/help/ja_JP",%T); + diff --git a/modules/compatibility_functions/help/ja_JP/mtlb_mode.xml b/modules/compatibility_functions/help/ja_JP/mtlb_mode.xml new file mode 100755 index 000000000..54f6d7311 --- /dev/null +++ b/modules/compatibility_functions/help/ja_JP/mtlb_mode.xml @@ -0,0 +1,78 @@ +<?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="mtlb_mode"> + <refnamediv> + <refname>mtlb_mode</refname> + <refpurpose>Matlab 類似処理を切替</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>mmode = mtlb_mode() + mtlb_mode(mmode) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>mmode</term> + <listitem> + <para>論理値</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + 以下のように空の行列を使用した場合の + Scilab および Matlab の加算および除算の動作は + 異なります: + </para> + <variablelist> + <varlistentry> + <term>Scilab</term> + <listitem> + <para/> + <programlisting role=""><![CDATA[ +a=1; +a+[] +// -->a +a-[] +// -->a +[]+a +// -->a +[]-a +// -->-a + ]]></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Matlab</term> + <listitem> + <programlisting role="no-scilab-exec"><![CDATA[ +a+[] -->[] +a-[] -->[] +[]+a -->[] +[]-a -->[] + ]]></programlisting> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>mtlb_mode(%t)</code> は加算および除算をMatlab互換モードに + 切り替えます. + <code>mtlb_mode(%f)</code> はScilabモードに戻します. + </para> + <para> + <code>mtlb_mode()</code>はカレントの <varname>mmode</varname>の値を返します(<constant>%t</constant>=Matlab, <constant>%f</constant>=Scilab). + </para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="empty">empty</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/pt_BR/addchapter.sce b/modules/compatibility_functions/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..f8bcafa41 --- /dev/null +++ b/modules/compatibility_functions/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("Funções de Compatibilidade",SCI+"/modules/compatibility_functions/help/pt_BR",%T); + diff --git a/modules/compatibility_functions/help/pt_BR/mtlb_mode.xml b/modules/compatibility_functions/help/pt_BR/mtlb_mode.xml new file mode 100755 index 000000000..27697d6cd --- /dev/null +++ b/modules/compatibility_functions/help/pt_BR/mtlb_mode.xml @@ -0,0 +1,80 @@ +<?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: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="mtlb_mode" xml:lang="en"> + <refnamediv> + <refname>mtlb_mode</refname> + <refpurpose>alterna para modo de operaes do Matlab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title> Seqncia de Chamamento </title> + <synopsis>mmode = mtlb_mode() + mtlb_mode(mmode) + </synopsis> + </refsynopsisdiv> + <refsection> + <title> Parmetros </title> + <variablelist> + <varlistentry> + <term>mmode</term> + <listitem> + <para>booleano</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Adies e subtraes do Scilab e do Matlab funcionam de modo + diferente quando usadas com matrizes vazias: + </para> + <variablelist> + <varlistentry> + <term>Scilab</term> + <listitem> + <para/> + <programlisting role=""><![CDATA[ +a=1; +a+[] +// -->a + +a-[] +// -->a + +[]+a +// -->a + +[]-a +// -->-a + ]]></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Matlab</term> + <listitem> + <programlisting role="no-scilab-exec"><![CDATA[ +a+[] -->[] +a-[] -->[] +[]+a -->[] +[]-a -->[] + ]]></programlisting> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>mtlb_mode(%t)</code> alterna para o modo de operaes + para adio e subtrao do Matlab. <code>mtlb_mode(%f)</code> volta + para o modo de operaes do Scilab. + </para> + <para> + <code>mtlb_mode()</code> retorna o valor <varname>mmode</varname> + corrente (<constant>%t</constant>=Matlab, <constant>%f</constant>=Scilab). + </para> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="empty">empty</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/compatibility_functions/help/ru_RU/addchapter.sce b/modules/compatibility_functions/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..c1ccc6161 --- /dev/null +++ b/modules/compatibility_functions/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("Функции для совместимости",SCI+"/modules/compatibility_functions/help/ru_RU",%T); + diff --git a/modules/compatibility_functions/help/ru_RU/mtlb_mode.xml b/modules/compatibility_functions/help/ru_RU/mtlb_mode.xml new file mode 100755 index 000000000..1199c3159 --- /dev/null +++ b/modules/compatibility_functions/help/ru_RU/mtlb_mode.xml @@ -0,0 +1,80 @@ +<?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="mtlb_mode"> + <refnamediv> + <refname>mtlb_mode</refname> + <refpurpose>переключение на операции в стиле Matlab'а</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + mmode = mtlb_mode() + mtlb_mode(mmode) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>mmode</term> + <listitem> + <para>логическое значение</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Суммирования и вычитания в Scilab'е и Matlab'е + работают по-разному при использовании пустых + матриц: + </para> + <variablelist> + <varlistentry> + <term>Scilab</term> + <listitem> + <para/> + <programlisting><![CDATA[ +a=1; +a+[] +// -->a + +a-[] +// -->a + +[]+a +// -->a + +[]-a +// -->-a + ]]></programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Matlab</term> + <listitem> + <programlisting role = "no-scilab-exec"><![CDATA[ +a+[] -->[] +a-[] -->[] +[]+a -->[] +[]-a -->[] + ]]></programlisting> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>mtlb_mode(%t)</code> переключает на режим вычисления в стиле Matlab'а для суммирований и вычитаний. <code>mtlb_mode(%f)</code> переключает обратно в режим Scilab'а. + </para> + <para> + <code>mtlb_mode()</code> возвращает текущее значение <varname>mmode</varname> (<constant>%t</constant> для Matlab'а, <constant>%f</constant> для Scilab'а). + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="empty">empty</link> + </member> + </simplelist> + </refsection> +</refentry> |