diff options
Diffstat (limited to 'modules/functions/help')
210 files changed, 24558 insertions, 0 deletions
diff --git a/modules/functions/help/en_US/addchapter.sce b/modules/functions/help/en_US/addchapter.sce new file mode 100755 index 000000000..79648193d --- /dev/null +++ b/modules/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("Advanced functions",SCI+"/modules/functions/help/en_US",%T); + diff --git a/modules/functions/help/en_US/argn.xml b/modules/functions/help/en_US/argn.xml new file mode 100755 index 000000000..15d81342b --- /dev/null +++ b/modules/functions/help/en_US/argn.xml @@ -0,0 +1,57 @@ +<?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="argn"> + <refnamediv> + <refname>argn</refname> + <refpurpose>Returns the number of input/output arguments in a function call</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[lhs [,rhs] ]=argn() + lhs=argn(1) + rhs=argn(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This function is used inside a function definition. + It gives the number of actual inputs arguments (<varname>rhs</varname>) + and output arguments (<varname>lhs</varname>) passed to the function when the function is + called. It is usually used in function definitions to deal with + optional arguments. + </para> + <para> + <note> + Note that <varname>lhs</varname> is always greater than or equal to 1. That is to say, even if a function + is called without having mentioned an output argument, <varname>lhs</varname> will be equal to 1. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function concat=myOwnFunction(name,optional) + [lhs,rhs]=argn(0); + disp(lhs); + if rhs <= 1 then + optional="my Optional value"; + end + if rhs == 0 then + error("Expect at least one argument"); + end + concat=name+" "+optional; +endfunction + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/CHAPTER b/modules/functions/help/en_US/built_in/CHAPTER new file mode 100755 index 000000000..4beffcea0 --- /dev/null +++ b/modules/functions/help/en_US/built_in/CHAPTER @@ -0,0 +1,2 @@ +title = Built-in & external + diff --git a/modules/functions/help/en_US/built_in/clearfun.xml b/modules/functions/help/en_US/built_in/clearfun.xml new file mode 100755 index 000000000..7faf9e022 --- /dev/null +++ b/modules/functions/help/en_US/built_in/clearfun.xml @@ -0,0 +1,66 @@ +<?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="clearfun"> + <refnamediv> + <refname>clearfun</refname> + <refpurpose>removes primitive </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>ret=clearfun('name')</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>'name'</term> + <listitem> + <para>name of primitive</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ret</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>'name'</term> + <listitem> + <para>name of primitive</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ret</term> + <listitem> + <para>a boolean</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>clearfun('name')</literal> removes the primitive <literal>'name'</literal> from the + set of primitives (built-in functions). <literal>clearfun</literal> returns + <literal>%t</literal> or <literal>%f</literal>. + This function allows to rename a primitive : a Scilab primitive can be replaced by a + user-defined function. For experts... + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="funptr">funptr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/external.xml b/modules/functions/help/en_US/built_in/external.xml new file mode 100755 index 000000000..30a2c856a --- /dev/null +++ b/modules/functions/help/en_US/built_in/external.xml @@ -0,0 +1,86 @@ +<?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="external"> + <refnamediv> + <refname>external</refname> + <refpurpose>Scilab Object, external function or routine</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + External function or routine for use with specific commands. + </para> + <para> + An "external" is a function or routine which is used as an argument + of some high-level primitives (such as <literal>ode</literal>, <literal>optim</literal>, <literal>schur</literal>...). + </para> + <para> + The calling sequence of the external (function or routine) is imposed by + the high-level primitive which sets the arguments of the external. + </para> + <para> + For example the external function <literal>costfunc</literal> is an argument of the <literal>optim</literal> + primitive. Its calling sequence must be: <literal>[f,g,ind]=costfunc(x,ind)</literal> and + <literal>optim</literal> (the high-level optimization primitive) is invoked as follows: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +optim(costfunc,...) + ]]></programlisting> + <para> + Here <literal>costfunc</literal> (the cost function to be minimized by the primitive <literal>optim</literal>) + evaluates <literal>f=f(x)</literal> and <literal>g=</literal> gradient of <literal>f</literal> at <literal>x</literal> (<literal>ind</literal> is an integer. Its use is precised in the <literal>optim</literal> help). + </para> + <para> + If other values are needed by the external function these variables + can be defined in its environment. Also, they can be put in a list. + For example, the external function + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +[f,g,ind]=costfunc(x,ind,a,b,c) + ]]></programlisting> + <para> + is valid for <literal>optim</literal> if the external is <literal>list(costfunc,a,b,c)</literal> and + the call to <literal>optim</literal> is then: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +optim(list(costfunc,a1,b1,c1),.... + ]]></programlisting> + <para> + An external can also be a Fortran or C routine : this is convenient to speed up + the computations. + </para> + <para> + The name of the routine is given to the high-level primitive + as a character string. The calling sequence of the routine + is also imposed. + </para> + <para> + External Fortran or C routines can also be dynamically linked (see <literal>link</literal>). + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ode">ode</link> + </member> + <member> + <link linkend="optim">optim</link> + </member> + <member> + <link linkend="impl">impl</link> + </member> + <member> + <link linkend="dassl">dassl</link> + </member> + <member> + <link linkend="intg">intg</link> + </member> + <member> + <link linkend="schur">schur</link> + </member> + <member> + <link linkend="gschur">gschur</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/funptr.xml b/modules/functions/help/en_US/built_in/funptr.xml new file mode 100755 index 000000000..1586da4aa --- /dev/null +++ b/modules/functions/help/en_US/built_in/funptr.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="funptr"> + <refnamediv> + <refname>funptr</refname> + <refpurpose>coding of primitives ( wizard stuff ) </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[numptr] = funptr(name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para>a string, the name of a primitive</para> + </listitem> + </varlistentry> + <varlistentry> + <term>numptr</term> + <listitem> + <para>the internal routine number of the primitive</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Utility function (for experts only) to get the internal routine number <literal>numptr</literal> + of the primitive <literal>'name'</literal>. <literal>numptr</literal> is formed from the interface + number <literal>fun</literal> and the routine number <literal>fin</literal> of the primitive in its interface + by <literal>numptr = 1000*fun + fin</literal> (fin < 1000). From <literal>numptr</literal> you can get + the interface number <literal>fun = floor(numptr/1000)</literal> which may be useful to link a + dynamical interface with arguments passed by reference (see example section). + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Suppose you want to load some codes via the dynamic +// loading facilities offers by addinter. By default +// arguments are passed by values but if you want to +// pass them by reference you can do the following +// (name being the scilab name of one of the interfaced +// routines) : +// +// addinter(files,spnames,fcts) // args passed by values +// num_interface = floor(funptr(name)/1000) +// intppty(num_interface) // args now passed by reference +// +// Note that if you enter the following +// +// intppty() +// +// you will see all the interfaces working by reference + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="intppty">intppty</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/intppty.xml b/modules/functions/help/en_US/built_in/intppty.xml new file mode 100755 index 000000000..aeb615937 --- /dev/null +++ b/modules/functions/help/en_US/built_in/intppty.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="intppty"> + <refnamediv> + <refname>intppty</refname> + <refpurpose>set interface argument passing properties</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>funs=intppty() + intppty(fun) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para> + integer, an interface number (see <link linkend="funptr">funptr</link>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>funs</term> + <listitem> + <para> + integer vector, vector of interface number (see <link linkend="funptr">funptr</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The interface programs may be written in 2 different ways for the mode + of function argument passing. + </para> + <para> + In the first and default way, the arguments are passed by value. + With the following syntax: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + the argument associated with <literal>A</literal> will be passed by value (a copy + of <literal>A</literal> is made before <literal>foo</literal> is called), and + the argument associated with <literal>1+2</literal> will be passed by value. + </para> + <para> + In + the second way arguments may be passed be reference if there are + "named arguments" (no copy of the variable value is + done). <literal>intppty(fun)</literal> with <literal>fun>0</literal> tells Scilab that the + interface with number <literal>fun</literal> can handle arguments passed by + reference. With the following syntax: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + the argument associated with <literal>A</literal> will be passed by reference, and + the argument associated with <literal>1+2</literal> will be passed by value. + </para> + <para> + <warning> + Warning: declaring that the interface with number + <literal>fun</literal> can handle arguments passed by reference if it is not the + case should produce unpredictable results. + </warning> + </para> + <para> + <literal>intppty(fun)</literal> with <literal>fun<0</literal> suppress this property + for the interface <literal>-fun</literal>. + </para> + <para> + <literal>intppty()</literal> returns the vector of interfaces which handle + arguments passed by reference. + </para> + <para> + This function may be useful for dynamically loaded interface (see <link linkend="addinter">addinter</link>). + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="funptr">funptr</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/newfun.xml b/modules/functions/help/en_US/built_in/newfun.xml new file mode 100755 index 000000000..6a54ece2e --- /dev/null +++ b/modules/functions/help/en_US/built_in/newfun.xml @@ -0,0 +1,85 @@ +<?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: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="newfun" xml:lang="en"> + <refnamediv> + <refname>newfun</refname> + <refpurpose>add a name in the table of functions</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>newfun(function_name, function_ptr)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para>a character string, giving a valid function name</para> + </listitem> + </varlistentry> + <varlistentry> + <term>function_ptr</term> + <listitem> + <para>a positive number with integer value (see below)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Utility function (for experts only). </para> + <para> + Adds the name <literal>function_name</literal> in the table of + functions known to the interpreter. + </para> + <para> + <literal>function_ptr</literal> is an integer + <literal>1000*fun+fin</literal> where <literal>fun</literal> and + <literal>fin</literal> are the internal coding of the primitive + <literal>function_name</literal>. + </para> + <para>This function may be useful to associate a primitive to a + gateway called in <literal>"gw_user.c"</literal> + (<literal>fun=14</literal>). Note however that the <link linkend="ilib_build">ilib_build</link> function is a more easy way + to extend Scilab with new functions based on C, C++ or Fortran + code. + </para> + <para>This function may also be used to add an alias or to rename + to an existing primitive function. + </para> + <para> + Used with <literal>funptr</literal> and <literal>clearfun</literal> + one can add an alias or rename an existing primitive function. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + absptr=funptr("abs");// get the function_ptr associated with the abs function + newfun("abs_bis",absptr) // create an alias of the abs function + abs_bis(-1+%i) + clearfun("abs") // remove abs as a known function + + //redefine abs + function y=abs(x) + y=abs_bis(real(x)); + endfunction + + abs(-1+%i) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + <member> + <link linkend="funptr">funptr</link> + </member> + <member> + <link linkend="ilib_build">ilib_build</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/readgateway.xml b/modules/functions/help/en_US/built_in/readgateway.xml new file mode 100755 index 000000000..a4ae68416 --- /dev/null +++ b/modules/functions/help/en_US/built_in/readgateway.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="readgateway" xml:lang="en"> + <refnamediv> + <refname>readgateway</refname> + <refpurpose>get primitives list of a module</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>readgateway(module_name) + primitives = readgateway(module_name); + [primitives,primitivesID] = readgateway(module_name); + [primitives,primitivesID,gatewayID] = readgateway(module_name); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>module_name</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + <varlistentry> + <term>primitives, primitivesID, gatewayID</term> + <listitem> + <para>matrices of string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>readgateway(module_name)</literal> gets primitives list of a + <literal>module_name</literal>. + </para> + <para> + <literal>primitives</literal>: list of primitives of a <literal>module_name</literal>. + </para> + <para> + <literal>primitivesID</literal>: list of ID for primitives. + </para> + <para> + <literal>gatewayID</literal>: list of ID of gateway associated to a + <literal>module_name</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[primitives,primitivesID,gatewayID] = readgateway('core'); +primitives(1) // 'debug' primitive +primitivesID(1) // 1 is ID of 'debug' in 'core' gateway +gatewayID(1) // 13 is ID of 'core' gateway in scilab + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getmodules">getmodules</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/built_in/what.xml b/modules/functions/help/en_US/built_in/what.xml new file mode 100755 index 000000000..400c69828 --- /dev/null +++ b/modules/functions/help/en_US/built_in/what.xml @@ -0,0 +1,19 @@ +<?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="what"> + <refnamediv> + <refname>what</refname> + <refpurpose>list the Scilab + primitives + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>what() + [primitives,commands]=what(); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para>List of low level primitives and commands.</para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/bytecode.xml b/modules/functions/help/en_US/bytecode.xml new file mode 100755 index 000000000..23f1412de --- /dev/null +++ b/modules/functions/help/en_US/bytecode.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) ????-2008 - INRIA Serge Steer + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="bytecode"> + <refnamediv> + <refname>bytecode</refname> + <refpurpose>given a function returns the "bytecode" of a function in a Scilab array and conversely. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + x = bytecode(f) + f = bytecode(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>f</term> + <listitem> + <para> + A Scilab function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + an int32 row vector + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>x = bytecode(f)</code> returns the "bytecode" of + the function <varname>f</varname> in the Scilab integer array + <varname>x</varname>. + </para> + <para> + <code>f= bytecode(x)</code> returns in + <varname>f</varname> the function associated with the + "bytecode" given in the Scilab integer array + <varname>x</varname>. + <warning> + Warning: the validity of <varname>x</varname> is not checked. + </warning> + </para> + </refsection> + <refsection> + <title>Remark</title> + <para> + The bytecode of Scilab function will evolve drastically in the + future, so the use of this function should be restricted to the + profiling instruction handling. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function a=foo(),a=sin(3),endfunction +bytecode(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="bytecodewalk">bytecodewalk</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/bytecodewalk.xml b/modules/functions/help/en_US/bytecodewalk.xml new file mode 100755 index 000000000..5b7658c50 --- /dev/null +++ b/modules/functions/help/en_US/bytecodewalk.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Ajouter ici d'éventuels commentaires sur le fichier XML +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" 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="bytecodewalk"> + <refnamediv> + <refname>bytecodewalk</refname> + <refpurpose>walk in function bytecode applying transformation. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>c1 = bytecodewalk(code,query,job)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>code</term> + <listitem> + <para> + int32 vector: input byte code array + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>query</term> + <listitem> + <para> + integer, the opcode to look for + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>job</term> + <listitem> + <para> + the operation to perform, for the requested opcode + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>c1</term> + <listitem> + <para> + int32 vector: output byte code array + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + walk in function bytecode applying transformation. + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="bytecode">bytecode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/code2str.xml b/modules/functions/help/en_US/code2str.xml new file mode 100755 index 000000000..3375c0c92 --- /dev/null +++ b/modules/functions/help/en_US/code2str.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="code2str" xml:lang="en"> + <refnamediv> + <refname>code2str</refname> + <refpurpose>returns character string associated with Scilab integer + codes. <emphasis role="bold">This function is obsolete.</emphasis> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>str = code2str(c)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>str</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>a vector of character integer codes.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>str = code2str(c)</code> returns character string + associated with Scilab integer codes. <varname>str</varname> + is such that <literal>c(i)</literal> is the Scilab integer + code of <literal>part(str,i)</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +code2str([-28 12 18 21 10 11]) +str2code('Scilab')' + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="str2code">str2code</link> + </member> + <member> + <link linkend="ascii">ascii</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>This function will be removed in Scilab 6.0.0</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/comp.xml b/modules/functions/help/en_US/comp.xml new file mode 100755 index 000000000..b46b85413 --- /dev/null +++ b/modules/functions/help/en_US/comp.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: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="comp" xml:lang="en"> + <refnamediv> + <refname>comp</refname> + <refpurpose>scilab function compilation</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>comp(function [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>function</term> + <listitem> + <para>a scilab function, not compiled (type 11)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>flag with value 0 (default), 1 or 2.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>comp(function)</literal> compiles the function + <literal>function</literal>. Compiled and interpreted functions are + equivalent but usually compiled functions are much faster. The functions + provided in the standard libraries are compiled. + </para> + <para>The online definition as well as the short syntax of the commands + <literal>exec</literal> and <literal>deff</literal> generate compiled + functions. So <literal>comp</literal> has to be used in very particular cases. To produce + uncompiled functions one must use <link linkend="exec">exec</link> or + <link linkend="deff">deff</link> with the option <literal>"n"</literal>. + </para> + <para> + The value <literal>opt==2</literal> causes the function to be compiled "for profiling". + Note that now it is possible to add profiling instruction after + compilation using the <link linkend="add_profiling">add_profiling</link> function. + </para> + <para> + The obsolete <literal>opt==1</literal> option was specific to code analysis purposes and + is now ignored, i.e treated as <literal>opt==0</literal>. + </para> + <para>Note: the compilation takes part "in place", i.e the original + function is modified and no new object is created. + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/deff.xml b/modules/functions/help/en_US/deff.xml new file mode 100755 index 000000000..d9bcc3516 --- /dev/null +++ b/modules/functions/help/en_US/deff.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="deff"> + <refnamediv> + <refname>deff</refname> + <refpurpose>on-line definition of function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>deff('[s1, s2, ...] = newfunction(e1, e2, ...)',text [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>e1, e2, ...</term> + <listitem> + <para>input variables.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s1, s2, ...</term> + <listitem> + <para>output variables.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para>a matrix of character strings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>an optional character string:</para> + <variablelist> + <varlistentry> + <term>'c'</term> + <listitem> + <para>function is "compiled" to be more efficient (default);</para> + </listitem> + </varlistentry> + <varlistentry> + <term>'p'</term> + <listitem> + <para> + function is "compiled" and prepared for profiling (see help <link linkend="profile">profile</link>); + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>'n'</term> + <listitem> + <para>function is not "compiled".</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>deff</function> can be used to define functions from sequences of instructions + written in text strings. The resulting function object has the same properties + of any other function defined in a text file and loaded with <function>exec</function>. + </para> + <para> + Quotes in the instructions (delimiting strings or meaning matrix transposition) + have to be doubled to be interpreted correctly (see help <link linkend="quote">quote</link>). This can make + writing up a little awkward. + An option in such cases is to define functions in files as usual, to load them into + Scilab by <function>exec</function> (with the <literal>'n'</literal> option) and to use + <function>sci2exp</function> to get a printout of corresponding <function>deff</function> + instructions. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +deff('[x]=myplus(y,z)','x=y+z') + +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="quote">quote</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/edit.xml b/modules/functions/help/en_US/edit.xml new file mode 100755 index 000000000..0722c155d --- /dev/null +++ b/modules/functions/help/en_US/edit.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="edit" xml:lang="en"> + <refnamediv> + <refname>edit</refname> + <refpurpose>function editing</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>edit(functionname[,linenumber])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>functionname</term> + <listitem> + <para>character string</para> + </listitem> + </varlistentry> + <varlistentry> + <term>linenumber</term> + <listitem> + <para>integer</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + If <literal>functionname</literal> is the name of a defined scilab function + <literal>edit(functionname)</literal> try to open the associated file + <literal>functionname.sci</literal>. + </para> + <para> + If <literal>functionname</literal> is the name of a undefined scilab function + <literal>edit(functionname)</literal> create a <literal>functionname.sci</literal> file in + the current directory. + </para> + <para> + If <literal>functionname</literal> is not a valid macro or function name + <literal>edit(functionname)</literal> opens the file with file name equal to + <literal>functionname</literal>. + </para> + <para> + If <literal>linenumber</literal> is given, the file is opened at this line relatively to the definition of the macro named as the file itself. If the macro definition is not found, the file is opened at line given by <literal>linenumber</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//open editor with text of this function +edit('edit') + +//open editor for a new function +edit('myfunction') + +//open the file bar.sci in TMPDIR directory +edit(fullfile(TMPDIR+'bar.sci')) + +// open the file test_run.sci at line 123 +// relatively to the definition of test_run() +edit('test_run', 123) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="manedit">manedit</link> + </member> + <member> + <link linkend="names">names</link> + </member> + <member> + <link linkend="editor">editor</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/exec.xml b/modules/functions/help/en_US/exec.xml new file mode 100755 index 000000000..56ad8a7f0 --- /dev/null +++ b/modules/functions/help/en_US/exec.xml @@ -0,0 +1,186 @@ +<?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="exec"> + <refnamediv> + <refname>exec</refname> + <refpurpose>script file execution</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>exec(path [,mode]) + exec(fun [,mode]) + ierr = exec(path, 'errcatch' [,mode]) + ierr = exec(fun, 'errcatch' [,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a string, the path of the script file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para>an integer scalar, the execution mode (see below).</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fun</term> + <listitem> + <para>a Scilab function.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>an integer, 0 or error number.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>exec(path [,mode])</code> executes sequentially the Scilab instructions + contained in the file given by <varname>path</varname> with an optional + execution mode <varname>mode</varname>. + </para> + <para> + The different cases for <varname>mode</varname> are : + </para> + <variablelist> + <varlistentry> + <term>0</term> + <listitem> + <para> + the default value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>-1</term> + <listitem> + <para> + nothing is printed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>1</term> + <listitem> + <para> + echo of each command line. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + prompt <literal>--></literal> is printed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>3</term> + <listitem> + <para> + echoes + prompts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + stops before each prompt. Execution resumes after a carriage return. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para> + stops + prompts + echoes : useful mode for demos. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>exec(fun [,mode])</code> executes function <varname>fun</varname> as a script: no + input nor output argument nor specific variable environment. This form + is more efficient, because script code may be pre-compiled (see <link linkend="comp">comp</link>). This method for script evaluation allows to store scripts as + function in libraries. + </para> + <para> + If an error is encountered while executing, if <literal>'errcatch'</literal> flag is + present <function>exec</function> issues no error message, aborts execution of the + instructions and resumes with <varname>ierr</varname> equal to the error + number. If <literal>'errcatch'</literal> flag is not present, standard error handling + works. + </para> + </refsection> + <refsection> + <title>Remarks</title> + <para> + <function>exec</function> files may now be used to define functions using the inline function definition syntax (see <link linkend="function">function</link>). + </para> + <para> + <function>exec</function> supports files encoded as ANSI/ASCII and UTF-8. + </para> + <para>The length of each line in a file is limited to 4096 characters.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// create a script file +mputl('a=1;b=2',TMPDIR+'/myscript') + +// execute it +exec(TMPDIR+'/myscript') +whos -name "a " + +// create a function +deff('y=foo(x)','a=x+1;y=a^2') +clear a b +// call the function +foo(1) +// a is a variable created in the environment of the function foo +// it is destroyed when foo returns +whos -name "a " + +x=1 //create x to make it known by the script foo +exec(foo) + +// a and y are created in the current environment +whos -name "a " +whos -name "y " +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="mode">mode</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/execstr.xml b/modules/functions/help/en_US/execstr.xml new file mode 100755 index 000000000..2ec8112b1 --- /dev/null +++ b/modules/functions/help/en_US/execstr.xml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="execstr"> + <refnamediv> + <refname>execstr</refname> + <refpurpose>execute Scilab code in strings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>execstr(instr) + ierr = execstr(instr,'errcatch' [,msg]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>instr</term> + <listitem> + <para>a vector of character strings, Scilab instruction to be executed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>an integer, 0 or error number.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para> + a character string with values <literal>'m'</literal> or <literal>'n'</literal>. Default value is <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Executes the Scilab instructions given in argument + <varname>instr</varname>. + </para> + <note> + Note that <varname>instr</varname> should not make use of continuation marks (..) + </note> + <para> + If the <literal>'errcatch'</literal> flag is not present, error handling works as usual. + </para> + <para> + If the <literal>'errcatch'</literal> flag is set, and an error is encountered while + executing the instructions defined in <varname>instr</varname>, <function>execstr</function> + issues no error message, but aborts execution of the <varname>instr</varname> + instructions (at the point where the error occurred), and resumes with + <varname>ierr</varname> equal to the error number. In this case the display of the + error message is controlled by the <varname>msg</varname> option: + </para> + <variablelist> + <varlistentry> + <term>"m"</term> + <listitem> + <para>error message is displayed and recorded.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"n"</term> + <listitem> + <para> + no error message is displayed, but the error message is recorded (see <link linkend="lasterror">lasterror</link>). This is the default. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>ierr = execstr(instr, 'errcatch')</code> can handle syntactical errors. This is + useful for evaluation of instruction obtained by a query to the user. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +execstr('a=1') // sets a=1. +execstr('1+1') // does nothing (while evstr('1+1') returns 2) + +execstr(['if %t then'; + ' a=1'; + ' b=a+1'; + 'else' + ' b=0' + 'end']) + +execstr('a=zzzzzzz','errcatch') +execstr('a=zzzzzzz','errcatch','m') + +//syntax errors +execstr('a=1?02','errcatch') +lasterror(%t) + +execstr('a=[1 2 3)','errcatch') +lasterror(%t) + +// variable1 does not exist +if execstr('variable1;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end + +// variable2 exists ... no error is triggered by execstr +variable2=[2,3]; +if execstr('variable2;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="lasterror">lasterror</link> + </member> + <member> + <link linkend="error">error</link> + </member> + <member> + <link linkend="try">try</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/fun2string.xml b/modules/functions/help/en_US/fun2string.xml new file mode 100755 index 000000000..18b8689f4 --- /dev/null +++ b/modules/functions/help/en_US/fun2string.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fun2string"> + <refnamediv> + <refname>fun2string</refname> + <refpurpose>generates ASCII definition of a Scilab function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>txt = fun2string(fun, name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para> + a <literal>function</literal> type variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>a character string, the generated function name.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>a column vector of strings, the text giving the Scilab instructions.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Given a loaded Scilab function pseudo-code <function>fun2string</function> allows to + re-generate the code. The generated + code is indented and beautified. + </para> + <para> + The mechanism is similar, but simpler than the <function>mfile2sci</function> one. It may + be adapted for syntax translations. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +txt = fun2string(asinh,'foo'); +write(%io(2),txt,'(a)') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="edit">edit</link> + </member> + <member> + <link linkend="macrovar">macrovar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/funcprot.xml b/modules/functions/help/en_US/funcprot.xml new file mode 100755 index 000000000..4d7805723 --- /dev/null +++ b/modules/functions/help/en_US/funcprot.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="en" xml:id="funcprot"> + <refnamediv> + <refname>funcprot</refname> + <refpurpose>switch scilab functions protection mode</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>funcprot(prot) + previousprot = funcprot(prot) + prot = funcprot() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>prot</term> + <listitem> + <para>an integer with possible values 0, 1, 2</para> + </listitem> + </varlistentry> + <varlistentry> + <term>previousprot</term> + <listitem> + <para>an integer with possible values 0, 1, 2 returns previous value</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Scilab functions are variable, <function>funcprot</function> allows the user to specify + what Scilab do when such variables are redefined. + </para> + <itemizedlist> + <listitem> + <para> + If <code>prot == 0</code> nothing special is done. + </para> + </listitem> + <listitem> + <para> + If <code>prot == 1</code> Scilab issues a warning message when a function is redefined (default mode). + </para> + </listitem> + <listitem> + <para> + If <code>prot == 2</code> Scilab issues an error when a function is redefined. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +previousprot = funcprot(1) +deff('x = foo(a)','x = a;') +deff('x = foo(a)','x = a + 1;') +foo = 33 +funcprot(0) +deff('x = foo(a)', 'x = a;') +deff('x = foo(a)', 'x = a + 1;') +foo = 33 +funcprot(previousprot) +]]></programlisting> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>Previous value is returned as output argument when setting a new value.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/function.xml b/modules/functions/help/en_US/function.xml new file mode 100755 index 000000000..14e32bca6 --- /dev/null +++ b/modules/functions/help/en_US/function.xml @@ -0,0 +1,140 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="function"> + <refnamediv> + <refname>function</refname> + <refpurpose>opens a function definition</refpurpose> + </refnamediv> + <refnamediv xml:id="endfunction"> + <refname>endfunction</refname> + <refpurpose>closes a function definition</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <programlisting role='no-scilab-exec'><![CDATA[ +function <lhs_arguments>=<function_name><rhs_arguments> + <statements> +endfunction + ]]></programlisting> + <para> + Where + </para> + <variablelist> + <varlistentry> + <term><function_name></term> + <listitem> + <para>stands for the name of the function</para> + </listitem> + </varlistentry> + <varlistentry> + <term><rhs_arguments></term> + <listitem> + <para>stands for the input argument list. It may be</para> + <itemizedlist> + <listitem> + <para> + a comma separated sequence of variable names enclosed in parenthesis, like <literal>(x1,...,xm)</literal>. Last variable name can be the key word <literal>varargin</literal> (see <link linkend="varargin">varargin</link>) + </para> + </listitem> + <listitem> + <para> + the sequence <literal>()</literal> or nothing, if the function has no input argument. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><lhs_arguments></term> + <listitem> + <para>stands for the output argument list. It may be</para> + <itemizedlist> + <listitem> + <para> + a comma separated sequence of variable names enclosed in brackets, like <literal>[y1,...,yn]</literal>. Last variable name can be the key word <literal>varargout</literal> (see <link linkend="varargout">varargout</link>) + </para> + </listitem> + <listitem> + <para> + the sequence <literal>[]</literal>, if the function has no output argument. In this case the syntax may also be: <literal>function <function_name><rhs_arguments></literal> + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><statements></term> + <listitem> + <para> + stands for a set of Scilab instructions (statements). This syntax may be used to define function (see <link linkend="functions">functions</link>) inline or in a script file (see <link linkend="exec">exec</link>). For compatibility with old Scilab versions, functions defined in a script file containing only function definitions can be "loaded" into Scilab using the <function>exec</function> function. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The <literal>function <lhs_arguments>=<function_name><rhs_arguments></literal> + sequence cannot be split over several lines. This sequence can be + followed by statements in the same line if a comma or a semicolon is + added at its end. + </para> + <note> + Note that <literal><function_name></literal> must respect some syntax rules (see <link linkend="names">names</link>). + </note> + <para> + Function definitions can be nested. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//inline definition (see function) +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +//an one line function definition +function y=sq(x),y=x^2,endfunction + +sq(3) + +//nested functions definition +function y=foo(x) +a=sin(x) +function y=sq(x), y=x^2,endfunction +y=sq(a)+1 +endfunction + +foo(%pi/3) + +// definition in a script file (see exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="functions">functions</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="names">names</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/functions.xml b/modules/functions/help/en_US/functions.xml new file mode 100755 index 000000000..436d99701 --- /dev/null +++ b/modules/functions/help/en_US/functions.xml @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="functions"> + <refnamediv> + <refname>functions</refname> + <refpurpose>Scilab procedures and Scilab objects</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Functions are Scilab procedures ("macro", "function" and "procedure" + have the save meaning). + </para> + </refsection> + <refsection> + <title>Function definition</title> + <para>Usually, they are defined in files with an editor and loaded into + Scilab using the <link linkend="exec">exec</link> function or through a library (see + <link linkend="lib">lib</link> or <link linkend="genlib">genlib</link>). But they can also be + defined on-line (see <link linkend="deff">deff</link> or <link linkend="function">function</link>. + A function is defined by two components: + </para> + <itemizedlist> + <listitem> + <para>a "syntax definition" part as follows:</para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) +function [y1,...,yn,varargout]=foo(x1,...,xm,varargin) + ]]></programlisting> + </listitem> + <listitem> + <para>a sequence of Scilab instructions.</para> + </listitem> + </itemizedlist> + <para>The "syntax definition" line gives the "full" calling syntax of + this function. The <literal>yi</literal> are output variables + calculated as functions of input variables <literal>xi</literal> + and variables existing in Scilab when the function is + executed. + </para> + </refsection> + <refsection> + <title>Calling function</title> + <itemizedlist> + <listitem> + <para>Usually function calling syntax is + <literal>[y1,...,yn]=foo(x1,...,xm)</literal>. Shorter input or + output argument list than definition ones may be used. In such + cases, only the first variables from the left are used or set. + </para> + <para> + The <link linkend="argn">argn</link> function may be used to get + the actual number of calling arguments. + </para> + </listitem> + <listitem> + <para>It is possible to define function with indeterminate + number of input or output maximum number of arguments. This + can be done using the <link linkend="varargin">varargin</link> + and <link linkend="varargout">varargout</link> + keywords. See the given links for details. + </para> + </listitem> + <listitem> + <para>It is also possible to use "named argument" to specify input + arguments: suppose function <function>fun1</function> defined as + <code>function y1 = fun1(x1, x2, x3)</code> then it can be + called with a syntax like + <code>y = fun1(x1=33, x3=[1 2 3])</code> + within <function>fun1</function> <varname>x2</varname> will be + undefined. + </para> + <para> It can also be called with a syntax like + <code>y = fun1(x1=33, y='foo')</code>. In such a case the + <varname>y</varname> variable will be available in the context + of the function <function>fun1</function>. + <note> + Note that the maximum number of argument must be + less or equal to the number of formal input + argument used in the function syntax part. + </note> + </para> + <para> + It is possible to check for defined variables with + the <link linkend="exists">exists</link> function. + </para> + </listitem> + <listitem> + <para> + When a function has no left hand side argument and + is called only with character string arguments, the + calling syntax may be simplified: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun('a','toto','a string') + ]]></programlisting> + <para>is equivalent to: </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun a toto 'a string' + ]]></programlisting> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Miscellaneous</title> + <para> + Functions are Scilab objects (with type numbers 13 or 11). And they can be manipulated (built, saved, loaded, passed as + arguments,...) as other variable types. + </para> + <para>Collections of functions can be collected in libraries. Functions + which begin with <literal>%</literal> sign + (e.g. <literal>%foo</literal>) are often used to overload (see <link linkend="overloading">overloading</link>) operations or functions for new data type. + </para> + <para> + Note that a function name must respect some syntax rules (see <link linkend="names">names</link>). + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//inline definition (see function) +function [x,y]=myfct(a,b) + x=a+b + y=a-b +endfunction + +[x,y]=myfct(3,2) + +//inline definition (see deff) +deff('[x,y]=myfct(a,b)',['x=a+b'; + 'y=a-b']) +// definition in an ascii file (see exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="exists">exists</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + <member> + <link linkend="names">names</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/getd.xml b/modules/functions/help/en_US/getd.xml new file mode 100755 index 000000000..0ec8f0604 --- /dev/null +++ b/modules/functions/help/en_US/getd.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getd"> + <refnamediv> + <refname>getd</refname> + <refpurpose>Load all functions defined in a directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>getd(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a string. The directory pathname.</para> + <para> + "." if <function>getd</function> is called without input argument or if <varname>path</varname> is an empty string. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Loads all <literal>.sci</literal> files (containing Scilab functions) defined in + the <varname>path</varname> directory. + </para> + <para> + If the file does not contain a function, the script will be executed. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +getd('SCI/modules/cacsd/macros') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/head_comments.xml b/modules/functions/help/en_US/head_comments.xml new file mode 100755 index 000000000..80b83fe82 --- /dev/null +++ b/modules/functions/help/en_US/head_comments.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) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="head_comments"> + <refnamediv> + <refname>head_comments</refname> + <refpurpose>display Scilab function header comments</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + head_comments(name) + head_comments(name,%paths) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para>a character string, the function name.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>%paths</term> + <listitem> + <para> + a character string vector, paths where to look for the associated sci-file. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>head_comments(name)</code> displays the function header comments (like the + Matlab help). The comments are read from the associated sci-file. If <varname>name</varname> + is a function which is in a library the sci-file path is those given by the library + path (see <link linkend="lib">lib</link>). If <varname>name</varname> is a function which is + not in a library, a file with name <varname>name</varname><literal>.sci</literal> is searched in the + directories given by the variable <varname>%paths</varname>. + </para> + <warning> + Warning: most of the Scilab predefined functions have no header comments. + </warning> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +head_comments sinc + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="help">help</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/CHAPTER b/modules/functions/help/en_US/libraries/CHAPTER new file mode 100755 index 000000000..4cd7693b5 --- /dev/null +++ b/modules/functions/help/en_US/libraries/CHAPTER @@ -0,0 +1,2 @@ +title = Libraries + diff --git a/modules/functions/help/en_US/libraries/genlib.xml b/modules/functions/help/en_US/libraries/genlib.xml new file mode 100755 index 000000000..dfb496d06 --- /dev/null +++ b/modules/functions/help/en_US/libraries/genlib.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="genlib"> + <refnamediv> + <refname>genlib</refname> + <refpurpose>build library from functions in given directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>genlib(lib_name [[,dir_name, [ Force [,verb [,Names]]]]) + genlib(lib_name [,path=dir_name] [,verbose=verb] [,force=Force] [,names=Names]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>lib_name: </term> + <listitem> + <para>Scilab string. The variable name of the library to (re)create.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dir_name: </term> + <listitem> + <para>Scilab string. The name of the directory to look for + <literal>.sci</literal>-files. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Force</term> + <listitem> + <para> + boolean value (default value is <literal>%f</literal>). Set it to + <literal>%t</literal> to force the sci-files recompilation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>verb</term> + <listitem> + <para> + boolean values (default value is <literal>%f</literal>). Set it to + <literal>%t</literal> to get information. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Names</term> + <listitem> + <para>a vector of strings, the names of function to include in the + library. By default all the sci-files are taken into account + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + For each <literal>.sci</literal> file in <literal>dir_name</literal> (or only those + specified by the <literal>Names</literal> argument), <literal>genlib</literal> executes a + <literal>exec</literal> and saves the functions to the corresponding <literal>.bin</literal> + file. The <literal>.sci</literal> file must not contain anything but Scilab + functions. If a <literal>.bin</literal> file is newer than the associated + <literal>.sci</literal> file, <literal>genlib</literal> does not translate and save the file. + </para> + <para> + This default behaviour can be changed if <literal>force</literal> is given and + set to <literal>%t</literal>. In this latter case the recompilation is always + performed for each <literal>.sci</literal> file. + </para> + <para> + When all <literal>.sci</literal> files have been processed, <literal>genlib</literal> creates a + library variable named <literal>lib_name</literal> and saves it in the file + <literal>lib</literal> in <literal>dir_name</literal>. If the Scilab variable + <literal>lib_name</literal> is not protected (see <link linkend="predef">predef</link>) this + variable is updated. + </para> + <para> + If <literal>verbose</literal> is et to <literal>%t</literal> information are displayed during + the build process. + </para> + <para> + If <literal>dir_name</literal> argument is not given and if <literal>lib_name</literal> + Scilab variable exists and it is a library dir_name is taken equal to the + <literal>lib_name</literal> library path (update mode). + </para> + </refsection> + <refsection> + <title>Restrictions</title> + <para> + Scilab tacitly assumes that file <literal>foo.sci</literal> defines at least a + function named <literal>foo</literal>. If subsidiary functions are included, + they are made known to Scilab only after the function <literal>foo</literal> + had been referenced. + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/get_function_path.xml b/modules/functions/help/en_US/libraries/get_function_path.xml new file mode 100755 index 000000000..ffb0b93c4 --- /dev/null +++ b/modules/functions/help/en_US/libraries/get_function_path.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="get_function_path"> + <refnamediv> + <refname>get_function_path</refname> + <refpurpose>get source file path of a library function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>path=get_function_path(fun_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun_name</term> + <listitem> + <para>a string, the name of the function</para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>a string, the absolute pathname of the function source file (.sci) or [].</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Given the name of a function get_function_path returns the absolute + pathname of the function source file if the function is defined in a + Scilab library (see lib) or [] if name does not match any library + function. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +get_function_path('median') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="string">string</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/lib.xml b/modules/functions/help/en_US/libraries/lib.xml new file mode 100755 index 000000000..d11a056bf --- /dev/null +++ b/modules/functions/help/en_US/libraries/lib.xml @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="lib"> + <refnamediv> + <refname>lib</refname> + <refpurpose>library definition</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>namelib = lib('lib-dir')</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>lib-dir</term> + <listitem> + <para>character string</para> + </listitem> + </varlistentry> + <varlistentry> + <term>namelib</term> + <listitem> + <para>library variable returned by 'lib'.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>lib-dir</literal> is a character string defining a directory that contains + compiled Scilab function (<literal>.bin</literal>) files. + </para> + <para> + In addition to these files <literal>lib-dir</literal> must have a file called + <literal>names</literal>, that contains the names of the functions defined in + <literal>lib-dir</literal>. On success, all functions in <literal>lib-dir</literal> are + available from within Scilab. They are loaded on demand when called + for the first time. + </para> + <para> + Binary files can be created from within Scilab with the command + <literal>save</literal>. + A library variable + usually is saved for later loading, either on-line or from the + user-specific startup file (see startup). + </para> + <para>value returned by 'lib' must be insert in a variable 'namelib' to access to macro functions of this library.</para> + </refsection> + <refsection> + <title>Restrictions</title> + <para> + Scilab tacitly assumes that each xxxx.bin file defines a variable named <literal>xxxx</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//define some functions +function z = myplus(x, y) + z = x + y +endfunction + +function z = yourplus(x, y) + x = x - y +endfunction + +//create the *.bin files in libdir +libdir = TMPDIR; +save(libdir + '/myplus.bin', myplus); +save(libdir + '/yourplus.bin', yourplus); + +//create the name file +mputl(['myplus';'yourplus'],TMPDIR+'/names'); + +//build the library containing myplus and yourplus +mylibfoo = lib(libdir+'/'); + +//erase the variables +clear myplus yourplus + +//Automatic loading and execution +myplus(1,2) + +//erase the variables +clear myplus yourplus + +mylibfoo +[n,p] = libraryinfo('mylibfoo') + +isdef('myplus') +clear mylibfoo +isdef('myplus') + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="library">library</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="whereis">whereis</link> + </member> + <member> + <link linkend="libraryinfo">libraryinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/librarieslist.xml b/modules/functions/help/en_US/libraries/librarieslist.xml new file mode 100755 index 000000000..3036bf66e --- /dev/null +++ b/modules/functions/help/en_US/libraries/librarieslist.xml @@ -0,0 +1,50 @@ +<?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="librarieslist"> + <refnamediv> + <refname>librarieslist</refname> + <refpurpose>get scilab libraries</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>s=librarieslist()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>a string matrix</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + return in <literal>s</literal> all libraries in the Scilab environment. + </para> + <para>libraries are scanned from the lastest loaded to the first one.</para> + <para>Only macro libraries will be returned. For a module without any macros (ie, a module with only native code), it will not be displayed on the list. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +librarieslist() +// to sort list +l = gsort(librarieslist(),'r','i') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="libraryinfo">libraryinfo</link> + </member> + <member> + <link linkend="gsort">gsort</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/library.xml b/modules/functions/help/en_US/libraries/library.xml new file mode 100755 index 000000000..9a66873c5 --- /dev/null +++ b/modules/functions/help/en_US/libraries/library.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="library"> + <refnamediv> + <refname>library</refname> + <refpurpose>library datatype description + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + A library is a data type with type number 14. It contains a path-name + and a set of names. It allows automatic loading of variables using the + following algorithm: + </para> + <para> + Suppose the Scilab user references the variable named <literal>foo</literal>. + Scilab first looks if <literal>foo</literal> is the name of a primitive or of an + already defined variable. If not, it looks for <literal>foo</literal> sequentially + (the newest first) in all defined library . + </para> + <para> + Suppose <literal>foo</literal> belongs to the set of names of the library <literal>xlib</literal> + then Scilab tries to load the file + <xlib-path-name>/foo.bin. <xlib-path-name>/foo.bin must have been + created using the <literal>save</literal> function + </para> + <para> + Library are often used for collection of functions, but they can also + be used for any collection of scilab variables + </para> + <para> + If a function is defined in more than one library, the default search + algorithm loads thode contained in the newest. It possible to force + the use of a specific library using dot notation: + </para> + <para> + <literal>xlib.foo</literal> loads the variable <literal>foo</literal> contained in <literal>xlib</literal>. + if <literal>foo</literal> is a function + and <literal>xlib.foo(args)</literal> executes the functions + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// elemlib is a predefined library +elementary_functionlib //displays the contents of the library +A=rand(3,3); +cosm(A) //loads cosm and executes it +whos -name cosm // now cosm is a variable +elementary_functionlib.sinm //loads sinm from the library +elementary_functionlib.cosm(A) //reloads cosm and executes it + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="save">save</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/libraryinfo.xml b/modules/functions/help/en_US/libraries/libraryinfo.xml new file mode 100755 index 000000000..c2773a457 --- /dev/null +++ b/modules/functions/help/en_US/libraries/libraryinfo.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="libraryinfo"> + <refnamediv> + <refname>libraryinfo</refname> + <refpurpose>get macros and path of a scilab library</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>macros = libraryinfo(libraryname) + [macros,path] = libraryinfo(libraryname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>macros</term> + <listitem> + <para>a string matrix (all main functions of the library)</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a string (path of library)</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>libraryname</term> + <listitem> + <para>a string (library name)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>get functions names and path of a scilab library.The function names + returned correspond to those which correspond to the associated .sci or .bin + file names. The other ones are subsidiary functions. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[m,p]=libraryinfo('corelib') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="librarieslist">librarieslist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/libraries/whereis.xml b/modules/functions/help/en_US/libraries/whereis.xml new file mode 100755 index 000000000..566413720 --- /dev/null +++ b/modules/functions/help/en_US/libraries/whereis.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="whereis"> + <refnamediv> + <refname>whereis</refname> + <refpurpose>name of library containing a function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[librname]=whereis(function-name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + returns as a character string + the name of the library containing the function <literal>function-name</literal>. + The path of the library is returned by typing <literal>"librname"</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +whereis("ls") // Should return fileiolib +whereis("plot") // Should return graphicslib + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/listfunctions.xml b/modules/functions/help/en_US/listfunctions.xml new file mode 100755 index 000000000..0e6c87d06 --- /dev/null +++ b/modules/functions/help/en_US/listfunctions.xml @@ -0,0 +1,120 @@ +<?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="listfunctions"> + <refnamediv> + <refname>listfunctions</refname> + <refpurpose>properties of all functions in + the workspace + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[flist,compiled,profilable,called] = listfunctions([scope])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>scope</term> + <listitem> + <para> + a string, <literal>"local"</literal> (default) or <literal>"global"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flist</term> + <listitem> + <para> + a string array, names of all the function variables in the specified namespace. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>compiled</term> + <listitem> + <para> + a boolean array, true if the corresponding element of <varname>flist</varname> is of type 13. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>profilable</term> + <listitem> + <para> + a boolean array, true if the corresponding element of <varname>flist</varname> is of type 13, + and additionally profiling information is found in the pseudocode of + the function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>called</term> + <listitem> + <para> + an uint32 array, number of times the corresponding element of <varname>flist</varname> has been + already called (nonzero only for profilable functions). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <itemizedlist> + <listitem> + <para> + This function checks all the variables in the workspace (given by + <link linkend="who">who</link>) and collects those of type 11 or 13; for the latter, + <code>lst = macr2lst(fun)</code> is called, in order to check for the magic + profiling entry at the end of the first codeline, i.e. <code>lst(5)(1)=="25"</code>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +[flist,compiled,profilable,called] = listfunctions(); +flist(profilable) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="recompilefunction">recompilefunction</link> + </member> + <member> + <link linkend="who">who</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Bibliography</title> + <para> + <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/macr2lst.xml b/modules/functions/help/en_US/macr2lst.xml new file mode 100755 index 000000000..9280b20dc --- /dev/null +++ b/modules/functions/help/en_US/macr2lst.xml @@ -0,0 +1,217 @@ +<?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="macr2lst"> + <refnamediv> + <refname>macr2lst</refname> + <refpurpose>function to list conversion</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>lst = macr2lst(function_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para>a function to be converted.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lst</term> + <listitem> + <para>a list.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This primitive converts a compiled Scilab function <varname>function_name</varname> + into a list which codes the internal representation of + the function (reverse Polish notation). + </para> + <para>The first entry of the list is the function name, the second + and third are respectively the vectors of left hand side variables + and right hand side variables names. The following entries are either basic operation records + either lists with contains the hierarchical control structures like + <literal>if</literal>, <literal>for</literal>, ... + </para> + <para>Basic operation records are described by a character string + vector whose first element represents the opcode. + </para> + <informaltable border="1"> + <tr> + <td>op codes</td> + <td>meaning</td> + <td>parameters</td> + </tr> + <tr> + <td>"0"</td> + <td>ignored opcode</td> + <td>none</td> + </tr> + <tr> + <td>"1"</td> + <td>No more used</td> + <td/> + </tr> + <tr> + <td>"2"</td> + <td>variable or function reference</td> + <td>variable name, #rhs, #lhs</td> + </tr> + <tr> + <td>"3"</td> + <td>put a string in the stack</td> + <td>the string</td> + </tr> + <tr> + <td>"4"</td> + <td>put am empty matrix in the stack</td> + <td>none</td> + </tr> + <tr> + <td>"5"</td> + <td>apply an operation</td> + <td>operation code, #rhs,#lhs</td> + </tr> + <tr> + <td>"6"</td> + <td>put a number in the stack</td> + <td>the number</td> + </tr> + <tr> + <td>"12"</td> + <td>pause command</td> + <td>none</td> + </tr> + <tr> + <td>"13"</td> + <td>break command</td> + <td>none</td> + </tr> + <tr> + <td>"14"</td> + <td>abort command</td> + <td>none</td> + </tr> + <tr> + <td>"15"</td> + <td>end of line mark</td> + <td>none</td> + </tr> + <tr> + <td>"17"</td> + <td>quit command</td> + <td>none</td> + </tr> + <tr> + <td>"18"</td> + <td>named variable</td> + <td>variable name</td> + </tr> + <tr> + <td>"19"</td> + <td>create recursive index structure</td> + <td>path length, number of final indices</td> + </tr> + <tr> + <td>"20"</td> + <td>function call</td> + <td>function name, #rhs, #lhs </td> + </tr> + <tr> + <td>"23"</td> + <td>create variable from name</td> + <td>variable name</td> + </tr> + <tr> + <td>"24"</td> + <td>put a variable with type 0 in the stack</td> + <td>none</td> + </tr> + <tr> + <td>"25"</td> + <td>profile record</td> + <td>number of call, time spend </td> + </tr> + <tr> + <td>"26"</td> + <td>put a vector of strings in the stack</td> + <td>#rows, #columns, element sequence</td> + </tr> + <tr> + <td>"27"</td> + <td>put a builtin reference in the stack</td> + <td>interface number, position in interface, function name</td> + </tr> + <tr> + <td>"28"</td> + <td>continue command</td> + <td>none</td> + </tr> + <tr> + <td>"29"</td> + <td>assignment</td> + <td>#lhs, display mode, (variable name, #rhs)*</td> + </tr> + <tr> + <td>"30"</td> + <td>logical expression short circuit</td> + <td>type, jump size</td> + </tr> + <tr> + <td>"31"</td> + <td>comment</td> + <td>the comment</td> + </tr> + <tr> + <td>"99"</td> + <td>return command</td> + <td>none</td> + </tr> + <tr> + <td> > "100"</td> + <td>builtin call (obsolete)</td> + <td>100*fun, #rhs, #lhs, fin</td> + </tr> + </informaltable> + <para> + The <link linkend="fun2string">fun2string</link> function can be used to generate the initial code. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//DISPLAY +function y=foo(x,flag) + if flag then + y=sin(x) + else + y=cos(x) + end +endfunction +L=macr2lst(foo) +fun2string(L) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="macrovar">macrovar</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/macr2tree.xml b/modules/functions/help/en_US/macr2tree.xml new file mode 100755 index 000000000..525a15405 --- /dev/null +++ b/modules/functions/help/en_US/macr2tree.xml @@ -0,0 +1,52 @@ +<?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="macr2tree"> + <refnamediv> + <refname>macr2tree</refname> + <refpurpose>function to tree conversion</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>t=macr2tree(function_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para>a Scilab macro</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>a Scilab "tree"</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This primitive converts a compiled Scilab function <literal>function_name</literal> + into a tree (nested tlists) which codes the internal representation of + the function. For use with <literal>tree2code</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/macro.xml b/modules/functions/help/en_US/macro.xml new file mode 100755 index 000000000..9ea256464 --- /dev/null +++ b/modules/functions/help/en_US/macro.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="macro"> + <refnamediv> + <refname>macro</refname> + <refpurpose>Scilab procedure and Scilab object</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Macros are Scilab procedures ("macro", "function" and "procedure" + have the save meaning). Usually, they are defined + in files with an editor and loaded into Scilab by <function>exec</function> or through + a library. + </para> + <para> + They can also be defined on-line (see <link linkend="deff">deff</link>). + A file which contains a macro must begin as follows: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) + ]]></programlisting> + <para> + The <literal>yi</literal> are output variables calculated as functions of + input variables and variables existing in Scilab + when the macro is executed. + A macro can be compiled for faster execution. Collections + of macros can be collected in libraries. + Macros which begin with <literal>%</literal> sign (e.g. <literal>%foo</literal>) and whose + arguments are lists are used to perform specific + operations: for example, <code>z=%rmr(x,y)</code> is equivalent + to <code>z=x*y</code> when <varname>x</varname> and <varname>z</varname> are rationals + (i.e. <code>x=list('r',n,d,[])</code> with <varname>n</varname> and <varname>d</varname> polynomials). + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/macrovar.xml b/modules/functions/help/en_US/macrovar.xml new file mode 100755 index 000000000..aed52e47b --- /dev/null +++ b/modules/functions/help/en_US/macrovar.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="macrovar"> + <refnamediv> + <refname>macrovar</refname> + <refpurpose>variables of function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>vars = macrovar(function)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>vars</term> + <listitem> + <para> + a list, <literal>list(in, out, nolocal, called, locals)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>function</term> + <listitem> + <para>a name of a function.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Returns in a list the set of variables used by a function. + <varname>vars</varname> is a list made of five column vectors of character strings: + </para> + <simplelist type="inline"> + <member> + <varname>in</varname>: input variables (<code>vars(1)</code>); + </member> + <member> + <varname>out</varname>: output variables (<code>vars(2)</code>); + </member> + <member> + <varname>nolocal</varname>: referenced variables which are not defined inside the function and which are not functions (<code>vars(3)</code>); + </member> + <member> + <varname>called</varname>: names of functions called (<code>vars(4)</code>); + </member> + <member> + <varname>locals</varname>: local variables (<code>vars(5)</code>); + </member> + </simplelist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc'); +vars = macrovar(f) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/mode.xml b/modules/functions/help/en_US/mode.xml new file mode 100755 index 000000000..3cd4bf33c --- /dev/null +++ b/modules/functions/help/en_US/mode.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mode" xml:lang="en"> + <refnamediv> + <refname>mode</refname> + <refpurpose>select a mode in an exec-file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mode(k) + k = mode() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Used <emphasis role="bold">exclusively</emphasis> inside an + exec-file or a Scilab function <literal>mode(k)</literal> allows to change + the information displayed during the execution, depending on the value of + <literal>k</literal>: + </para> + <variablelist> + <varlistentry> + <term>k = 0</term> + <listitem> + <para>The new variable values are displayed if required (see help on + <link linkend="semicolon">semicolon</link> or <link linkend="comma">comma</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = -1</term> + <listitem> + <para>The exec-file or Scilab function executes silently (this is + the default value for Scilab functions). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 2</term> + <listitem> + <para>It is the default value on Scilab prompt.</para> + <para> + Please notices that <literal>mode(2)</literal> does not used at prompt, only in an + exec-file or a Scilab function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 1 or k = 3</term> + <listitem> + <para>Each line of instructions is echoed preceded of the prompt (if + possible). The new variable values are displayed if required. This + is the default for exec-files. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 4 or k = 7</term> + <listitem> + <para>The new variable values are displayed if required, each line + of instructions is echoed (if possible) and a prompt (>>) is + issued after each line waiting for a carriage return. + </para> + <para>If the carriage return follows character "p" the execution is + paused (see <link linkend="pause">pause</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k > 7</term> + <listitem> + <para>User mode. If you define your own mode, it is recommended to + use a value > 100. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Line display is disabled for compiled Scilab function (see <link linkend="comp">comp</link>). By default, Scilab functions are executed using the silent ("-1") + mode. + </para> + <para>Functions in a function library are executed using "-1" mode.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// copy - paste in Scilab + +function example_mode( level_mode ) + mode(level_mode) + a = 3 + disp(mode()); +endfunction + +mode(2) + +example_mode(0) +example_mode(-1) +example_mode(2) +example_mode(1) +example_mode(3) +example_mode(7) + +mode(2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="semicolon">semicolon</link> + </member> + <member> + <link linkend="comma">comma</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/overloading.xml b/modules/functions/help/en_US/overloading.xml new file mode 100755 index 000000000..d364a76cb --- /dev/null +++ b/modules/functions/help/en_US/overloading.xml @@ -0,0 +1,618 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA + * Copyright (C) DIGITEO - 2012 - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="overloading" xml:lang="en"> + <refnamediv> + <refname>overloading</refname> + <refpurpose>display, functions and operators overloading + capabilities + </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>In Scilab, variable display, functions and operators may be defined + for new objects using functions (Scilab coded or primitives). + </para> + <variablelist> + <varlistentry> + <term>Display</term> + <listitem> + <para> + The display of new objects defined by <literal>tlist</literal> + structure may be overloaded (the default display is similar to + <literal>list</literal>'s one). The overloading function must have + no output argument and a single input argument. It's name is formed as + follow <literal>%<tlist_type>_p</literal> where + <literal>%<tlist_type></literal> stands for the first entry of + the <literal>tlist</literal> type component truncated to the first 9 + characters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Operators</term> + <listitem> + <para>Each operator which is not defined for given operands type may + be defined. The overloading function must have a single output + argument and one or two inputs according to the number of operands. + The function name is formed as follow: + </para> + </listitem> + </varlistentry> + </variablelist> + <para>for binary operators: + <literal>%<first_operand_type>_<op_code>_<second_operand_type></literal>; + </para> + <para>for unary operators: + <literal>%<operand_type>_<op_code></literal>; + </para> + <para>extraction and insertion operators which are n-nary operators are + described below. + </para> + <warning>Be careful, only the types registered by the + <function>typename</function> function can be used in an overloading + macros. + </warning> + <para> + <literal><operand_type></literal>, + <literal><first_operand_type></literal>, + <literal><second_operand_type></literal> are sequence of characters + associated with each data type as described in the following table: + </para> + <informaltable border="1"> + <tr> + <td>data type</td> + <td>char code</td> + <td>typeof</td> + <td>comments</td> + </tr> + <tr> + <td>double matrix</td> + <td> + <literal>s</literal> + </td> + <td> + <literal>constant</literal> + </td> + <td/> + </tr> + <tr> + <td>polynomial matrix</td> + <td> + <literal>p</literal> + </td> + <td> + <literal>polynomial</literal> + </td> + <td/> + </tr> + <tr> + <td>boolean matrix</td> + <td> + <literal>b</literal> + </td> + <td> + <literal>boolean</literal> + </td> + <td/> + </tr> + <tr> + <td>sparse matrix</td> + <td> + <literal>sp</literal> + </td> + <td> + <literal>sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>boolean sparse matrix</td> + <td> + <literal>spb</literal> + </td> + <td> + <literal>boolean sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>Matlab sparse matrix</td> + <td> + <literal>msp</literal> + </td> + <td> + <literal>Matlab sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>integer matrix</td> + <td> + <literal>i</literal> + </td> + <td> + <literal>int8, int16, int32, uint8, uint16, uint32</literal> + </td> + <td/> + </tr> + <tr> + <td>string matrix</td> + <td> + <literal>c</literal> + </td> + <td> + <literal>string</literal> + </td> + <td/> + </tr> + <tr> + <td>handle</td> + <td> + <literal>h</literal> + </td> + <td> + <literal>handle</literal> + </td> + <td/> + </tr> + <tr> + <td>compiled function</td> + <td> + <literal>fptr</literal> + </td> + <td> + <literal>fptr</literal> + </td> + <td/> + </tr> + <tr> + <td>script function</td> + <td> + <literal>mc</literal> + </td> + <td> + <literal>function</literal> + </td> + <td/> + </tr> + <tr> + <td>library</td> + <td> + <literal>f</literal> + </td> + <td> + <literal>library</literal> + </td> + <td/> + </tr> + <tr> + <td>list</td> + <td> + <literal>l</literal> + </td> + <td> + <literal>list</literal> + </td> + <td/> + </tr> + <tr> + <td>tlist</td> + <td> + <literal>tlist type</literal> + </td> + <td> + <literal>tlist type</literal> + </td> + <td>the first string in the first tlist entry</td> + </tr> + <tr> + <td>mlist</td> + <td> + <literal>mlist type</literal> + </td> + <td> + <literal>mlist type</literal> + </td> + <td>the first string in the first mlist entry</td> + </tr> + <tr> + <td>hypermatrix</td> + <td> + <literal>hm</literal> + </td> + <td> + <literal>hypermat</literal> + </td> + <td/> + </tr> + <tr> + <td>pointer</td> + <td> + <literal>ptr</literal> + </td> + <td> + <literal>pointer</literal> + </td> + <td/> + </tr> + <tr> + <td>cell</td> + <td> + <literal>ce</literal> + </td> + <td> + <literal>ce</literal> + </td> + <td/> + </tr> + <tr> + <td>structure</td> + <td> + <literal>st</literal> + </td> + <td> + <literal>st</literal> + </td> + <td/> + </tr> + <tr> + <td>rational</td> + <td> + <literal>r</literal> + </td> + <td> + <literal>rational</literal> + </td> + <td/> + </tr> + <tr> + <td>linear state space</td> + <td> + <literal>lss</literal> + </td> + <td> + <literal>state-space</literal> + </td> + <td/> + </tr> + <tr> + <td>implicit polynom</td> + <td> + <literal>ip</literal> + </td> + <td> + <literal>size implicit</literal> + </td> + <td>1:1:$</td> + </tr> + </informaltable> + <para> + <literal><op_code></literal> is a single character associated + with each operator as described in the following table: + </para> + <informaltable border="1"> + <tr> + <td> + <literal>op</literal> + </td> + <td>char code</td> + </tr> + <tr> + <td> + <literal>'</literal> + </td> + <td>t</td> + </tr> + <tr> + <td> + <literal>+</literal> + </td> + <td>a</td> + </tr> + <tr> + <td> + <literal>-</literal> + </td> + <td>s</td> + </tr> + <tr> + <td> + <literal>*</literal> + </td> + <td>m</td> + </tr> + <tr> + <td> + <literal>/</literal> + </td> + <td>r</td> + </tr> + <tr> + <td> + <literal>\</literal> + </td> + <td>l</td> + </tr> + <tr> + <td> + <literal>^</literal> + </td> + <td>p</td> + </tr> + <tr> + <td> + <literal>.*</literal> + </td> + <td>x</td> + </tr> + <tr> + <td> + <literal>./</literal> + </td> + <td>d</td> + </tr> + <tr> + <td> + <literal>.\</literal> + </td> + <td>q</td> + </tr> + <tr> + <td> + <literal>.*.</literal> + </td> + <td>k</td> + </tr> + <tr> + <td> + <literal>./.</literal> + </td> + <td>y</td> + </tr> + <tr> + <td> + <literal>.\.</literal> + </td> + <td>z</td> + </tr> + <tr> + <td> + <literal>:</literal> + </td> + <td>b</td> + </tr> + <tr> + <td> + <literal>*.</literal> + </td> + <td>u</td> + </tr> + <tr> + <td> + <literal>/.</literal> + </td> + <td>v</td> + </tr> + <tr> + <td> + <literal>\.</literal> + </td> + <td>w</td> + </tr> + <tr> + <td> + <literal>[a,b]</literal> + </td> + <td>c</td> + </tr> + <tr> + <td> + <literal>[a;b]</literal> + </td> + <td>f</td> + </tr> + <tr> + <td> + <literal>() extraction</literal> + </td> + <td>e</td> + </tr> + <tr> + <td> + <literal>() insertion</literal> + </td> + <td>i</td> + </tr> + <tr> + <td> + <literal>==</literal> + </td> + <td>o</td> + </tr> + <tr> + <td> + <literal><></literal> + </td> + <td>n</td> + </tr> + <tr> + <td> + <literal>|</literal> + </td> + <td>g</td> + </tr> + <tr> + <td> + <literal>&</literal> + </td> + <td>h</td> + </tr> + <tr> + <td> + <literal>.^</literal> + </td> + <td>j</td> + </tr> + <tr> + <td> + <literal>.'</literal> + </td> + <td>0</td> + </tr> + <tr> + <td> + <literal><</literal> + </td> + <td>1</td> + </tr> + <tr> + <td> + <literal>></literal> + </td> + <td>2</td> + </tr> + <tr> + <td> + <literal><=</literal> + </td> + <td>3</td> + </tr> + <tr> + <td> + <literal>>=</literal> + </td> + <td>4</td> + </tr> + <tr> + <td> + <literal>~</literal> + </td> + <td>5</td> + </tr> + <tr> + <td> + <literal>iext</literal> + </td> + <td>6</td> + </tr> + </informaltable> + <para> + The overloading function for extraction syntax <literal>b= a(i1, + ..., in) + </literal> + has the following calling sequence: <literal>b = + %<type_of_a>_e_(i1, ..., in, a) + </literal> + </para> + <para> + and the syntax <literal>[x1, .., xm] = a(i1, ..., in)</literal> has + the following calling sequence: <literal>[x1, .., xm] = + %<type_of_a>_e_(i1, ..., in, a) + </literal> + . + </para> + <para>The overloading function associated to the insertion syntax + <literal>a(i1, ..., in) = b</literal> has the following calling sequence: + <literal>a = %<type_of_b>_i_<type_of_a>(i1, ..., in, b, + a) + </literal> + . + </para> + <para> + The <literal>6</literal> char code may be used for some complex + insertion algorithm like <code>x.b(2) = 33</code> where + <literal>b</literal> field is not defined in the structure + <literal>x</literal>. The insertion is automatically decomposed into + <code>temp = x.b</code>; <code>temp(2) = 33</code>; + <code>x.b = temp</code>. The <literal>6</literal> char code is used + for the first step of this algorithm. The <literal>6</literal> overloading + function is very similar to the <literal>e</literal>'s one. + </para> + <variablelist> + <varlistentry> + <term>Functions :</term> + <listitem> + <para> + Some basic primitive function may also be overloaded for new data type. When such function + is undefined for a particular data types the function + <literal>%<type_of_an_argument>_<function_name></literal> + is called. User may add in this called function the definition + associated with the input data types. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + </refsection> + <refsection> + <programlisting role="example">//DISPLAY + var = tlist('tab', ['a', 'b'], ['x'; 'y'], rand(2, 2)) // the type of var is 'tab' + + typeof(var) + + function [] = %tab_p(l) + disp([[' '; l(3)] [l(2); string(l(4))]]) + endfunction + + var // after overloading + </programlisting> + </refsection> + <refsection> + <programlisting role="example">//OPERATOR + 's' + 1 // it is impossible to add a number to a string + + function x = %c_a_s(a, b) + x = a + string(b); + endfunction + + 's' + 1 // after overloading + </programlisting> + </refsection> + <refsection> + <programlisting role="example">//FUNCTION + sin('2 * x') // the sin function does not work with a string + + function x = %c_sin(a) + x = 'sin(' + a + ')' + endfunction + + sin('2 * x') // after overloading + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="disp">disp</link> + </member> + <member> + <link linkend="symbols">symbols</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typename">typename</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/add_profiling.xml b/modules/functions/help/en_US/profiling/add_profiling.xml new file mode 100755 index 000000000..0489fb2a5 --- /dev/null +++ b/modules/functions/help/en_US/profiling/add_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="add_profiling" xml:lang="fr"> + <refnamediv> + <refname>add_profiling</refname> + <refpurpose>Enables the profiling of a function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>add_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>A character string, the name of the function to be profiled</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>add_profiling</literal> adds the instructions needed for the profiling of a function. + Then, when this function is executed, the number of calls and the + time spent, for each line, are stored. + These data can be returned with the <link linkend="profile">profile</link> function. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //run the function +profile(foo) //extract profile information + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Used Functions</title> + <para> + This function uses the Scilab functions <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/plotprofile.xml b/modules/functions/help/en_US/profiling/plotprofile.xml new file mode 100755 index 000000000..c1163e599 --- /dev/null +++ b/modules/functions/help/en_US/profiling/plotprofile.xml @@ -0,0 +1,123 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * Copyright (C) 2013 - Scilab Enterprises - Simon MARCHETTO + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="plotprofile"> + <refnamediv> + <refname>plotprofile</refname> + <refpurpose>Displays the profiling charts of a function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>plotprofile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>a Scilab compiled function, or a function name (string), or an array of + function names + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + To use <literal>plotprofile</literal> on a function, the profiling of this function must have been first activated: + <itemizedlist> + <listitem><para>either by using the <link linkend="add_profiling">add_profiling</link> command.</para></listitem> + <listitem><para>or if the function has beed defined with the <link linkend="deff">deff</link> command, by setting the optional argument of <link linkend="deff">deff</link> to "p".</para></listitem> + </itemizedlist> + </para> + <para> + Once the function has been executed, calling <literal>plotprofile</literal> displays two windows, one containing the source code of the function, and a second one containing three histograms which show: + <itemizedlist> + <listitem><para>the number of calls of each line</para></listitem> + <listitem><para>the total CPU time spent on each line (in seconds)</para></listitem> + <listitem><para>a measure of effort to interpret each line (arbitrary unit)</para></listitem> + </itemizedlist> + </para> + <para> + When clicking on a histogram bin, the related line is highlighted in the source code window. + </para> + <para> + Note: "Exit" item is used to exit from the "plotprofile" graphics window. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Exemple of profiling a function +function foo() + runs = 50; + b = 0; + for i = 1:runs + b = zeros(220, 220); + for j = 1:220 + for k = 1:220 + b(k,j) = abs(j - k) + 1; + end + end + end +endfunction + +// Enables the profiling of the function +add_profiling("foo"); + +// Executes the function +foo(); + +// Displays the profiling charts +plotprofile(foo) // click on Exit to exit + ]]></programlisting> + <programlisting role="example"><![CDATA[ +// Exemple of profiling a function defined with deff +deff('x = foo2(n)', ['if n > 0 then' + ' x = 0;' + ' for k = 1:n' + ' s = svd(rand(n, n));' + ' x = x + s(1);' + ' end' + 'else' + ' x = [];' + 'end'], .. + 'p'); + +// Executes the function +foo2(200); + +// Displays the profiling charts +plotprofile("foo2") // click on Exit to exit + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="showprofile">showprofile</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/profile.xml b/modules/functions/help/en_US/profiling/profile.xml new file mode 100755 index 000000000..d4eacfae9 --- /dev/null +++ b/modules/functions/help/en_US/profiling/profile.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * Copyright (C) 2013 - Samuel GOUGEON + * Copyright (C) 2013 - Scilab Enterprises - Simon MARCHETTO + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="profile"> + <refnamediv> + <refname>profile</refname> + <refpurpose>Returns the profiling results of a function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>c = profile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>a Scilab function</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>a nx3 matrix containing the profiling results: + <itemizedlist> + <listitem> + <para> + <literal>c(i,1)</literal> : number of times the line i of the function has been executed + </para> + </listitem> + <listitem> + <para> + <literal>c(i,2)</literal> : cumulated CPU time [in seconds] spent to execute the line i of the function + </para> + </listitem> + <listitem> + <para> + <literal>c(i,3)</literal> : Measurement of the interpreter effort to execute once the line i of the function [arbitrary unit] + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + To use <literal>profile</literal> on a function, the profiling of this function must have been first activated: + <itemizedlist> + <listitem> + <para> + either by using the <link linkend="add_profiling">add_profiling</link> command. + </para> + </listitem> + <listitem> + <para> + or if the function has beed defined with the <link linkend="deff">deff</link> command, by setting the optional argument of <link linkend="deff">deff</link> to "p". + </para> + </listitem> + </itemizedlist> + </para> + <para> + Once the function executed, calling <literal>profile</literal> returns a matrix, where each row contains the profiling results for the corresponding function line (including the header line of the function), such as the number of calls, and the total CPU time spent in that line, and a measurement of the interpretor effort to execute the line, as following: + </para> + <para> + <informaltable border="1"> + <tr> + <td>Number of calls</td><td>Total CPU time (s)</td><td>Interpretor effort</td> + </tr> + <tr> + <td>1</td><td>0</td><td>0</td> + </tr> + <tr> + <td>300</td><td>0.1</td><td>0</td> + </tr> + <tr> + <td>300</td><td>3.59</td><td>5</td> + </tr> + <tr> + <td>...</td><td>...</td><td>...</td> + </tr> + </informaltable> + </para> + <para> + Here we can see that the 3th line of the function has been called 300 times, for a total CPU time of 3.59 seconds. + </para> + <para> + Note: due to the precision limit of CPU time measure (typically one micro second), some executed lines which execution is very fast may appear with a CPU total time of 0. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Function to be profiled +function x = foo(n) + if n > 0 then + x = 0; + for k = 1:n + s = svd(rand(n, n)); + x = x + s(1); + end + else + x = []; + end +endfunction + +// Enables the profiling of the function +add_profiling("foo"); + +// Executes the function +foo(200); + +// Returns the function profiling results +profile(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="showprofile">showprofile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/remove_profiling.xml b/modules/functions/help/en_US/profiling/remove_profiling.xml new file mode 100755 index 000000000..4da5fb49b --- /dev/null +++ b/modules/functions/help/en_US/profiling/remove_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="remove_profiling" xml:lang="fr"> + <refnamediv> + <refname>remove_profiling</refname> + <refpurpose>Disables the profiling of a function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>remove_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>A character string, the name of the profiled function</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>remove_profiling</literal> removes the instructions needed for the profiling of a function. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //run the function +profile(foo) //extract profile information +remove_profiling("foo") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">remove_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Used Functions</title> + <para> + This function uses the Scilab functions <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/reset_profiling.xml b/modules/functions/help/en_US/profiling/reset_profiling.xml new file mode 100755 index 000000000..aa984428c --- /dev/null +++ b/modules/functions/help/en_US/profiling/reset_profiling.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="reset_profiling" xml:lang="fr"> + <refnamediv> + <refname>reset_profiling</refname> + <refpurpose>Resets profiling counters of a function.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>reset_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>A character string, the name of the function</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>reset_profiling(funname)</literal> Resets profiling counters (if any) of the function + named <literal>funname</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //run the function +profile(foo) //extract profile information +reset_profiling("foo") +profile(foo) //extract profile information + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Used Functions</title> + <para> + This function uses the Scilab functions <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/profiling/showprofile.xml b/modules/functions/help/en_US/profiling/showprofile.xml new file mode 100755 index 000000000..48b4d39f7 --- /dev/null +++ b/modules/functions/help/en_US/profiling/showprofile.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * Copyright (C) 2013 - Scilab Enterprises - Simon MARCHETTO + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="showprofile"> + <refnamediv> + <refname>showprofile</refname> + <refpurpose>Outputs the function profiling results to the console</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>showprofile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>a Scilab function</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + To use <literal>showprofile</literal> on a function, the profiling of this function must have been first activated: + <itemizedlist> + <listitem> + <para> + either by using the <link linkend="add_profiling">add_profiling</link> command. + </para> + </listitem> + <listitem> + <para> + or if the function has beed defined with the <link linkend="deff">deff</link> command, by setting the optional argument of <link linkend="deff">deff</link> to "p". + </para> + </listitem> + </itemizedlist> + </para> + <para> + Once the function has been executed, calling <literal>showprofile</literal> outputs to the console the profiling results. + </para> + <para>For each function line (including the header of function), are printed the following informations, in order: + <itemizedlist> + <listitem><para>the total number of times the line was called</para></listitem> + <listitem><para>the total CPU time spent in the line (in seconds)</para></listitem> + <listitem><para>a measurement of the interpretor effort to interpret the line</para></listitem> + <listitem><para>the number and source code of the line</para></listitem> + </itemizedlist> + </para> + <para> + An example of output: + </para> + <screen> + |1 |0 |0| 1: function x=fun(n) + |1 |0 |0| 2: if n > 0 then + |1 |0 |2| 3: x = 0; + |200|0.01|0| 4: for k = 1:n + |200|3.99|5| 5: s = svd(rand(n, n)); + |...|... |.| ... + </screen> + <para> + Here we can see that the 5th line of the function has been called 200 times, for a total CPU time of 3.99 seconds (and an effort of 5 to interpret the line). + </para> + <para> + <literal>show_profile</literal> looks like to <link linkend="profile">profile</link>, but <link linkend="profile">profile</link> returns a matrix with the profiling results, while <literal>show_profile</literal> only prints that results to the console. + </para> + <para> + Note: due to the precision limit of CPU time measure (typically one micro second), some executed lines which execution is very fast may appear with a CPU total time of 0. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Function to be profiled +function x = foo(n) + if n > 0 then + x = 0; + for k = 1:n + s = svd(rand(n, n)); + x = x + s(1); + end + else + x = []; + end +endfunction + +// Enables the profiling of the function +add_profiling("foo"); + +// Executes the function +foo(200); + +// Prints the function profiling results to console +showprofile(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/recompilefunction.xml b/modules/functions/help/en_US/recompilefunction.xml new file mode 100755 index 000000000..16ccaa76f --- /dev/null +++ b/modules/functions/help/en_US/recompilefunction.xml @@ -0,0 +1,89 @@ +<?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="recompilefunction"> + <refnamediv> + <refname>recompilefunction</refname> + <refpurpose>recompiles a scilab function, + changing its type + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>recompilefunction(funname [,kind [,force]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>string, name of the function to recompile + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>kind</term> + <listitem> + <para> + string: <emphasis role="bold">"n"</emphasis> (noncompiled, type 11), <emphasis role="bold">"c"</emphasis> + (compiled, type 13) or <emphasis role="bold">"p"</emphasis> (compiled, type 13, with + provision for profiling). Default "c". + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>force</term> + <listitem> + <para>boolean. If false, the function is recomplied only if its kind changes; + if true, it is recompiled even if it keeps the same kind (notably useful + to recompile a "p" function, to reset the profiling statistics). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <itemizedlist> + <listitem> + <para> + This function reverse-compiles a function variable via <link linkend="fun2string">fun2string</link>, + and recompiles it to the desired kind with <link linkend="deff">deff</link>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +for i=1:100; asinh(rand(100,100)); end +showprofile(asinh) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Bibliography</title> + <para> + <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/sciargs.xml b/modules/functions/help/en_US/sciargs.xml new file mode 100755 index 000000000..40a50424f --- /dev/null +++ b/modules/functions/help/en_US/sciargs.xml @@ -0,0 +1,37 @@ +<?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="sciargs"> + <refnamediv> + <refname>sciargs</refname> + <refpurpose>scilab command line arguments</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>args = sciargs()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This function returns a row vector of character strings containing the + arguments of the Scilab command line. First <literal>args</literal> entry contains + the path of the launched executable file. + </para> + <para> + This function corresponds to the <literal>getarg</literal> function in C language. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +args=sciargs() + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getenv">getenv</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/str2code.xml b/modules/functions/help/en_US/str2code.xml new file mode 100755 index 000000000..3b019865b --- /dev/null +++ b/modules/functions/help/en_US/str2code.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) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="str2code" xml:lang="en"> + <refnamediv> + <refname>str2code</refname> + <refpurpose>returns Scilab integer codes associated with a character + string. <emphasis role="bold">This function is obsolete.</emphasis> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>c = str2code(str)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>str</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>a column vector of character integer codes.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>c = str2code(str)</code> returns a column vector + <varname>c</varname> such that <literal>c(i)</literal> is the + Scilab integer code of <literal>part(str,i)</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +str2code('Scilab')' +code2str([-28 12 18 21 10 11]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="code2str">code2str</link> + </member> + <member> + <link linkend="ascii">ascii</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>This function will be removed in Scilab 6.0.0</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/tree2code.xml b/modules/functions/help/en_US/tree2code.xml new file mode 100755 index 000000000..15f985eb4 --- /dev/null +++ b/modules/functions/help/en_US/tree2code.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tree2code"> + <refnamediv> + <refname>tree2code</refname> + <refpurpose>generates ASCII definition of a Scilab function</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>txt = tree2code(tree, prettyprint)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>tree</term> + <listitem> + <para> + a macro tree (coming from <function>macr2tree</function>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>prettyprint</term> + <listitem> + <para>an optional boolean value:</para> + <variablelist> + <varlistentry> + <term>%T</term> + <listitem> + <para>generated code is indented and beautified</para> + </listitem> + </varlistentry> + <varlistentry> + <term>%F</term> + <listitem> + <para> + generated code is not beautified (default) + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>a column vector of strings, the text giving the Scilab instructions.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Given a loaded Scilab function "tree" (returned by <function>macr2tree</function>), <function>tree2code</function> allows to + re-generate the code. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/varargin.xml b/modules/functions/help/en_US/varargin.xml new file mode 100755 index 000000000..9ba7fa74f --- /dev/null +++ b/modules/functions/help/en_US/varargin.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargin" xml:lang="en"> + <refnamediv> + <refname>varargin</refname> + <refpurpose>variable number of arguments in an input argument + list + </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + A function whose last input argument is <literal>varargin</literal> + can be called with more input arguments than indicated in the input + argument list. The calling arguments passed form + <literal>varargin</literal> keyword onwards may then be retrieved within + the function in a list named <literal>varargin</literal>. + </para> + <para> + Suppose that <literal>varargin</literal> keyword is the + <literal>n</literal>-th argument of the formal input argument list, then + if the function is called with less than <literal>n-1</literal> input + arguments the <literal>varargin</literal> list is not defined, if the + function is called with <literal>n-1</literal> arguments then + <literal>varargin</literal> list is an empty list. + </para> + <para> + <literal>function y = ex(varargin)</literal> may be called with any + number of input arguments. Within function <literal>ex</literal> input + arguments may be retrieved in <literal>varargin(i)</literal>, <literal>i=1:length(varargin)</literal>. + </para> + <para> + If it is not the last input argument of a function, + <literal>varargin</literal> is a normal input argument name with no + special meaning. + </para> + <para> + The total number of actual input arguments is given by <code>argn(2)</code>. + </para> + </refsection> + <refsection> + <title>Remark</title> + <para> + Named argument syntax like <literal>foo(...,key=value)</literal> is + incompatible with the use of <literal>varargin</literal>. The reason is that the names (i.e. + keys) associated with values are not stored in the <literal>varargin</literal> list. Consider + for instance: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +function foo(varargin) + disp([varargin(1),varargin(2)]) +endfunction + ]]></programlisting> + <screen> + -->foo(a=1,b=2) + + 1. 2. + + -->foo(b=1,a=2) + + 1. 2. + </screen> + <para> + Result is the same, but the arguments were inverted. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function exampl(a,varargin) + [lhs,rhs]=argn(0) + if rhs>=1 then + disp(varargin) + end +endfunction + +exampl(1) +exampl() +exampl(1,2,3) +l=list('a',%s,%t); +exampl(1,l(2:3)) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/en_US/varargout.xml b/modules/functions/help/en_US/varargout.xml new file mode 100755 index 000000000..7d16539fa --- /dev/null +++ b/modules/functions/help/en_US/varargout.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargout" xml:lang="en"> + <refnamediv> + <refname>varargout</refname> + <refpurpose>variable numbers of arguments in an output argument + list + </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>A function whose output argument list contains + <literal>varargout</literal> must be called with more output arguments + than indicated in the output argument list. The calling arguments passed + form <literal>varargout</literal> keyword onwards are extracted out of the + <literal>varargout</literal> list defined in the function. + </para> + <para> + <literal>varargout = function ex()</literal> may be called with any + number of output arguments. Within function <literal>ex</literal> output + arguments may be stored in <literal>varargout(i)</literal>. + </para> + <para> + <literal>[X1,...,Xn,varargout] = function ex()</literal> may also be + used. In this case the <literal>Xi</literal> variables must be assigned in + the function as well as <literal>varargout(i)</literal>. + </para> + <para> + The actual total number of output argument is given <code>argn(1)</code>. + </para> + </refsection> + <refsection> + <title>Remark</title> + <para> + The <literal>varargout</literal> variable must be created within the + function and assigned to a <link linkend="list">list</link>. If <literal>varargout</literal> + is the only formal output variable the list must contain at least one + entry. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function varargout=exampl() + varargout=list(1,2,3,4) +endfunction + +x=exampl() +[x,y]=exampl() +[x,y,z]=exampl() + +function [a,b,varargout]=exampl1() + a='first' + b='second' + varargout=list(1,2,3,4) +endfunction + +exampl1() +[a,b]=exampl1() +[a,b,c]=exampl1() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/addchapter.sce b/modules/functions/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..6c99fe36c --- /dev/null +++ b/modules/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 avancées",SCI+"/modules/functions/help/fr_FR",%T); + diff --git a/modules/functions/help/fr_FR/argn.xml b/modules/functions/help/fr_FR/argn.xml new file mode 100755 index 000000000..d43ad5370 --- /dev/null +++ b/modules/functions/help/fr_FR/argn.xml @@ -0,0 +1,55 @@ +<?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="argn"> + <refnamediv> + <refname>argn</refname> + <refpurpose>nombre d'arguments d'appel d'une fonction </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[lhs [,rhs] ]=argn() + lhs=argn(1) + rhs=argn(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Cette fonction est utilisée à l'intérieur d'une définition de fonction. + Elle donne le nombre effectif (au moment de l'appel) d'arguments d'entrée <varname>rhs</varname> + et de sortie <varname>lhs</varname>. Elle permet d'utiliser des arguments optionnels. + </para> + <para> + <note> + Notez que <varname>lhs</varname> est toujours supérieur ou égal à 1. Autrement dit, même si une + fonction est appelée sans avoir mentionné un argument de sortie, <varname>lhs</varname> sera égal à 1. + </note> + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +function concat=maFonction(nom,option) + [lhs,rhs]=argn(0); + disp(lhs); + if rhs <= 1 then + option="mon argument optionnel"; + end + if rhs == 0 then + error("Au moins un argument attendu"); + end + concat=nom+" "+option; +endfunction + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/built_in/CHAPTER b/modules/functions/help/fr_FR/built_in/CHAPTER new file mode 100755 index 000000000..4beffcea0 --- /dev/null +++ b/modules/functions/help/fr_FR/built_in/CHAPTER @@ -0,0 +1,2 @@ +title = Built-in & external + diff --git a/modules/functions/help/fr_FR/built_in/external.xml b/modules/functions/help/fr_FR/built_in/external.xml new file mode 100755 index 000000000..ab0f602b2 --- /dev/null +++ b/modules/functions/help/fr_FR/built_in/external.xml @@ -0,0 +1,84 @@ +<?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="external"> + <refnamediv> + <refname>external</refname> + <refpurpose>Objet Scilab, fonction externe ou routine </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Fonction ou routine externe nécessitée par des commandes particulières. + </para> + <para> + Un "external" est une fonction ou une routine qui est utilisée comme argument d'une + "primitive de haut niveau", telle que <literal>ode</literal>, <literal>optim</literal>, <literal>schur</literal>... + </para> + <para> + La séquence d'appel de la fonction ou de la routine est en général imposée + par la primitive de haut niveau qui impose en particulier les arguments d'entrée. + </para> + <para> + Par exemple la fonction externe <literal>costfunc</literal> est un argument de la primitive <literal>optim</literal>. + Sa séquence d'appel doit être de la forme : <literal>[f,g,ind]=costfunc(x,ind)</literal> et + <literal>optim</literal> (primitive permettant de résoudre des problèmes d'optimisation) est invoquée ainsi : + </para> + <programlisting><![CDATA[ +optim(costfunc,...) + ]]></programlisting> + <para> + Ici <literal>costfunc</literal> (la fonction coût à minimiser avec <literal>optim</literal>) + calcule <literal>f=f(x)</literal> et <literal>g=</literal> le gradient de <literal>f</literal> en <literal>x</literal> (<literal>ind</literal> est un entier dont l'usage est précisé dans l'aide de <literal>optim</literal>). + </para> + <para> + Si d'autres variables sont nécessaires à la fonction externe, ces variables + peuvent être définies dans son environnement. Elles peuvent aussi être stockées dans une liste : + par exemple + </para> + <programlisting><![CDATA[ +[f,g,ind]=costfunc(x,ind,a,b,c) + ]]></programlisting> + <para> + est valide pour <literal>optim</literal> si <literal>costfunc</literal> est remplacé par <literal>list(costfunc,a,b,c)</literal>. + La séquence d'appel à <literal>optim</literal> est donc maintenant : + </para> + <programlisting><![CDATA[ +optim(list(costfunc,a1,b1,c1),.... + ]]></programlisting> + <para> + Un "external" peut aussi être une routine Fortran ou C : cela peut permettre d'accélérer les calculs. + </para> + <para> + Le nom de la routine est donné comme argument à la primitive de haut niveau sous forme d'une + chaîne de caractères. La séquence d'appel est aussi imposée. + </para> + <para> + Les routines externes Fortran ou C peuvent aussi être liées dynamiquement (voir <literal>link</literal>). + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="ode">ode</link> + </member> + <member> + <link linkend="optim">optim</link> + </member> + <member> + <link linkend="impl">impl</link> + </member> + <member> + <link linkend="dassl">dassl</link> + </member> + <member> + <link linkend="intg">intg</link> + </member> + <member> + <link linkend="schur">schur</link> + </member> + <member> + <link linkend="gschur">gschur</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/built_in/what.xml b/modules/functions/help/fr_FR/built_in/what.xml new file mode 100755 index 000000000..87ccc5d01 --- /dev/null +++ b/modules/functions/help/fr_FR/built_in/what.xml @@ -0,0 +1,20 @@ +<?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="what"> + <refnamediv> + <refname>what</refname> + <refpurpose>liste des primitives + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>what() + [primitives,commandes]=what(); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para>Liste des primitives et commandes de bas niveau.</para> + <para/> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/bytecode.xml b/modules/functions/help/fr_FR/bytecode.xml new file mode 100755 index 000000000..04bea30f1 --- /dev/null +++ b/modules/functions/help/fr_FR/bytecode.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) ????-2008 - INRIA Serge Steer + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="bytecode"> + <refnamediv> + <refname>bytecode</refname> + <refpurpose>Etant donnée une fonction, retourne son pseudo code dans une variable Scilab et réciproquement. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis> + x = bytecode(f) + f = bytecode(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>f</term> + <listitem> + <para> + une fonction Scilab + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + un vecteur d'entiers, + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>x = bytecode(f)</code> retourne le pseudo code de la fonction + <varname>f</varname> dans le vecteur d'entiers Scilab + <varname>x</varname>. + </para> + <para> + <code>f= bytecode(x)</code> retourne dans + <varname>f</varname> la fonction correspondant au pseudo code + donné dans le vecteur d'entiers + <varname>x</varname>. + <warning> + Attention la validité du pseudo code n'est pas vérifiée. + </warning> + </para> + </refsection> + <refsection> + <title>Remark</title> + <para> + Le pseudo code de Scilab va changer dans le futur. Aussi l'usage + de cette fonction devrait être limité à la gestion des + fonctions de profiling. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +function a=foo(),a=sin(3),endfunction +bytecode(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="bytecodewalk">bytecodewalk</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/bytecodewalk.xml b/modules/functions/help/fr_FR/bytecodewalk.xml new file mode 100755 index 000000000..0fe628842 --- /dev/null +++ b/modules/functions/help/fr_FR/bytecodewalk.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Ajouter ici d'éventuels commentaires sur le fichier XML +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" 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="bytecodewalk"> + <refnamediv> + <refname>bytecodewalk</refname> + <refpurpose>parcourt le pseudo code d'une fonction en appliquant un traitement</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>c1 = bytecodewalk(code,query,job)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>code</term> + <listitem> + <para> + vecteur d'entiers (int32): le vecteur des pseudo codes de la fonction + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>query</term> + <listitem> + <para> + intier, le code opératoire à rechercher + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>job</term> + <listitem> + <para> + fonction, la fonction a appliquer pour le code opératoire requis + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>c1</term> + <listitem> + <para> + vecteur d'entiers (int32): le vecteur des pseudo codes résultant + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Parcourt le pseudo code d'une fonction en appliquant un traitement, pour un code opératoire donné/ + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="bytecode">bytecode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/comp.xml b/modules/functions/help/fr_FR/comp.xml new file mode 100755 index 000000000..0ce56f791 --- /dev/null +++ b/modules/functions/help/fr_FR/comp.xml @@ -0,0 +1,75 @@ +<?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="comp"> + <refnamediv> + <refname>comp</refname> + <refpurpose>pré-interprétation ou "compilation" de fonctions Scilab </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>comp(function [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>function </term> + <listitem> + <para>une fonction non "compilée" (type 11)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>flag with value 0 (default) or 2.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>comp(function)</literal> "compile" la fonction + <literal>function</literal>. Les fonctions "compilées" et + interprétées sont équivalentes mais les fonctions + "compilées" sont plus rapides. Les fonctions fournies dans les + bibliothèques standard de Scilab sont "compilées". + </para> + <para>La définition en line des fonction ainsi que la forme + courte des fonctions <literal>exec</literal> et + <literal>deff</literal> produisent des fonctions + compilées. L'usage de la fonction <literal>comp</literal> est + donc réservé a des usages très particuliers. Pour + générer des fonction non compilées, il faut appeler les + fonctions <link linkend="exec">exec</link> ou <link linkend="deff">deff</link> avec l'option + <literal>"n"</literal>. + </para> + <para>L'option opt==2 requiert que la compilation produise aussi + les instructions de profilage.. A noter qu'il est possible + d'ajouter ces instructions de profilage à une fonction + déjà compileée en utilisant la fonction <link linkend="add_profiling">add_profiling</link>. + </para> + <para>L'option opt==1 est obsolete est équivalente à + opt==0. + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/exec.xml b/modules/functions/help/fr_FR/exec.xml new file mode 100755 index 000000000..bcded2f2b --- /dev/null +++ b/modules/functions/help/fr_FR/exec.xml @@ -0,0 +1,191 @@ +<?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="exec"> + <refnamediv> + <refname>exec</refname> + <refpurpose>exécution d'un script (fichier de commandes) </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>exec(path [,mode]) + exec(fun [,mode]) + ierr = exec(path, 'errcatch' [,mode]) + ierr = exec(fun, 'errcatch' [,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>chaîne de caractères, le chemin du script à exécuter. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para>entier, précisant le mode d'exécution (voir plus bas). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fun</term> + <listitem> + <para>identificateur d'une fonction scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>entier, 0 ou numéro d'erreur. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>exec(path [,mode])</code> exécute séquentiellement les instructions + Scilab contenues dans le fichier spécifié par <varname>path</varname> avec le + mode d'exécution optionnel <varname>mode</varname> . + </para> + <para> + Les différentes valeurs de <varname>mode</varname> sont : + </para> + <variablelist> + <varlistentry> + <term>0</term> + <listitem> + <para>valeur par défaut</para> + </listitem> + </varlistentry> + <varlistentry> + <term>-1</term> + <listitem> + <para>rien n'est affiché</para> + </listitem> + </varlistentry> + <varlistentry> + <term>1</term> + <listitem> + <para>chaque ligne de commande est affichée</para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + l'invite de commande <literal>--></literal> est affiché + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>3</term> + <listitem> + <para>lignes de commandes + invite de commande</para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para>pause dans l'exécution au début de chaque ligne. L'exécution + reprend après un appui sur la touche entrée/return. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para>pause + invite + affichage : ce mode est utile pour les démonstrations.</para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>exec(fun [,mode])</code> exécute la fonction <varname>fun</varname> comme + un script : aucun argument n'est utilisé en entrée ou en sortie, et + l'exécution se fait dans l'environnement courant (les variables + créées dans la fonction sont conservées après l'exécution). Cette + forme est plus efficace, car ainsi les instructions du script peuvent + être pré-compilées (voir <link linkend="comp">comp</link>). Cette méthode d'exécution des + scripts permet aussi de stocker des scripts comme des fonctions dans des + bibliothèques. + </para> + <para> + Si une erreur se produit pendant l'exécution, si la chaîne de + caractères <literal>'errcatch'</literal> est présente, <function>exec</function> ne + produit pas de message d'erreur, mais stoppe l'exécution du + script et renvoie une valeur de <varname>ierr</varname> égale au numéro de + l'erreur. Si la chaîne <literal>'errcatch'</literal> n'est pas présente, + la gestion habituelle des erreurs est utilisée. + </para> + </refsection> + <refsection> + <title>REMARQUES</title> + <para> + Les scripts peuvent maintenant contenir des définitions de fonctions en + ligne (voir <link linkend="function">fonction</link>). + </para> + <para> + <function>exec</function> prend en charge les fichiers encodés aux formats ANSI/ASCII et UTF-8. + </para> + <para>La longueur des lignes des fichiers est limitée à 4096 caractères.</para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +// création d'un script +mputl('a=1;b=2',TMPDIR+'/myscript') + +// on l'exécute +exec(TMPDIR+'/myscript') +whos -name "a " + +// création d'une function +function y=foo(x),a=x+1;y=a^2,endfunction +clear a b + +// appel à la fonction +foo(1) + +// a est une variable créée dans l'environnement de la fonction foo +// elle est détruite à la sortie de la fonction. +whos -name "a " + +x=1 // on crée la variable x pour qu'elle soit connue à l'exécution de foo +exec(foo) + +// a et y ont été créées dans l'environnement courant +whos -name "a " +whos -name "y " + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="mode">mode</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/execstr.xml b/modules/functions/help/fr_FR/execstr.xml new file mode 100755 index 000000000..2610910fa --- /dev/null +++ b/modules/functions/help/fr_FR/execstr.xml @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="execstr"> + <refnamediv> + <refname>execstr</refname> + <refpurpose>exécution d'instructions Scilab contenues dans des chaînes de caractères</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>execstr(instr) + ierr = execstr(instr, 'errcatch' [,msg]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>instr</term> + <listitem> + <para>vecteur de chaînes de caractères.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>entier, 0 ou numéro de l'erreur.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg </term> + <listitem> + <para> + chaîne de caractères (<literal>'m'</literal> ou <literal>'n'</literal>). La valeur + par défaut est <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Exécute les instructions Scilab données dans l'argument + <varname>instr</varname>. + </para> + <note> + Note : les instructions <varname>instr</varname> ne doivent pas comporter de marques de suite (..). + </note> + <para> + Si <literal>'errcatch'</literal> n'est pas présent dans les arguments, les erreurs sont contrôlées comme d'habitude. + </para> + <para> + Si <literal>'errcatch'</literal> est présent dans les arguments, et qu'une erreur est + rencontrée lors de l'évaluation d'un élément de <varname>instr</varname>, + <function>execstr</function> ne produit aucun message d'erreur, mais stoppe + l'exécution des instructions stockées dans <varname>instr</varname> (au point + où l'erreur s'est produite), et renvoie dans <varname>ierr</varname> le numéro + de l'erreur. Dans ce cas l'affichage du message d'erreur est contrôlé par + l'option <varname>msg</varname> : + </para> + <variablelist> + <varlistentry> + <term>"m"</term> + <listitem> + <para>le message d'erreur est affiché et enregistré</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"n"</term> + <listitem> + <para>le message d'erreur n'est pas affiché mais il est enregistré + (voir <link linkend="lasterror">lasterror</link>). Il s'agit du comportement par + défaut. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>ierr = execstr(instr, 'errcatch')</code> peut gérer les erreurs de syntaxes. Ceci + peut être utile pour évaluer les instructions obtenues par une requète à + l'utilisateur (interface homme-machine). + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +execstr('a=1') // affecte a=1. + +execstr('1+1') // ne fait rien de particulier (alors que evstr('1+1') renvoie 2) + +execstr(['if %t then'; + ' a=1'; + ' b=a+1'; + 'else' + ' b=0' + 'end']) + +// récupération des erreurs d'exécution +execstr('a=zzzzzzz','errcatch') +execstr('a=zzzzzzz','errcatch','m') + +// récupération des erreurs de syntaxe +execstr('a=1?02','errcatch') +lasterror(%t) + +execstr('a=[1 2 3)','errcatch') +lasterror(%t) + +// variable1 n'existe pas +if execstr('variable1;','errcatch')<>0 then + disp("Declenche une erreur"); +else + disp("execstr est content"); +end + +// variable2 existe ... Pas d'erreur dans execstr +variable2=[2,3]; +if execstr('variable2;','errcatch')<>0 then + disp("Declenche une erreur"); +else + disp("execstr est content"); +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="try">try</link> + </member> + <member> + <link linkend="errclear">errclear</link> + </member> + <member> + <link linkend="iserror">iserror</link> + </member> + <member> + <link linkend="whereami">whereami</link> + </member> + <member> + <link linkend="evstr">evstr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/function.xml b/modules/functions/help/fr_FR/function.xml new file mode 100755 index 000000000..e2e50d34b --- /dev/null +++ b/modules/functions/help/fr_FR/function.xml @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="function"> + <refnamediv> + <refname>function</refname> + <refpurpose>définition d'une fonction Scilab </refpurpose> + </refnamediv> + <refnamediv xml:id="endfunction"> + <refname>endfunction</refname> + <refpurpose>fin de la définition d'une fonction Scilab </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <programlisting role='no-scilab-exec'><![CDATA[ +function <arguments_sortie>=<nom_de_la_fonction><arguments_entrée> + <instructions> +endfunction + ]]></programlisting> + <para> où</para> + <variablelist> + <varlistentry> + <term><nom_de_la_fonction></term> + <listitem> + <para>est le nom de la fonction</para> + </listitem> + </varlistentry> + <varlistentry> + <term><arguments_entrée></term> + <listitem> + <para>est la liste d'arguments d'entrée. Il peut s'agir de :</para> + <itemizedlist> + <listitem> + <para> + une liste de noms de variables séparés par des virgules, entourée de parenthèses, comme <literal>(x1,...,xm)</literal>. Le dernier nom de variable peut être <literal>varargin</literal> (voir <link linkend="varargin">varargin</link>) + </para> + </listitem> + <listitem> + <para> + la séquence <literal>()</literal> ou rien du tout, si la fonction n'a pas d'argument d'entrée. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><arguments_sortie></term> + <listitem> + <para>Est la liste d'arguments de sortie. Il peut s'agir de</para> + <itemizedlist> + <listitem> + <para> + une liste de noms de variables séparés par des virgules, entourée de crochets, comme <literal>[y1,...,ym]</literal>. Le dernier nom de variable peut être <literal>varargout</literal> (voir <link linkend="varargout">varargout</link>) + </para> + </listitem> + <listitem> + <para> + la séquence <literal>[]</literal>, si la fonction n'a pas d'argument de sortie. Dans ce cas la syntaxe d'appel peut aussi être : <literal>function <nom_de_la_fonction><arguments_entrée></literal> + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><instructions></term> + <listitem> + <para> + une suite d'instructions Scilab. Cette syntaxe peut être utilisée pour définir des fonctions (voir <link linkend="functions">functions</link>) en ligne ou dans un script (voir <link linkend="exec">exec</link>). Pour raisons de compatibilité avec les anciennes versions de Scilab, les fonctions définies dans un script ne contenant que des déclarations de fonctions peuvent être chargées dans Scilab avec la fonction <function>exec</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + La séquence <literal>function <arguments_sortie>=<nom_de_la_fonction><arguments_entrée></literal> + doit apparaître sur une seule ligne. Cette suite peut être suivie d'instructions Scilab si une virgule ou un point-virgule est ajouté à la fin. + </para> + <note> + Certaines règles ont été établies quant à la syntaxe des noms de fonctions dans Scilab (voir <link linkend="names">names</link>). + </note> + + <para>Les définitions de fonctions peuvent être imbriquées.</para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +// définition en ligne +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +// définition sur une seule ligne +function y=sq(x),y=x^2,endfunction + +sq(3) + +// définitions imbriquées +function y=foo(x) +a=sin(x) +function y=sq(x), y=x^2,endfunction +y=sq(a)+1 +endfunction + +foo(%pi/3) + +// définition dans un script +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="functions">functions</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="names">names</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/functions.xml b/modules/functions/help/fr_FR/functions.xml new file mode 100755 index 000000000..a01f40c6e --- /dev/null +++ b/modules/functions/help/fr_FR/functions.xml @@ -0,0 +1,184 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="functions"> + <refnamediv> + <refname>functions</refname> + <refpurpose>procédures Scilab et objets Scilab </refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para>Les fonctions Scilab sont des procédures ("macros", "fonction" et "procédures" + ont la même signification). + </para> + </refsection> + <refsection> + <title>Définition de fonctions</title> + <para>Les fonctions sont tapées dans un éditeur de texte et + chargées dans Scilab avec la commande <link linkend="exec">exec</link> ou via une bibliothèque (voir <link linkend="lib">lib</link> ou <link linkend="genlib">genlib</link>). Mais elles peuvent être + définies en ligne (voir <link linkend="deff">deff</link> ou + <link linkend="function">function</link>). Une fonction est + définie en deux parties : + </para> + <itemizedlist> + <listitem> + <para>une ligne de déclaration formelle</para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) +function [y1,...,yn,varargout]=foo(x1,...,xm,varargin) + ]]></programlisting> + </listitem> + <listitem> + <para>une suite d'instructions Scilab.</para> + </listitem> + </itemizedlist> + <para>La "ligne de définition" donne la syntaxe d'appel complète de la + fonction. Les <literal>yi</literal> sont les variables de sortie, + calculées à partir des variables d'entrée <literal>xi</literal> + et des variables existantes dans le contexte appelant lorsque la + fonction est exécutée. On peut utiliser éventuellement un + sous-ensemble de ces variables d'entrée et de sortie. + </para> + </refsection> + <refsection> + <title>Appel à une fonction</title> + <itemizedlist> + <listitem> + <para>La syntaxe d'appel est habituellement + <literal>[y1,...,yn]=foo(x1,...,xm)</literal>. On peut + utiliser éventuellement un sous-ensemble de ces variables + d'entrée et de sortie. Dans ce cas, seules les premières + variables à partir de la gauche sont utilisées. La fonction + <link linkend="argn">argn</link>peut être utilisée pour connaître le + nombre effectif d'arguments d'appel. + </para> + </listitem> + <listitem> + <para>Il est possible de définir des fonction ayant un nombre + indeterminé d'arguments d'entrée et/ou de sortie. Ceci peut + être fait avec les mots clé <link linkend="varargin">varargin</link> et <link linkend="varargout">varargout</link>. Voir les liens fournis + pour plus de détails. + </para> + </listitem> + <listitem> + <para>Il est aussi possible d'utiliser des "arguments + nommés" pour spécifier les valeurs des arguments d'entrée : + supposons que la fonction <varname>x2</varname> est + définie ainsi <code>function y1 = fun1(x1, x2, x3)</code> + alors on peut utiliser la syntaxe + <code>y = fun1(x1=33, x3=[1 2 3])</code>, et dans + <varname>x2</varname> ne sera pas défini. + </para> + <para>Il est aussi possible d'appeler la fonction + <varname>x2</varname> avec une syntaxe comme + <code>y = fun1(x1=33, y='foo')</code>. Dans ce cas la + variable <varname>y</varname> sera définie dans le contexte + local de la fonction. + <note> + Noter qu'alors il n'est pas possible de passer + plus d'arguments d'entrée que le nombre + d'arguments formel declarés dans la définition + de la syntaxe d'appel de la fonction. + </note> + </para> + <para>Il est possible de vérifier quelles sont les variables + définies avec la fonction <link linkend="exists">exists</link>. + </para> + </listitem> + <listitem> + <para>Quand une fonction n'a pas d'argument de sortie et est + appelée avec des arguments d'entrée de type chaîne de + caractère, la syntaxe d'appel peut être simplifiée : + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun('a','toto','une chaîne') + ]]></programlisting> + <para>est alors équivalent à: </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun a toto 'une chaîne' + ]]></programlisting> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Divers</title> + <para>Les fonctions sont des objets Scilab (numéro de type 13 ou + 11). Elles peuvent être manipulées (passées en argument, sauvées, + chargées, ...) comme toute autre variable. + </para> + <para>Un ensemble de fonctions peut être assemblé dans une + bibliothèque. Les fonctions dont le nom commence par le caractère + <literal>%</literal> (exemple : <literal>%foo</literal>) sont + utilisées pour la surcharge des opérateurs (voir <link linkend="overloading">overloading</link>) ou des fonctions pour + des nouveaux types de données. + </para> + <para> + Certaines règles ont été établies quant à la syntaxe des noms de fonctions dans Scilab (voir <link linkend="names">names</link>). + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +// définition en ligne +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +// autre type de définition en ligne +deff('[x,y]=myfct(a,b)',['x=a+b'; + 'y=a-b']) +// définition dans un fichier texte (voir exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="exists">exists</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + <member> + <link linkend="names">names</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/getd.xml b/modules/functions/help/fr_FR/getd.xml new file mode 100755 index 000000000..205b04d5b --- /dev/null +++ b/modules/functions/help/fr_FR/getd.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="getd"> + <refnamediv> + <refname>getd</refname> + <refpurpose>Charge toutes les fonctions contenues dans un répertoire.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>getd(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Argument</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>chaîne de caractères, chemin du répertoire + </para> + <para> + "." si <function>getd</function> est appelée sans argument ou si <varname>path</varname> est une chaîne de caractères vide. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Charge tous les fichiers <literal>.sci</literal> (contenant des fonctions Scilab) présents dans le répertoire <varname>path</varname>. + </para> + <para> + Si le fichier ne contient pas de fonction, le script sera executé. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +getd('SCI/modules/cacsd/macros') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/libraries/CHAPTER b/modules/functions/help/fr_FR/libraries/CHAPTER new file mode 100755 index 000000000..4cd7693b5 --- /dev/null +++ b/modules/functions/help/fr_FR/libraries/CHAPTER @@ -0,0 +1,2 @@ +title = Libraries + diff --git a/modules/functions/help/fr_FR/libraries/whereis.xml b/modules/functions/help/fr_FR/libraries/whereis.xml new file mode 100755 index 000000000..e895d60ce --- /dev/null +++ b/modules/functions/help/fr_FR/libraries/whereis.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="whereis"> + <refnamediv> + <refname>whereis</refname> + <refpurpose>nom de la bibliothèque contenant une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>[librname]=whereis(function-name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Renvoie une chaîne de caractères contenant le nom de la bibliothèque contenant + la fonction <literal>function-name</literal>. + Le chemin d'accès à la bibliothèque peut être obtenu avec la fonction <literal>"librname"</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +whereis("ls") // Devrait retourner fileiolib +whereis("plot") // Devrait retourner graphicslib + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/macr2tree.xml b/modules/functions/help/fr_FR/macr2tree.xml new file mode 100755 index 000000000..c3e714173 --- /dev/null +++ b/modules/functions/help/fr_FR/macr2tree.xml @@ -0,0 +1,52 @@ +<?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="macr2tree"> + <refnamediv> + <refname>macr2tree</refname> + <refpurpose>conversion d'une fonction en arbre</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>t=macr2tree(nom-de-fonction)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>nom-de-fonction</term> + <listitem> + <para>une macro Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>un "arbre" Scilab</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Cette primitive convertit une fonction compilée de Scilab <literal>nom-de-fonction</literal> + en arbre (tlists imbriquées) qui code la représentation interne de la fonction. + A utiliser avec <literal>tree2code</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/macrovar.xml b/modules/functions/help/fr_FR/macrovar.xml new file mode 100755 index 000000000..66eab775d --- /dev/null +++ b/modules/functions/help/fr_FR/macrovar.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) 2013 - Scilab Enterprises - Paul Bignier + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="macrovar"> + <refnamediv> + <refname>macrovar</refname> + <refpurpose>variables d'une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>vars = macrovar(fonction)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>vars</term> + <listitem> + <para> + liste, <literal>list(in, out, nolocal, called, locals)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fonction</term> + <listitem> + <para>nom de la fonction.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Retourne dans une liste l'ensemble des variables utilisées par une fonction. + <varname>vars</varname> est une liste de cinq vecteurs colonnes de chaînes de caractères: + </para> + <simplelist type="inline"> + <member> + <varname>in</varname>: paramètres d'entrée (<code>vars(1)</code>); + </member> + <member> + <varname>out</varname>: paramètres de sortie (<code>vars(2)</code>); + </member> + <member> + <varname>nolocal</varname>: variables référencées qui ne sont pas définies dans la fonction et qui ne sont pas des fonctions (<code>vars(3)</code>); + </member> + <member> + <varname>called</varname>: noms des fonctions appelées (<code>vars(4)</code>); + </member> + <member> + <varname>locals</varname>: variables locales (<code>vars(5)</code>). + </member> + </simplelist> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc'); +vars = macrovar(f) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir Aussi</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/mode.xml b/modules/functions/help/fr_FR/mode.xml new file mode 100755 index 000000000..45bf7b7b4 --- /dev/null +++ b/modules/functions/help/fr_FR/mode.xml @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mode" xml:lang="fr"> + <refnamediv> + <refname>mode</refname> + <refpurpose>choisit le mode d'exécution des scripts et des + fonctions + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>mode(k) + k=mode() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Utilisé + <emphasis role="bold"> + <literal>uniquement</literal> + </emphasis> + dans un script ou une + fonction, <literal>mode(k)</literal> permet de choisir le mode d'affichage + utilisé pendant l'exécution, suivant la valeur de + <literal>k</literal> : + </para> + <variablelist> + <varlistentry> + <term>k = 0</term> + <listitem> + <para>les nouvelles valeurs des variables sont affichées (voir + <link linkend="semicolon">semicolon</link> ou <link linkend="comma">comma</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = -1</term> + <listitem> + <para>l'exécution est silencieuse (rien n'est affiché : + mode par défaut pour les fonctions) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 2</term> + <listitem> + <para>valeur par défaut retournée au prompt de scilab.</para> + <para>veuillez noter que ce mode ne doit pas etre utilisé au prompt mais seulement via un script ou une fonction.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 1 ou k = 3</term> + <listitem> + <para>les nouvelles valeurs des variables sont affichées, + chaque ligne de commande est affichée et + précédée de l'invite de commande (mode par + défaut pour les scripts lancés par "exec") + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 4 ou k = 7</term> + <listitem> + <para>les nouvelles valeurs des variables sont affichées, + chaque ligne de commande est affichée et + précédée de l'invite de commande. L'exécution + est interrompue après chaque ligne et reprend après un + appui sur la touche entrée/return. + </para> + <para>Si la touche entrée/return et précédée du + caractère "p", l'éxecution est suspendue (voir <link linkend="pause">pause</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k > 7</term> + <listitem> + <para>mode défini par l'utilisateur. Si vous définissez + votre propre mode, il est recommandé d'utiliser des valeurs + > 100. + </para> + </listitem> + </varlistentry> + </variablelist> + <para>L'affichage est supprimé dans les fonctions compilées + (voir comp). Par défaut les fonctions Scilab sont + exécutées en mode silencieux ("-1"). + </para> + <para>Les fonctions incluses dans une bibliothèque de fonctions scilab sont executés avec le mode "-1".</para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="exemple"><![CDATA[ +// copier - coller ces lignes dans scilab + +function example_mode( level_mode ) + mode(level_mode) + a = 3 + disp(mode()); +endfunction + +mode(2) + +example_mode(0) +example_mode(-1) +example_mode(2) +example_mode(1) +example_mode(3) +example_mode(7) + +mode(2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="semicolon">semicolon</link> + </member> + <member> + <link linkend="comma">comma</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/profiling/add_profiling.xml b/modules/functions/help/fr_FR/profiling/add_profiling.xml new file mode 100755 index 000000000..b5271b5e9 --- /dev/null +++ b/modules/functions/help/fr_FR/profiling/add_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="add_profiling" xml:lang="en"> + <refnamediv> + <refname>add_profiling</refname> + <refpurpose>Active le profiling d'une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>add_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>Une chaine de caractères: le nom de la fonction à profiler</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>add_profiling</literal> ajoute les + instructions nécessaires au profiling d'une fonction. Ainsi, lors des appels + de cette fonction, le nombre d'appels et le temps d'exécution de chaque ligne sont stockés. + Ces données peuvent être ensuite retournées avec la fonction <link linkend="profile">profile</link>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //execution de la fonction +profile(foo) //extraction des informations de profil + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Fonctions utilisées</title> + <para> + Cette fonction utilise les fonctions Scilab <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/profiling/profile.xml b/modules/functions/help/fr_FR/profiling/profile.xml new file mode 100755 index 000000000..98d25f5b8 --- /dev/null +++ b/modules/functions/help/fr_FR/profiling/profile.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * Copyright (C) 2013 - Samuel GOUGEON + * Copyright (C) 2013 - Scilab Enterprises - Simon MARCHETTO + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should 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="profile"> + <refnamediv> + <refname>profile</refname> + <refpurpose>Renvoie les résultats du profiling d'une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>c = profile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>une fonction Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>une matrice nx3 contenant les résultats de profiling : + <itemizedlist> + <listitem> + <para> + <literal>c(i,1)</literal> : nombre de fois que la ligne i de la fonction a été executée + </para> + </listitem> + <listitem> + <para> + <literal>c(i,2)</literal> : temps CPU cumulé [en secondes] passé pour exécuter la ligne i de la fonction + </para> + </listitem> + <listitem> + <para> + <literal>c(i,3)</literal> : mesure de l'effort de l'interpréteur sur la ligne i de la fonction [unité arbitraire] + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Pour utiliser <literal>profile</literal> sur une fonction, le profiling de la fonction doit d'abord avoir été activé: + <itemizedlist> + <listitem> + <para> + soit en utilisant la commande <link linkend="add_profiling">add_profiling</link> + </para> + </listitem> + <listitem> + <para> + ou si la fonction a été définie avec la commande <link linkend="deff">deff</link>, en positionnant le paramètre optionel de <link linkend="deff">deff</link> à "p". + </para> + </listitem> + </itemizedlist> + </para> + <para> + Une fois que la function a été exécutée, l'appel de <literal>profile</literal> renvoie une matrice, où chaque ligne contient les résultats de profiling de la ligne correspondante de la fonction (en comptant la ligne d'entête), c'est à dire le nombre de passages, ou le temps total passé par le CPU dans cette ligne, et une mesure de l'effort de l'interpréteur pour interpréter la ligne, comme suit: + </para> + <para> + <informaltable border="1"> + <tr> + <td>Nombre d'appels</td><td>Temps total CPU (s)</td><td>Effort interpréteur</td> + </tr> + <tr> + <td>1</td><td>0</td><td>0</td> + </tr> + <tr> + <td>300</td><td>0.1</td><td>0</td> + </tr> + <tr> + <td>300</td><td>3,59</td><td>5</td> + </tr> + <tr> + <td>...</td><td>...</td><td>...</td> + </tr> + </informaltable> + </para> + <para> + Ici nous pouvons voir que la 3ème ligne de la fonction a été appelée 300 fois pour un temps total CPU de 3,59 secondes. + </para> + <para> + Note: en raison de la limite de précision de mesure de temps CPU (en général une micro seconde), certaines lignes dont l'exécution est très rapide peuvent apparaitre avec un temps CPU cumulé à 0. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +// Fonction qui est profilée +function x = foo(n) + if n > 0 then + x = 0; + for k = 1:n + s = svd(rand(n, n)); + x = x + s(1); + end + else + x = []; + end +endfunction + +// Active le profiling de la fonction +add_profiling("foo"); + +// Exécute la fonction +foo(200); + +// Renvoie les résultats de profiling de la fonction +profile(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="showprofile">showprofile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/profiling/remove_profiling.xml b/modules/functions/help/fr_FR/profiling/remove_profiling.xml new file mode 100755 index 000000000..9528b6130 --- /dev/null +++ b/modules/functions/help/fr_FR/profiling/remove_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="remove_profiling" xml:lang="en"> + <refnamediv> + <refname>remove_profiling</refname> + <refpurpose>Désactive le profiling d'une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>remove_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>Une chaine de caractères: le nom de la fonction profilée.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>remove_profiling</literal> supprime les + instructions nécessaires au profiling d'une fonction. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //execution de la fonction +profile(foo) //extraction des informations de profil +remove_profiling("foo") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Fonctions utilisées</title> + <para> + Cette fonction utilise les fonctions Scilab <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/profiling/reset_profiling.xml b/modules/functions/help/fr_FR/profiling/reset_profiling.xml new file mode 100755 index 000000000..f2cbfd3d4 --- /dev/null +++ b/modules/functions/help/fr_FR/profiling/reset_profiling.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="reset_profiling" xml:lang="en"> + <refnamediv> + <refname>reset_profiling</refname> + <refpurpose>remet à zéro les compteurs de profil du code d'une fonction</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>reset_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>Une chaine de caractères: le nom de la fonction</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>reset_profiling(funname)</literal> remet à + zéro les compteurs de profil du code de la fonction dont le nom + est donné par <literal>funname</literal>. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //execution de la fonction +profile(foo) //extraction des informations de profil +reset_profiling("foo") +profile(foo) //extraction des informations de profil + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Fonctions utilisées</title> + <para> + Cette fonction utilise les fonctions Scilab <literal>bytecode</literal> and + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/fr_FR/sciargs.xml b/modules/functions/help/fr_FR/sciargs.xml new file mode 100755 index 000000000..b31293e0a --- /dev/null +++ b/modules/functions/help/fr_FR/sciargs.xml @@ -0,0 +1,29 @@ +<?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="sciargs"> + <refnamediv> + <refname>sciargs</refname> + <refpurpose>arguments sur la ligne de commande Scilab </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>args = sciargs()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + Cette fonction renvoie un vecteur ligne de chaînes de caractères contenant les + arguments de la commande de lancement de Scilab. Le premier terme du vecteur <literal>args</literal> contient le nom complet (avec le chemin) du fichier exécutable de Scilab. + </para> + <para> + Cette fonction correspond à la fonction <literal>getarg</literal> en langage C. + </para> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="getenv">getenv</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ja_JP/addchapter.sce b/modules/functions/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..446f3b3fa --- /dev/null +++ b/modules/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("Functions",SCI+"/modules/functions/help/ja_JP",%T); + diff --git a/modules/functions/help/ja_JP/argn.xml b/modules/functions/help/ja_JP/argn.xml new file mode 100755 index 000000000..988e34363 --- /dev/null +++ b/modules/functions/help/ja_JP/argn.xml @@ -0,0 +1,101 @@ +<?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="argn"> + + <refnamediv> + + <refname>argn</refname> + + <refpurpose>関数コールの入力/出力引数の数を返す</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>[lhs [,rhs] ]=argn() + + lhs=argn(1) + + rhs=argn(2) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para> + + この関数は関数定義の内部で使用されます. + + この関数は関数がコールされた際に関数に指定された実際の入力引数(<varname>lhs</varname>)と + + 出力引数(<varname>lhs</varname>) の数を出力します. + + 通常,関数の定義においてオプションの引数を処理する際に使用されます. + + </para> + + <para> + + <note> + + <varname>lhs</varname> は常に1以上であることに注意してください. + + 言い換えると,関数が出力引数なしにコールされた場合であっても, + + <varname>lhs</varname> は 1 となります. + + </note> + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +function concat=myOwnFunction(name,optional) + [lhs,rhs]=argn(0) + if rhs <= 1 then + optional="my Optional value" + end + if rhs == 0 then + error("Expect at least one argument") + end + concat=name+" "+optional +endfunction + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="varargin">varargin</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/CHAPTER b/modules/functions/help/ja_JP/built_in/CHAPTER new file mode 100755 index 000000000..4beffcea0 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/CHAPTER @@ -0,0 +1,2 @@ +title = Built-in & external + diff --git a/modules/functions/help/ja_JP/built_in/clearfun.xml b/modules/functions/help/ja_JP/built_in/clearfun.xml new file mode 100755 index 000000000..4146592e8 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/clearfun.xml @@ -0,0 +1,106 @@ +<?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="clearfun"> + + <refnamediv> + + <refname>clearfun</refname> + + <refpurpose>プリミティブ(組み込み関数)を削除</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>ret=clearfun('name')</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>'name'</term> + + <listitem> + + <para>プリミティブの名前</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>ret</term> + + <listitem> + + <para>論理値</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>clearfun('name')</literal> は, + + プリミティブ(組み込み関数)の集合から + + プリミティブ<literal>'name'</literal>を削除します. + + <literal>clearfun</literal>は, + + <literal>%t</literal> または <literal>%f</literal>を返します. + + この関数によりプリミティブをリネームすることが可能になります : + + Scilab プリミティブをユーザが定義した関数で置換することが + + できます. + + この関数は,エキスパート用です... + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="newfun">newfun</link> + + </member> + + <member> + + <link linkend="funptr">funptr</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/external.xml b/modules/functions/help/ja_JP/built_in/external.xml new file mode 100755 index 000000000..e70abda86 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/external.xml @@ -0,0 +1,196 @@ +<?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="external"> + + <refnamediv> + + <refname>external</refname> + + <refpurpose>Scilabオブジェクト, 外部関数またはルーチン</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <para> + + 特定のコマンドで使用する外部関数またはルーチン. + + </para> + + <para> + + "external" は, + + (<literal>ode</literal>, <literal>optim</literal>, <literal>schur</literal>... + + のような) + + いくつかの高レベルプリミティブの引数として使用される + + 関数またはルーチンです. + + </para> + + <para> + + external (関数またはルーチン)の呼び出し手順は, + + external の引数を設定する高レベルプリミティブにより + + 規定されています. + + </para> + + <para> + + 例えば, 外部関数 <literal>costfunc</literal> は, + + <literal>optim</literal> プリミティブの引数です. + + その呼出し手順は次のようになります: <literal>[f,g,ind]=costfunc(x,ind)</literal> + + そして <literal>optim</literal> (高レベル最適化プリミティブ)は + + 以下のようにコールされます + + </para> + + <programlisting role=""><![CDATA[ +optim(costfunc,...) + ]]></programlisting> + + <para> + + ここで, <literal>costfunc</literal> (評価関数はプリミティブ + + <literal>optim</literal>により最小化されます)は, + + <literal>f=f(x)</literal> および<literal>x</literal>における + + <literal>f</literal>の傾き<literal>g</literal>を評価します + + (<literal>ind</literal> は整数です. その使用法は + + <literal>optim</literal>ヘルプに詳述されています). + + </para> + + <para> + + その他の値が外部関数により必要とされる場合, + + これらの変数をその環境において定義することができます. + + また, 外部関数をリスト内に置くことができます. + + 例えば,外部関数 + + </para> + + <programlisting role=""><![CDATA[ +[f,g,ind]=costfunc(x,ind,a,b,c) + ]]></programlisting> + + <para> + + は, external が + + <literal>list(costfunc,a,b,c)</literal>の場合, + + <literal>optim</literal>に適用できます. + + そして, <literal>optim</literal>へのコールは + + 以下のようになります: + + </para> + + <programlisting role=""><![CDATA[ +optim(list(costfunc,a1,b1,c1),.... + ]]></programlisting> + + <para> + + externalはFortranまたはCルーチンとすることもできます: + + これは計算を高速化するために有用です. + + </para> + + <para> + + ルーチンの名前は文字列として高レベルプリミティブに + + 指定することができます. + + このルーチンの呼び出し手順も規定されています. + + </para> + + <para> + + 外部FortranまたはCルーチンも動的にリンクできます + + (<literal>link</literal>参照). + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="ode">ode</link> + + </member> + + <member> + + <link linkend="optim">optim</link> + + </member> + + <member> + + <link linkend="impl">impl</link> + + </member> + + <member> + + <link linkend="dassl">dassl</link> + + </member> + + <member> + + <link linkend="intg">intg</link> + + </member> + + <member> + + <link linkend="schur">schur</link> + + </member> + + <member> + + <link linkend="gschur">gschur</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/funptr.xml b/modules/functions/help/ja_JP/built_in/funptr.xml new file mode 100755 index 000000000..f560f7602 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/funptr.xml @@ -0,0 +1,143 @@ +<?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="funptr"> + + <refnamediv> + + <refname>funptr</refname> + + <refpurpose>プリミティブのコーディング ( 上級者向け ) </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>[numptr] = funptr(name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>name</term> + + <listitem> + + <para>文字列,プリミティブの名前</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>numptr</term> + + <listitem> + + <para>プリミティブの内部ルーチン番号</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + プリミティブ<literal>'name'</literal>の + + 内部的なルーチン番号<literal>numptr</literal>を取得するためのユーティリティ関数(上級者専用). + + <literal>numptr</literal> は,インターフェイス番号 <literal>fun</literal>および + + そのインターフェイス内のプリミティブのルーチン番号 <literal>fin</literal>により + + <literal>numptr = 1000*fun + fin</literal> (fin < 1000) のように計算されます. + + <literal>numptr</literal> により, インターフェイス番号 <literal>fun = floor(numptr/1000)</literal> + + を得ることができます. + + この番号は,参照渡しの引数を有する動的インターフェイスにリンクする際に有用です + + (以下の例を参照). + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// Suppose you want to load some codes via the dynamic +// loading facilities offers by addinter. By default +// arguments are passed by values but if you want to +// pass them by reference you can do the following +// (name being the scilab name of one of the interfaced +// routines) : +// +// addinter(files,spnames,fcts) // args passed by values +// num_interface = floor(funptr(name)/1000) +// intppty(num_interface) // args now passed by reference +// +// Note that if you enter the following +// +// intppty() +// +// you will see all the interfaces working by reference + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="clearfun">clearfun</link> + + </member> + + <member> + + <link linkend="newfun">newfun</link> + + </member> + + <member> + + <link linkend="intppty">intppty</link> + + </member> + + <member> + + <link linkend="addinter">addinter</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/intppty.xml b/modules/functions/help/ja_JP/built_in/intppty.xml new file mode 100755 index 000000000..dd3e03a24 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/intppty.xml @@ -0,0 +1,199 @@ +<?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="intppty"> + + <refnamediv> + + <refname>intppty</refname> + + <refpurpose>プロパティを指定するインターフェイス引数を指定</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>funs=intppty() + + intppty(fun) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para> + 整数, インターフェイス番号 (<link linkend="funptr">funptr</link>参照) + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>funs</term> + + <listitem> + + <para>整数ベクトル, インターフェイス番号のベクトル + + (<link linkend="funptr">funptr</link>参照) + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + インターフェイスプログラムでは,関数の引数を渡す手順を + + 2種類の異なる手法で記述することができます. + + </para> + + <para> + + 最初のデフォルトの方法の場合, + + 引数は値で渡されます. + + これは以下の構文となります: + + </para> + + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + + <para> + + <literal>A</literal>で指定した引数は値で渡され + + (<literal>foo</literal>がコールされる前に + + <literal>A</literal>のコピーが作成されます), + + <literal>1+2</literal>で指定した引数も値で渡されます. + + </para> + + <para> + + 2番目の方法では,"名前付きの引数"がある場合, + + 引数をリファレンスで渡すことができます + + (変数の値のコピーは行われません). + + + + <literal>fun>0</literal>を指定して<literal>intppty(fun)</literal>とすると, + + 番号 <literal>fun</literal>のインターフェイスにより + + リファレンスに渡しの引数を処理できることがScilabに伝えられます. + + 以下の構文の場合: + + </para> + + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + + <para> + + <literal>A</literal> が指す引数はリファレンス渡しされ, + + <literal>1+2</literal> が指す引数は値で渡されます. + + </para> + + <para> + + <warning> + + 番号<literal>fun</literal>のインターフェイスを宣言することにより, + + 予測不能な結果を生み出す場合でない限り, + + リファレンス渡しの引数を処理できることに注意してください. + + </warning> + + </para> + + <para> + + <literal>fun<0</literal>の場合の<literal>intppty(fun)</literal>は + + インターフェイス<literal>-fun</literal>に関して + + その使用を停止します. + + </para> + + <para> + + <literal>intppty()</literal> は, + + 参照渡しされる引数を処理するインターフェイスのベクトルを返します. + + </para> + + <para> + + この関数は動的にロードされるインターフェイスの場合に有用です + + (<link linkend="addinter">addinter</link>参照). + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="funptr">funptr</link> + + </member> + + <member> + + <link linkend="addinter">addinter</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/newfun.xml b/modules/functions/help/ja_JP/built_in/newfun.xml new file mode 100755 index 000000000..7b1ea2e29 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/newfun.xml @@ -0,0 +1,166 @@ +<?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="newfun"> + + <refnamediv> + + <refname>newfun</refname> + + <refpurpose>関数のテーブルに名前を追加する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>newfun(function_name, function_ptr)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>function_name</term> + + <listitem> + + <para>文字列, 有効な関数名を指定する</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>function_ptr</term> + + <listitem> + + <para>整数値を有する正の数 (以下参照)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para>ユーティリティ関数 (上級者専用). </para> + + <para> + + 名前 <literal>function-name</literal>を + + インタプリタに既知の関数テーブルに追加します. + + </para> + + <para> + + <literal>function_ptr</literal>は整数<literal>1000*fun+fin</literal>です. + + ただし,<literal>fun</literal> および <literal>fin</literal>は, + + プリミティブ<literal>function_name</literal>の内部的なコーディングです. + + </para> + + <para> + + この関数は,プリミティブを + + <literal>"gw_user.c"</literal> でコールされるゲートウェイ + + (<literal>fun=14</literal>)に関連付ける際に有用です. + + ただし, + + <link linkend="ilib_build">ilib_build</link>関数が + + C, C++ または Fortranコードに基づき新しい関数で + + Scilabを拡張するためのより簡単な方法であることに注意してください. + + </para> + + <para> + + この関数は,既存のプリミティブ関数にエイリアスを追加したり, + + リネームする場合にも使用可能です. + + </para> + + <para> + + <literal>funptr</literal> および <literal>clearfun</literal> + + と共に使用すると,既存のプリミティブ関数にエイリアスを + + 追加したり, リネームすることができます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ + absptr=funptr("abs");// get the function_ptr associated with the abs function + newfun("abs_bis",absptr) // create an alias of the abs function + abs_bis(-1+%i) + clearfun("abs") // remove abs as a known function + + //redefine abs + function y=abs(x) + y=abs_bis(real(x)); + endfunction + + abs(-1+%i) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="clearfun">clearfun</link> + + </member> + + <member> + + <link linkend="funptr">funptr</link> + + </member> + + <member> + + <link linkend="ilib_build">ilib_build</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/readgateway.xml b/modules/functions/help/ja_JP/built_in/readgateway.xml new file mode 100755 index 000000000..08e8c8b4e --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/readgateway.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="readgateway" xml:lang="ja"> + + <refnamediv> + + <refname>readgateway</refname> + + <refpurpose>モジュールのプリミティブの一覧を取得</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>readgateway(module_name) + + primitives = readgateway(module_name); + + [primitives,primitivesID] = readgateway(module_name); + + [primitives,primitivesID,gatewayID] = readgateway(module_name); + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>module_name</term> + + <listitem> + + <para>文字列</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>primitives, primitivesID, gatewayID</term> + + <listitem> + + <para>文字列の行列</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>readgateway(module_name)</literal>は, + + <literal>module_name</literal>の + + プリミティブの一覧を取得します. + + </para> + + <para> + + <literal>primitives</literal>: <literal>module_name</literal>のプリミティブの一覧. + + </para> + + <para> + + <literal>primitivesID</literal>: プリミティブのIDの一覧. + + </para> + + <para> + + <literal>gatewayID</literal>: <literal>module_name</literal>に関連するゲートウエイのIDの一覧 + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +[primitives,primitivesID,gatewayID] = readgateway('core'); +primitives(1) // 'debug' primitive +primitivesID(1) // 1 is ID of 'debug' in 'core' gateway +gatewayID(1) // 13 is ID of 'core' gateway in scilab + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="getmodules">getmodules</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/built_in/what.xml b/modules/functions/help/ja_JP/built_in/what.xml new file mode 100755 index 000000000..8193820f1 --- /dev/null +++ b/modules/functions/help/ja_JP/built_in/what.xml @@ -0,0 +1,36 @@ +<?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="what"> + + <refnamediv> + + <refname>what</refname> + + <refpurpose>Scilabプリミティブの一覧を得る + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>what() + + [primitives,commands]=what(); + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para>低レベルプリミティブおよびコマンドの一覧を得ます.</para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/bytecode.xml b/modules/functions/help/ja_JP/bytecode.xml new file mode 100755 index 000000000..44b0ba213 --- /dev/null +++ b/modules/functions/help/ja_JP/bytecode.xml @@ -0,0 +1,180 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA Serge Steer + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + *--> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="bytecode"> + + <refnamediv> + + <refname>bytecode</refname> + + <refpurpose> + + Scilab関数を指定すると"バイトコード"をScilab配列に返す, + + またはその逆の処理を行う. + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + x = bytecode(f) + + f = bytecode(x) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>f</term> + + <listitem> + + <para> + + Scilab 関数. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para> + + int32 行ベクトル + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>f= bytecode(x)</code>は, + + Scilab関数 <varname>f</varname> の "バイトコード"を + + 整数配列<varname>x</varname>に返します. + + </para> + + <para> + + <code>f= bytecode(x)</code> は, + + Scilabの整数配列 <varname>x</varname> で指定した + + "バイトコード"が示す関数 <varname>f</varname> を + + 返します. + + <warning> + + 警告: <varname>x</varname> の有効性は確認されません. + + </warning> + + </para> + + </refsection> + + <refsection> + + <title>注意</title> + + <para> + + Scilab関数のバイトコードは,将来劇的に進化すると予想されるため, + + この関数はプロファイル命令の処理に限って使用するべきです. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +function a=foo(),a=sin(3),endfunction +bytecode(foo) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="bytecodewalk">bytecodewalk</link> + + </member> + + <member> + + <link linkend="macr2lst">macr2lst</link> + + </member> + + <member> + + <link linkend="macr2tree">macr2tree</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/bytecodewalk.xml b/modules/functions/help/ja_JP/bytecodewalk.xml new file mode 100755 index 000000000..1ff879d80 --- /dev/null +++ b/modules/functions/help/ja_JP/bytecodewalk.xml @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Ajouter ici d'éventuels commentaires sur le fichier XML +--> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" 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="bytecodewalk"> + + <refnamediv> + + <refname>bytecodewalk</refname> + + <refpurpose> + + 関数バイトコードを検索し,変換する. + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>c1 = bytecodewalk(code,query,job)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>code</term> + + <listitem> + + <para> + + int32 ベクトル: 入力バイトコード配列 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>query</term> + + <listitem> + + <para> + + 整数, 検索対象のオペコード + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>job</term> + + <listitem> + + <para> + + 指示するオペコードで実行する処理 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c1</term> + + <listitem> + + <para> + + int32 ベクトル: 出力バイトコード配列 + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数バイトコードコードを検索し, + + 変換します. + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="bytecode">bytecode</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/code2str.xml b/modules/functions/help/ja_JP/code2str.xml new file mode 100755 index 000000000..826ea3898 --- /dev/null +++ b/modules/functions/help/ja_JP/code2str.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="code2str" xml:lang="en"> + + <refnamediv> + + <refname>code2str</refname> + + <refpurpose> + + Scilab整数コードに関連した文字列を返す. + + <emphasis role="bold">この関数は廃止されました.</emphasis> + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>str = code2str(c)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>文字列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c</term> + + <listitem> + + <para>整数コードの文字ベクトル.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>str = code2str(c)</code> は + + Scilab整数コードに関連する文字列を返します. + + <varname>str</varname>は, + + <literal>c(i)</literal>が<literal>part(str,i)</literal>の + + Scilab整数コードとなるような文字列です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +code2str([-28 12 18 21 10 11]) +str2code('Scilab')' + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="str2code">str2code</link> + + </member> + + <member> + + <link linkend="ascii">ascii</link> + + </member> + + <member> + + <link linkend="part">part</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>履歴</title> + + <revhistory> + + <revision> + + <revnumber>5.4.0</revnumber> + + <revremark>この関数はScilab 6.0.0で削除されます</revremark> + + </revision> + + </revhistory> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/comp.xml b/modules/functions/help/ja_JP/comp.xml new file mode 100755 index 000000000..173d3f302 --- /dev/null +++ b/modules/functions/help/ja_JP/comp.xml @@ -0,0 +1,169 @@ +<?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: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="comp" xml:lang="ja"> + + <refnamediv> + + <refname>comp</refname> + + <refpurpose>scilab 関数のコンパイル</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>comp(function [,opt])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>function</term> + + <listitem> + + <para>コンパイルされていないscilab関数 (タイプ 11)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>opt</term> + + <listitem> + + <para>フラグ. 値は 0 (デフォルト), 1 または 2.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>comp(function)</literal> は関数 + + <literal>function</literal>をコンパイルします. + + コンパイル済みの関数と解釈された関数は等価ですが, + + 通常はコンパイル済みの関数の方がはるかに高速です. + + 標準ライブラリとして提供される関数はコンパイルされています. + + </para> + + <para> + コマンド<literal>exec</literal>と<literal>deff</literal>の短縮構文と + + 同様に,オンライン定義もコンパイルされた関数を生成します. + + このため, <literal>comp</literal>は非常に特殊な + + ケースで使用するべきです. + + コンパイルされていない関数を作成するには, + + <link linkend="exec">exec</link> または + + <link linkend="deff">deff</link> に + + オプション <literal>"n"</literal> を指定する必要があります. + + </para> + + <para> + + 値 <literal>opt==2</literal>は,"プロファイル用に"コンパイルされた + + 関数を作成します. + + <link linkend="add_profiling">add_profiling</link>関数により, + + コンパイル後でもプロファイル命令を追加することが可能になっています. + + </para> + + <para> + + 廃止された <literal>opt==1</literal>オプションは + + コード解析用であり, 現在では無視されます. + + すなわち,<literal>opt==0</literal>とみなされます. + + </para> + + <para>注意: コンパイルは"インプレース"で行われます, すなわち, + + 元の関数は修正され,新しいオブジェクトは生成されません. + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="type">type</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/deff.xml b/modules/functions/help/ja_JP/deff.xml new file mode 100755 index 000000000..ed8106351 --- /dev/null +++ b/modules/functions/help/ja_JP/deff.xml @@ -0,0 +1,229 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="deff"> + + <refnamediv> + + <refname>deff</refname> + + <refpurpose>関数のオンライン定義</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>deff('[s1, s2,...] = newfunction(e1, e2,...)',text [,opt])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>e1, e2, ...</term> + + <listitem> + + <para>入力変数.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>s1, s2, ...</term> + + <listitem> + + <para>出力変数.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>text</term> + + <listitem> + + <para>文字列行列</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>opt</term> + + <listitem> + + <para>オプションの文字列:</para> + + <variablelist> + + <varlistentry> + + <term>'c'</term> + + <listitem> + + <para>実行効率改善のために関数は "コンパイル" されます (デフォルト);</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>'p'</term> + + <listitem> + + <para>関数は"コンパイル"され, + + プロファイルに備えます (<link linkend="profile">profile</link>参照); + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>'n'</term> + + <listitem> + + <para>関数は"コンパイル"されません.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>deff</function> はテキスト文字列で記述された一連の命令から + + 関数を定義する際に使用されます. + + 得られる関数オブジェクトはテキストファイルで定義され, + + <function>exec</function> または <function>exec</function> で + + 定義された他の関数と同じ特性を有しています. + + </para> + + <para> + + 命令の中の引用符(文字列の区切りまたは行列の転置を意味する)は, + + ただしく解釈されるように二重化する必要があります(<link linkend="quote">quote</link>のヘルプを参照). + + この仕様のため,作成作業はやや不便となります. + + このような場合のオプションとしては,通常と同様に関数を + + ファイルで定義し, + + (<literal>'n'</literal> オプションを付けて) + + <function>exec</function>によりScilabにロードし, + + <function>deff</function> 命令と同じ出力を得るために + + <function>sci2exp</function>を使用するという方法があります. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +deff('[x]=myplus(y,z)','x=y+z') +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="quote">quote</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/edit.xml b/modules/functions/help/ja_JP/edit.xml new file mode 100755 index 000000000..f92b10284 --- /dev/null +++ b/modules/functions/help/ja_JP/edit.xml @@ -0,0 +1,177 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="edit" xml:lang="ja"> + + <refnamediv> + + <refname>edit</refname> + + <refpurpose>関数を編集</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>edit(functionname[,linenumber])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>functionname</term> + + <listitem> + + <para>文字列</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>linenumber</term> + + <listitem> + + <para>整数</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>functionname</literal> が定義済みの + + Scilab関数の名前の場合, + + <literal>edit(functionname)</literal> は + + 関連するファイル <literal>functionname.sci</literal> を + + オープンします. + + </para> + + <para> + + <literal>functionname</literal>が未定義のScilab関数の名前の場合, + + <literal>edit</literal> はカレントのディレクトリに + + <literal>functionname.sci</literal>ファイルを作成します. + + </para> + + <para> + + <literal>functionname</literal> が有効なマクロまたは + + 関数名でない場合, + + <literal>edit(functionname)</literal> は + + <literal>functionname</literal>に等しいファイル名を有する + + ファイルをオープンします. + + </para> + + <para> + + <literal>linenumber</literal> が指定された場合, + + ファイルはファイル名自体と同じ名前のマクロの + + 定義を基準としてこの行でオープンします. + + マクロ定義が見つからない場合, + + ファイルが指定した<literal>linenumber</literal>行目で + + オープンされます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//この関数へのテキストを指定したエディタをオープン +edit('edit') + +//新しい関数に関してエディタをオープン +edit('myfunction') + +//TMPDIRディレクトリのファイルbar.sciをオープン +edit(fullfile(TMPDIR+'bar.sci')) + +// test_run()の定義を基準として +// ファイルtest_run.sciの123行目をオープン +edit('test_run', 123) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="manedit">manedit</link> + + </member> + + <member> + + <link linkend="names">names</link> + + </member> + + <member> + + <link linkend="editor">editor</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/exec.xml b/modules/functions/help/ja_JP/exec.xml new file mode 100755 index 000000000..fcd0636d5 --- /dev/null +++ b/modules/functions/help/ja_JP/exec.xml @@ -0,0 +1,361 @@ +<?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="exec"> + + <refnamediv> + + <refname>exec</refname> + + <refpurpose>スクリプトファイルを実行する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>exec(path [,mode]) + + exec(fun [,mode]) + + ierr = exec(path, 'errcatch' [,mode]) + + ierr = exec(fun, 'errcatch' [,mode]) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>path</term> + + <listitem> + + <para>文字列, スクリプトファイルへのパス</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>mode</term> + + <listitem> + + <para>整数スカラー,実行モード (以下参照)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para>scilab 関数</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>ierr</term> + + <listitem> + + <para>整数, 0 またはエラー番号</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>exec(path [,mode])</code> は, + + <varname>path</varname>で指定したファイルの中のオプションの + + 実行モード<varname>mode</varname> でScilab命令を逐次実行します. + + </para> + + <para> + + 以下の <varname>mode</varname> を指定できます : + + </para> + + <variablelist> + + <varlistentry> + + <term>0</term> + + <listitem> + + <para> + + デフォルト値. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>-1</term> + + <listitem> + + <para> + + 何も出力しない. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>1</term> + + <listitem> + + <para> + + 各コマンド行を出力(エコーバック)する. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>2</term> + + <listitem> + + <para> + + プロンプト <literal>--></literal> を出力する. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>3</term> + + <listitem> + + <para> + + エコー + プロンプト. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>4</term> + + <listitem> + + <para> + + 各プロンプト出力の前に停止します. キャレッジリターンを入力すると実行が再開します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>7</term> + + <listitem> + + <para> + + 停止 + プロンプト + エコー : デモを行う際に有用なモード. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para> + + <code>exec(fun [,mode])</code> は関数 + + <varname>fun</varname> をスクリプトとして実行します: + + 入出力の引数も特定の変数環境もありません. + + スクリプトコードはプリコンパイル(<link linkend="comp">comp</link>参照) + + できるため,この形式は最も効率的です. + + スクリプト評価のこの方法により,スクリプトをライブラリの + + 関数として保存することが可能になります. + + </para> + + <para> + + 実行時にエラーが発生し, + + <literal>'errcatch'</literal>フラグが指定されている場合, + + <function>exec</function>はエラーメッセージを出力せずに + + 命令を実行を破棄し,エラー番号を<varname>ierr</varname>に + + 代入して復帰します. + + <literal>'errcatch'</literal> フラグが存在しない場合,標準のエラー処理が + + 機能します. + + </para> + + </refsection> + + <refsection> + + <title>注意</title> + + <para> + + <function>exec</function> ファイルは, + + インライン関数定義構文(関数の項参照)により関数を定義する際に使用されます + + (<link linkend="function">function</link>参照). + + </para> + + <para> + + <function>exec</function> はANSI/アスキー および UTF-8 エンコード + + されたファイルをサポートします. + + </para> + + <para>ファイル中の各行の長さは 4096 文字に制限されています.</para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// スクリプトファイルを作成 +mputl('a=1;b=2',TMPDIR+'/myscript') +// スクリプトを実行 +exec(TMPDIR+'/myscript') +whos -name "a " +// 関数を作成 +deff('y=foo(x)','a=x+1;y=a^2') +clear a b +// 関数をコール +foo(1) +// a は関数 foo の環境に作成された変数 +// この変数は foo がリターンする時に破棄されます +whos -name "a " +x=1 // xを作成し,スクリプトfooによりアクセス可能とする. +exec(foo) +// カレントの環境にa と y が作成されました +whos -name "a " +whos -name "y " + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="execstr">execstr</link> + + </member> + + <member> + + <link linkend="evstr">evstr</link> + + </member> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="mode">mode</link> + + </member> + + <member> + + <link linkend="chdir">chdir</link> + + </member> + + <member> + + <link linkend="pwd">pwd</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/execstr.xml b/modules/functions/help/ja_JP/execstr.xml new file mode 100755 index 000000000..88b68dbbe --- /dev/null +++ b/modules/functions/help/ja_JP/execstr.xml @@ -0,0 +1,263 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="execstr"> + + <refnamediv> + + <refname>execstr</refname> + + <refpurpose>文字列中のScilabコードを実行</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>execstr(instr) + + ierr = execstr(instr, 'errcatch' [,msg]) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>instr</term> + + <listitem> + + <para>文字列のベクトル, 実行するScilab命令.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>ierr</term> + + <listitem> + + <para>整数, 0 ばたはエラー番号.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>msg</term> + + <listitem> + + <para> + + 値<literal>'m'</literal> または<literal>'n'</literal> + + を有する文字列. + + デフォルト値は<literal>'n'</literal>. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 引数<varname>instr</varname>で指定したScilab命令を実行します. + + </para> + + <note> + + <varname>instr</varname>の中では継続記号 (..) を使用する + + べきではないことに注意してください. + + </note> + + <para> + + <literal>'errcatch'</literal>フラグが指定されない場合, + + エラー処理は通常と同様に行われます. + + </para> + + <para> + + <literal>'errcatch'</literal>フラグが指定された場合, + + <varname>instr</varname>で定義された命令を実行す際に + + 発生したエラーはエラーメッセージを発生せず, + + <varname>instr</varname> 命令の実行を + + (エラーが発生した場所で)破棄し, + + エラー番号に等しい<varname>ierr</varname>を返して + + 復帰します. + + この場合,エラーメッセージの出力は + + <varname>msg</varname>オプションにより次のように + + 制御されます: + + </para> + + <variablelist> + + <varlistentry> + + <term>"m"</term> + + <listitem> + + <para>エラーメッセージは表示され,記録されます.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>"n"</term> + + <listitem> + + <para> + + エラーメッセージは表示されませんが, + + 記録されます ( <link linkend="lasterror">lasterror</link>参照). + + これがデフォルトです. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para> + + <code>ierr = execstr(instr, 'errcatch')</code> は構文エラーも + + 処理することができます. + + この特徴は,ユーザへの問い合わせにより得られた命令を + + 評価する際に有用です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +execstr('a=1') // sets a=1. +execstr('1+1') // does nothing (while evstr('1+1') returns 2) +execstr(['if %t then'; + ' a=1'; + ' b=a+1'; + 'else' + ' b=0' + 'end']) +execstr('a=zzzzzzz','errcatch') +execstr('a=zzzzzzz','errcatch','m') +//syntax errors +execstr('a=1?02','errcatch') +lasterror(%t) +execstr('a=[1 2 3)','errcatch') +lasterror(%t) +// variable1 does not exist +if execstr('variable1;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end +// variable2 exists ... no error is triggered by execstr +variable2=[2,3]; +if execstr('variable2;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="evstr">evstr</link> + + </member> + + <member> + + <link linkend="lasterror">lasterror</link> + + </member> + + <member> + + <link linkend="error">error</link> + + </member> + + <member> + + <link linkend="try">try</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/fun2string.xml b/modules/functions/help/ja_JP/fun2string.xml new file mode 100755 index 000000000..82ab8794c --- /dev/null +++ b/modules/functions/help/ja_JP/fun2string.xml @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="fun2string"> + + <refnamediv> + + <refname>fun2string</refname> + + <refpurpose>Scilab関数のアスキー定義を生成する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>txt = fun2string(fun, name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para> + <literal>function</literal>型変数 + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>name</term> + + <listitem> + + <para>文字列, 生成した関数名</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>txt</term> + + <listitem> + + <para>文字列の列ベクトル, Scilab関数を指定するテキスト</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + ロード済みのScilab関数の擬似コードを指定すると, + + <function>fun2string</function> により, + + そのコードを再度生成することができます. + + 生成したコードはインデントされ, 整形されます. + + </para> + + <para> + + 仕組みは<function>mfile2sci</function>に似ていますが, より簡単です. + + 構文の変換に使用することも可能です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +txt = fun2string(asinh,'foo'); +write(%io(2),txt,'(a)') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="edit">edit</link> + + </member> + + <member> + + <link linkend="macrovar">macrovar</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/funcprot.xml b/modules/functions/help/ja_JP/funcprot.xml new file mode 100755 index 000000000..1250e710e --- /dev/null +++ b/modules/functions/help/ja_JP/funcprot.xml @@ -0,0 +1,168 @@ +<?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="funcprot"> + + <refnamediv> + + <refname>funcprot</refname> + + <refpurpose>Scilab関数保護モードを切替える</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>funcprot(prot) + + previousprot = funcprot(prot) + + prot = funcprot() + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>prot</term> + + <listitem> + + <para> + + 整数で,指定可能な値は 0,1,2となります + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>previousprot</term> + + <listitem> + + <para> + + 整数で,指定可能な値は 0,1,2, + + 前の値を返します + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + Scilab 関数が変数の場合, + + <function>funcprot</function> によりこのような変数が再定義された場合の + + Scilabの動作をユーザが指定することができます. + + </para> + + <itemizedlist> + + <listitem> + + <para> + + <code>prot==0</code> の場合, 何も特別なことは行われません + + </para> + + </listitem> + + <listitem> + + <para> + + <code>prot==1</code> の場合, 関数が再定義された時に + + 警告メッセージを出力します (デフォルトのモード). + + </para> + + </listitem> + + <listitem> + + <para> + + <code>prot==2</code> の場合,関数が再定義された時に + + Scilabはエラーを発生します. + + </para> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +previousprot = funcprot(1) +deff('x = foo(a)','x = a;') +deff('x = foo(a)','x = a + 1;') +foo = 33 +funcprot(0) +deff('x = foo(a)', 'x = a;') +deff('x = foo(a)', 'x = a + 1;') +foo = 33 +funcprot(previousprot) +]]></programlisting> + + </refsection> + + <refsection> + + <title>History</title> + + <revhistory> + + <revision> + + <revnumber>5.4.0</revnumber> + + <revremark> + + 前の値は,新規値を設定する際に + + 出力引数として返されます. + + </revremark> + + </revision> + + </revhistory> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/function.xml b/modules/functions/help/ja_JP/function.xml new file mode 100755 index 000000000..277b19aec --- /dev/null +++ b/modules/functions/help/ja_JP/function.xml @@ -0,0 +1,277 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="function"> + + <refnamediv> + + <refname>function</refname> + + <refpurpose>関数定義をオープンする</refpurpose> + + </refnamediv> + + <refnamediv xml:id="endfunction"> + + <refname>endfunction</refname> + + <refpurpose>関数定義を閉じる</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <programlisting role='no-scilab-exec'><![CDATA[ +function <lhs_arguments>=<function_name><rhs_arguments> + <statements> +endfunction + ]]></programlisting> + + <para> + + ただし, + + </para> + + <variablelist> + + <varlistentry> + + <term><function_name></term> + + <listitem> + + <para>は関数の名前を意味します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term><rhs_arguments></term> + + <listitem> + + <para>は入力引数のリストを意味します.</para> + + <itemizedlist> + + <listitem> + + <para> + + <literal>(x1,...,xm)</literal>のように括弧で括った + + カンマ区切りの変数名の一覧となります. + + 最後の変数名はキーワード<literal>varargin</literal>と + + することも可能です + + (<link linkend="varargin">varargin</link> 参照) + + </para> + + </listitem> + + <listitem> + + <para> + + 関数に入力引数がない場合, <literal>()</literal> または + + 何も付けません. + + </para> + + </listitem> + + </itemizedlist> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term><lhs_arguments></term> + + <listitem> + + <para>は出力引数のリストを意味します.</para> + + <itemizedlist> + + <listitem> + + <para> + + これは,<literal>[y1,...,yn]</literal>のように角括弧で括った + + カンマ区切りの変数名の一覧となります. + + 最後の変数名はキーワード <literal>varargout</literal> + + (<link linkend="varargout">varargout</link> 参照)とすること + + が可能です. + + </para> + + </listitem> + + <listitem> + + <para> + + 関数が出力引数を持たない場合,<literal>[]</literal> を指定します. + + この場合,構文を以下のようにすることも可能です: + + <literal>function <function_name><rhs_arguments></literal> + + </para> + + </listitem> + + </itemizedlist> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term><statements></term> + + <listitem> + + <para> + + Scilab命令(ステートメント)の集合を意味します. + + この構文は,インラインまたはスクリプトファイル(exec 参照)の中で + + 関数を定義する (<link linkend="functions">functions</link> 参照)ために使用できます. + + 古いバージョンのScilabとの互換性のため, + + function 定義のみを含むスクリプトファイルで定義された関数は, + + <literal>exec</literal>関数によりScilabに"ロードする"ことができます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para> + + <literal>function <lhs_arguments>=<function_name><rhs_arguments></literal> + + のシーケンスは複数の行に分割することができません. + + このシーケンスはカンマまたはセミコロンを終端に付けることにより, + + 同じ行に命令を続けることができます. + + </para> + + <note> + + <literal><function_name></literal> は + + いくつかの構文規則に従う必要があることに注意してください + + (<link linkend="names">names</link>参照). + + </note> + + <para> + + function の定義はネストすることが可能です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//インライン定義 (function参照) +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +//1行で関数定義 +function y=sq(x),y=x^2,endfunction + +sq(3) + +//関数定義のネスト +function y=foo(x) +a=sin(x) +function y=sq(x), y=x^2,endfunction +y=sq(a)+1 +endfunction + +foo(%pi/3) + +// スクリプトファイル内での定義 (exec参照) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="functions">functions</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="names">names</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/functions.xml b/modules/functions/help/ja_JP/functions.xml new file mode 100755 index 000000000..eb8286238 --- /dev/null +++ b/modules/functions/help/ja_JP/functions.xml @@ -0,0 +1,369 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="functions"> + + <refnamediv> + + <refname>functions</refname> + + <refpurpose>Scilab プロシージャおよび Scilab オブジェクト</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <para>functions は Scilab プロシージャです + + "macro", "function" および + + "procedure"は同じ意味を有します). + + </para> + + </refsection> + + <refsection> + + <title>関数定義</title> + + <para> + + 通常,これらはエディタによりファイルで定義され, + + <link linkend="exec">exec</link>関数またはライブラリ + + (<link linkend="lib">lib</link> または + + <link linkend="genlib">genlib</link>参照) + + によりScilabにロードされます. + + しかし,オンライン定義 + + (<link linkend="deff">deff</link> または + + <link linkend="function">function</link>参照) + + することも可能です. + + 関数は以下の2つの要素により定義されます:: + + </para> + + <itemizedlist> + + <listitem> + + <para>以下のような "構文定義" 部:</para> + + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) +function [y1,...,yn,varargout]=foo(x1,...,xm,varargin) + ]]></programlisting> + + </listitem> + + <listitem> + + <para>一連のScilab命令.</para> + + </listitem> + + </itemizedlist> + + <para>"構文定義" 行はこの関数の"完全な"呼び出し手順を指定します. + + <literal>yi</literal> は,入力変数<literal>xi</literal>と + + その関数が実行された際にScilabに存在する変数の関数として + + 計算される出力変数です. + + </para> + + </refsection> + + <refsection> + + <title>呼び出し手順</title> + + <itemizedlist> + + <listitem> + + <para> + + 通常,関数の呼び出し手順は + + <literal>[y1,...,yn]=foo(x1,...,xm)</literal>となります. + + 入力または出力引数の一覧を定義より短くすることができます. + + このような場合, + + 左辺の先頭のいくつかの変数のみが使用され設定されます. + + </para> + + <para> + + 呼び出し時の引数の実際の数は, + + <link linkend="argn">argn</link> により取得することができます. + + </para> + + </listitem> + + <listitem> + + <para> + + 入力または出力最大引数の数が不定の + + 関数を定義することができます. + + これは, <link linkend="varargin">varargin</link>および + + <link linkend="varargout">varargout</link>キーワードを + + 使用して行います. + + 詳細は指定したリンクを参照ください. + + </para> + + </listitem> + + <listitem> + + <para> + + 入力引数を指定する際に"名前付きの引数"を使用することも + + 可能です: + + 関数<function>fun1</function>が + + <code>function y1 = fun1(x1, x2, x3)</code>と + + 定義されていると仮定すると,<function>fun1</function>を + + <code>y = fun1(x1=33, x3=[1 2 3])</code>のような + + 構文でコールすることもできます. + + x2 は未定義となります. + + </para> + + <para> + + <code>y = fun1(x1=33, y='foo')</code>のような構文で + + コールすることも可能です. + + このような場合,<varname>y</varname> 変数を + + 関数<function>fun1</function>のコンテキストで + + 利用可能となります. + + <note> + + 引数の最大数は関数構文部で使用される + + 形式的な入力引数の数以下とする必要があることに注意してください. + + </note> + + </para> + + <para> + + 定義された変数を + + <link linkend="exists">exists</link> 関数で + + 確認することができます. + + </para> + + </listitem> + + <listitem> + + <para> + + 関数が左辺の引数を有さず, + + 文字列引数でのみコールされた場合, + + 呼び出し手順を以下のように簡単化できます: + + </para> + + <programlisting role='no-scilab-exec'><![CDATA[ +fun('a','toto','a string') + ]]></programlisting> + + <para>は以下と等価です: </para> + + <programlisting role='no-scilab-exec'><![CDATA[ +fun a toto 'a string' + ]]></programlisting> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection> + + <title>その他</title> + + <para> + + 関数はScilabオブジェクト(型番号は13または11)です. + + 関数は他の変数型と同様に操作 + + (構築, 保存, 読込み, 引数として指定)できます. + + </para> + + <para> + + 関数の集合は,ライブラリに集約できます. + + <literal>%</literal> 記号で始まる関数 + + (例: <literal>%foo</literal>) + + は,しばしば新しいデータ型について演算子や関数をオーバーロード + + (<link linkend="overloading">オーバーローディング</link>参照) + + する際に使用されます. + + </para> + + <para> + + 関数名はいくつかの構文規約 + + (<link linkend="names">names</link>参照)に従う必要があることに + + 注意してください. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//インライン定義 (function参照) +function [x,y]=myfct(a,b) + x=a+b + y=a-b +endfunction +[x,y]=myfct(3,2) +//インライン定義 (deff参照) +deff('[x,y]=myfct(a,b)',['x=a+b'; + 'y=a-b']) +// アスキーファイルで定義 (exec参照) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="lib">lib</link> + + </member> + + <member> + + <link linkend="getd">getd</link> + + </member> + + <member> + + <link linkend="genlib">genlib</link> + + </member> + + <member> + + <link linkend="exists">exists</link> + + </member> + + <member> + + <link linkend="varargin">varargin</link> + + </member> + + <member> + + <link linkend="varargout">varargout</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/getd.xml b/modules/functions/help/ja_JP/getd.xml new file mode 100755 index 000000000..cde9223df --- /dev/null +++ b/modules/functions/help/ja_JP/getd.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="getd"> + + <refnamediv> + + <refname>getd</refname> + + <refpurpose>ディレクトリで定義された全ての関数を取得する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>getd(path)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>path</term> + + <listitem> + + <para>文字列. ディレクトリのパス名</para> + + <para> + + 入力引数を指定さずに<function>getd</function>が + + コールされた場合, または <varname>path</varname>が空文字列の + + 場合, "." + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <varname>path</varname>ディレクトリで定義された + + (Scilab関数を含む) + + 全ての <literal>.sci</literal>ファイルをロードします. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +getd('SCI/modules/cacsd/macros') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="lib">lib</link> + + </member> + + <member> + + <link linkend="pwd">pwd</link> + + </member> + + <member> + + <link linkend="chdir">chdir</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/head_comments.xml b/modules/functions/help/ja_JP/head_comments.xml new file mode 100755 index 000000000..ebb812bab --- /dev/null +++ b/modules/functions/help/ja_JP/head_comments.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="head_comments"> + + <refnamediv> + + <refname>head_comments</refname> + + <refpurpose>Scilab関数のヘッダのコメントを表示</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + head_comments(name) + + head_comments(name,%paths) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>name</term> + + <listitem> + + <para>文字列, 関数名</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>%paths</term> + + <listitem> + + <para>文字列ベクトル, sci-ファイルを探す場所のパス + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>head_comments(name)</code> は, + + (Matlabヘルプのように) + + 関数ヘッダのコメントを表示します. + + コメントは関連する sci-ファイルから読み込まれます. + + <varname>name</varname>がライブラリ中の関数の場合, + + sci-ファイルはライブラリパスで指定したパスとなります + + (<link linkend="lib">lib</link>参照). + + <varname>name</varname>がライブラリ中ではない関数の場合, + + 変数<varname>%paths</varname>で指定したディレクトリの中で + + <varname>name</varname><literal>.sci</literal>という名前のファイルが + + 探されます. + + </para> + + <warning> + + 警告: Scilabのほとんどの定義済みの関数はもはやヘッダコメントを + + 有していません. + + </warning> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +head_comments sinc + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="help">help</link> + + </member> + + <member> + + <link linkend="lib">lib</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/CHAPTER b/modules/functions/help/ja_JP/libraries/CHAPTER new file mode 100755 index 000000000..4cd7693b5 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/CHAPTER @@ -0,0 +1,2 @@ +title = Libraries + diff --git a/modules/functions/help/ja_JP/libraries/genlib.xml b/modules/functions/help/ja_JP/libraries/genlib.xml new file mode 100755 index 000000000..2b6aa5972 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/genlib.xml @@ -0,0 +1,272 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="genlib"> + + <refnamediv> + + <refname>genlib</refname> + + <refpurpose>指定したディレクトリの関数からライブラリを構築する </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>genlib(lib_name [[,dir_name, [ Force [,verb [,Names]]]]) + + genlib(lib_name [,path=dir_name] [,verbose=verb] [,force=Force] [,names=Names]) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>lib_name: </term> + + <listitem> + + <para>Scilab文字列. (再)作成するライブラリの変数名.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>dir_name: </term> + + <listitem> + + <para>Scilab文字列. + + <literal>.sci</literal>-ファイルを探すディレクトリの名前. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>Force</term> + + <listitem> + + <para> + + 論理値 (デフォルト値は <literal>%f</literal>). + + sci-ファイルの再コンパイルを強制的に行う場合, + + <literal>%t</literal>に設定してください. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>verb</term> + + <listitem> + + <para> + + 論理値 (デフォルト値は <literal>%f</literal>). + + 情報を取得するには <literal>%t</literal> に設定してください. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>Names</term> + + <listitem> + + <para>文字列のベクトルで, ライブラリに含まれる + + 関数の名前です. + + デフォルトで全ての sci-ファイルが取得されます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>dir_name</literal>にある各<literal>.sci</literal>ファイル + + (または<literal>Names</literal>引数で指定されたファイルのみ)について, + + <literal>genlib</literal>は<literal>exec</literal>を + + 実行し,対応する<literal>.bin</literal>ファイルに関数を保存します. + + <literal>.sci</literal>ファイルにはScilab関数以外のものを含んでは + + いけません. + + ある<literal>.bin</literal>ファイルが対応する<literal>.sci</literal>ファイルよりも + + 新しい場合, <literal>genlib</literal>はこのファイルを変換/保存しません. + + </para> + + <para> + + このデフォルトの動作は<literal>force</literal>が指定され, + + <literal>%t</literal> に設定された場合に変更できます. + + この場合, 各<literal>.sci</literal>ファイル毎に常に再コンパイルが + + 行われます. + + </para> + + <para> + + 全ての<literal>.sci</literal> ファイルが処理された場合, + + <literal>genlib</literal>は<literal>lib_name</literal>という + + 名前のライブラリ変数を作成し, + + <literal>dir_name</literal>の中のファイル<literal>lib</literal>に + + この変数を保存します. + + Scilab変数 + + <literal>lib_name</literal>が保護されていない場合 + + (<link linkend="predef">predef</link>参照), + + この変数は更新されます. + + </para> + + <para> + + <literal>verbose</literal> に <literal>%t</literal>が + + 指定された場合, 構築処理中に情報が表示されます. + + </para> + + <para> + + <literal>dir_name</literal> 引数が指定されない場合に, + + Scilab変数<literal>lib_name</literal>が存在し, + + それがライブラリの場合, + + dir_name は, + + <literal>lib_name</literal>ライブラリパスに等しく + + 設定されます (更新モード). + + </para> + + </refsection> + + <refsection> + + <title>制約</title> + + <para> + + Scilab は, ファイル<literal>foo.sci</literal>が, + + 少なくとも<literal>foo</literal>という名前の関数を + + 定義すると仮定します. + + 補助関数が含まれる場合,これらは + + 関数<literal>foo</literal>が参照された後でのみ + + Scilabから既知となります. + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="getd">getd</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="save">save</link> + + </member> + + <member> + + <link linkend="lib">lib</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/get_function_path.xml b/modules/functions/help/ja_JP/libraries/get_function_path.xml new file mode 100755 index 000000000..0e05b18df --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/get_function_path.xml @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="get_function_path"> + + <refnamediv> + + <refname>get_function_path</refname> + + <refpurpose>ライブラリ関数のソースファイルのパスを取得</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>path=get_function_path(fun_name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun_name</term> + + <listitem> + + <para>文字列, 関数名</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>path</term> + + <listitem> + + <para>文字列, 関数ソースファイル(.sci)の絶対パス名または [].</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数名を指定すると, + + その関数が Scilab ライブラリ(lib参照)で定義されている場合, + + get_function_path は関数ソースファイルの + + 絶対パス名を返します. + + 名前がライブラリ関数に一致しない場合 [] が返されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +get_function_path('median') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="lib">lib</link> + + </member> + + <member> + + <link linkend="string">string</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/lib.xml b/modules/functions/help/ja_JP/libraries/lib.xml new file mode 100755 index 000000000..363fa0280 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/lib.xml @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="lib"> + + <refnamediv> + + <refname>lib</refname> + + <refpurpose>ライブラリ定義</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>namelib = lib('lib-dir')</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>lib-dir</term> + + <listitem> + + <para>文字列</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>namelib</term> + + <listitem> + + <para>'lib'により返されるライブラリ変数.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>lib-dir</literal>は, + + コンパイル済みのScilab関数(<literal>.bin</literal>)ファイルを + + 含むディレクトリを定義する文字列です. + + </para> + + <para> + + これらのファイルに加えて,<literal>lib-dir</literal> には, + + <literal>lib-dir</literal>で定義された関数の名前を保持する + + <literal>names</literal>という名前のファイルがある必要があります. + + 処理が成功すると, <literal>lib-dir</literal> の中の全ての関数が + + Scilabから利用可能になります. + + これらの関数は最初にコールされた時にオンデマンドでロードされます. + + </para> + + <para> + + バイナリファイルは Scilab上でコマンド<literal>save</literal> + + により作成できます. + + ライブラリ変数は,通常, + + オンラインまたはユーザ指定のスタートアップファイル(startup参照) + + のどちらかにより,後でロードするために保存されます. + + </para> + + <para> + + このライブラリのマクロ関数にアクセスするには, + + 'lib'により返された値を変数'namelib'に挿入する必要があります. + + </para> + + </refsection> + + <refsection> + + <title>制限</title> + + <para> + + Scilab は, 各ファイル xxxx.bin が<literal>xxxx</literal>という名前の + + 変数を定義するものと暗黙の内にに仮定します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//いくつかの関数を定義 +function z = myplus(x, y) + z = x + y +endfunction + +function z = yourplus(x, y) + x = x - y +endfunction + +//*.bin ファイルを libdirに作成 +libdir = TMPDIR; +save(libdir + '/myplus.bin', myplus); +save(libdir + '/yourplus.bin', yourplus); + +//nameファイルを作成 +mputl(['myplus';'yourplus'],TMPDIR+'/names'); + +//myplus およびyourplusを含むライブラリを構築 +mylibfoo = lib(libdir+'/'); + +//変数を消去 +clear myplus yourplus + +//自動的にロードし,実行 +myplus(1,2) + +//変数を消去 +clear myplus yourplus + +mylibfoo +[n,p] = libraryinfo('mylibfoo') + +isdef('myplus') +clear mylibfoo +isdef('myplus') + + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="library">library</link> + + </member> + + <member> + + <link linkend="genlib">genlib</link> + + </member> + + <member> + + <link linkend="save">save</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="whereis">whereis</link> + + </member> + + <member> + + <link linkend="libraryinfo">libraryinfo</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/librarieslist.xml b/modules/functions/help/ja_JP/libraries/librarieslist.xml new file mode 100755 index 000000000..168277892 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/librarieslist.xml @@ -0,0 +1,102 @@ +<?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="librarieslist"> + + <refnamediv> + + <refname>librarieslist</refname> + + <refpurpose>scilabライブラリを取得</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>s=librarieslist()</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>s</term> + + <listitem> + + <para>文字列行列</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>s</literal>にある + + Scilabスタックの全てのライブラリを返します. + + return in <literal>s</literal> all libraries on scilab stack. + + </para> + + <para> + + ライブラリは最後にロードされたものから最初にロードされたものに + + 向かってスキャンされます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +librarieslist() +// リストをソート +l = gsort(librarieslist(),'r','i') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="libraryinfo">libraryinfo</link> + + </member> + + <member> + + <link linkend="gsort">gsort</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/library.xml b/modules/functions/help/ja_JP/libraries/library.xml new file mode 100755 index 000000000..9606acbb1 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/library.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="library"> + <refnamediv> + <refname>library</refname> + <refpurpose>ライブラリのデータ型の説明 + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para> + ライブラリは型番号14のデータ型です. + これには,パス名と名前の集合が含まれます. + これにより,以下のアルゴリズムにより変数を自動的に + ロードすることが可能になります: + </para> + <para> + Scilabユーザが<literal>foo</literal>という名前の変数を参照すると + 仮定します. + Scilabはまず<literal>foo</literal>がプリミティブの名前または + すでに定義ずみであるかどうかを調べます. + そうでない場合,<literal>foo</literal>を(新しいものから順に) + 順番に全ての定義済みのライブラリの中で探します. + </para> + <para> + <literal>foo</literal> がライブラリ<literal>xlib</literal>の + 名前の集合に属すると仮定すると, + Scilabはファイル <xlib-path-name>/foo.bin をロード + します. + <xlib-path-name>/foo.bin は + <literal>save</literal> 関数により作成されている必要があります. + </para> + <para> + ライブラリはしばしば関数の集約に使用されますが, + Scilab変数の集約にも使用することができます. + </para> + <para> + ある関数が1つ以上のライブラリで定義されている場合, + デフォルトの探索アルゴリズムは最新のライブラリに + 含まれる関数をロードします. + ドット表記により + 特定のライブラリの関数を強制的に使用することも可能です: + </para> + <para> + <literal>xlib.foo</literal> は + <literal>xlib</literal>に含まれる変数<literal>foo</literal> + をロードします. + <literal>foo</literal>が関数の場合, + <literal>xlib.foo(args)</literal>はこの関数を実行します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// elemlib は定義済みのライブラリです +elementary_functionlib //ライブラリの中身を表示 +A=rand(3,3); +cosm(A) //cosmをロードし実行 +whos -name cosm // ここでcosmは変数です +elementary_functionlib.sinm //sinmをライブラリからロード +elementary_functionlib.cosm(A) //cosmを再ロードし,実行 + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="save">save</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ja_JP/libraries/libraryinfo.xml b/modules/functions/help/ja_JP/libraries/libraryinfo.xml new file mode 100755 index 000000000..672468281 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/libraryinfo.xml @@ -0,0 +1,124 @@ +<?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="libraryinfo"> + + <refnamediv> + + <refname>libraryinfo</refname> + + <refpurpose>マクロとscilabライブラリのパスを取得</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>macros = libraryinfo(libraryname) + + [macros,path] = libraryinfo(libraryname) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>macros</term> + + <listitem> + + <para>文字列行列 (ライブラリの全ての主関数)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + <variablelist> + + <varlistentry> + + <term>path</term> + + <listitem> + + <para>文字列 (ライブラリのパス)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + <variablelist> + + <varlistentry> + + <term>libraryname</term> + + <listitem> + + <para>文字列 (ライブラリ名)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 指定したScilabライブラリの関数名とパスを取得します. + + 返される関数名は対応する .sci または .bin のファイルの名前 + + に一致します. + + その他の名前は補助関数です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +[m,p]=libraryinfo('corelib') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="librarieslist">librarieslist</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/libraries/whereis.xml b/modules/functions/help/ja_JP/libraries/whereis.xml new file mode 100755 index 000000000..2c9ffc537 --- /dev/null +++ b/modules/functions/help/ja_JP/libraries/whereis.xml @@ -0,0 +1,67 @@ +<?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="whereis"> + + <refnamediv> + + <refname>whereis</refname> + + <refpurpose>関数が属するライブラリの名前</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>[librname]=whereis(function-name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para> + + 関数<literal>function-name</literal>が属するライブラリの名前を + + 文字列として返します. + + ライブラリのパス名は<literal>"librname"</literal>と入力することにより + + 返されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +whereis("ls") // fileiolibを返します +whereis("plot") // graphicslibを返します + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="lib">lib</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/listfunctions.xml b/modules/functions/help/ja_JP/listfunctions.xml new file mode 100755 index 000000000..191326810 --- /dev/null +++ b/modules/functions/help/ja_JP/listfunctions.xml @@ -0,0 +1,242 @@ +<?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="listfunctions"> + + <refnamediv> + + <refname>listfunctions</refname> + + <refpurpose> + + ワークスペースの全ての関数のプロパティ + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>[flist,compiled,profilable,called] = listfunctions([scope])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>パス名</title> + + <variablelist> + + <varlistentry> + + <term>scope</term> + + <listitem> + + <para> + + 文字列, <literal>"local"</literal> (デフォルト) または <literal>"global"</literal> + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>flist</term> + + <listitem> + + <para>文字列の配列, + + 指定した名前空間にある全関数変数の名前 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>compiled</term> + + <listitem> + + <para>論理値配列, + + 対応する<varname>flist</varname>の要素が型=13の場合に真 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>profilable</term> + + <listitem> + + <para>論理値配列, + + 対応する<varname>flist</varname>の要素が型=13の場合に真となり, + + プロファイル情報が関数の擬似コードの中に追加されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>called</term> + + <listitem> + + <para>uint32 配列, + + <varname>flist</varname> の対応する要素がコールされた回数 + + (プロファイル可能な関数の場合のみ非ゼロ) + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <itemizedlist> + + <listitem> + + <para> + + この関数は,(<link linkend="who">who</link>で指定した) + + ワークスペースの全ての変数を確認し, + + 11型または13型の変数を収集します; + + 後者の場合, + + 最初のコード行の末尾の特殊なプロファイル用エントリ, + + すなわち, + + <code>lst(5)(1)=="25"</code> をチェックするために, + + <code>lst = macr2lst(fun)</code> がコールされます. + + </para> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +[flist,compiled,profilable,called] = listfunctions(); +flist(profilable) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="fun2string">fun2string</link> + + </member> + + <member> + + <link linkend="macr2lst">macr2lst</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="recompilefunction">recompilefunction</link> + + </member> + + <member> + + <link linkend="who">who</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>参考文献</title> + + <para> + + http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation + + </para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/macr2lst.xml b/modules/functions/help/ja_JP/macr2lst.xml new file mode 100755 index 000000000..c08b83ae6 --- /dev/null +++ b/modules/functions/help/ja_JP/macr2lst.xml @@ -0,0 +1,425 @@ +<?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="macr2lst"> + + <refnamediv> + + <refname>macr2lst</refname> + + <refpurpose>リスト変換用の関数</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>lst = macr2lst(function_name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>function_name</term> + + <listitem> + + <para>変換する関数.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>lst</term> + + <listitem> + + <para>リスト.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + このプリミティブは,コンパイル済みのScilab関数 <varname>function_name</varname> + + を,関数の内部表現をコード化(逆ポーランド表記)したリストに変換します. + + </para> + + <para> + + リストの最初のエントリは関数名,2番目および3番目のエントリは + + それぞれ左辺引数および右辺引数の変数名となります. + + それ以降のエントリは,基本的な演算子レコードもしくは + + <literal>if</literal>, <literal>for</literal>, ... のような制御構造の階層を含むリストのどちらかです. + + </para> + + <para> + + 基本的な演算子レコードは, 文字列ベクトルにより記述されます. + + その最初の要素はオペコードを表します. + + </para> + + <informaltable border="1"> + + <tr> + + <td>オペコード</td> + + <td>意味</td> + + <td>パラメータ</td> + + </tr> + + <tr> + + <td>"0"</td> + + <td>無視されるオペコード</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"1"</td> + + <td>使用停止</td> + + <td/> + + </tr> + + <tr> + + <td>"2"</td> + + <td>変数または関数リファレンス</td> + + <td>変数名, #rhs, #lhs</td> + + </tr> + + <tr> + + <td>"3"</td> + + <td>スタック内に文字列を配置</td> + + <td>文字列</td> + + </tr> + + <tr> + + <td>"4"</td> + + <td>スタック内に空の行列を配置</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"5"</td> + + <td>処理を適用</td> + + <td>処理コード, #rhs,#lhs</td> + + </tr> + + <tr> + + <td>"6"</td> + + <td>数値をスタックに配置</td> + + <td>数値</td> + + </tr> + + <tr> + + <td>"12"</td> + + <td>停止コマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"13"</td> + + <td>ブレークコマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"14"</td> + + <td>中断コマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"15"</td> + + <td>行終端記号</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"17"</td> + + <td>quit コマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"18"</td> + + <td>名前のある変数</td> + + <td>変数名</td> + + </tr> + + <tr> + + <td>"19"</td> + + <td>再帰的な添え字構造を作成</td> + + <td>パスの長さ, 最終添え字の番号</td> + + </tr> + + <tr> + + <td>"20"</td> + + <td>関数コール</td> + + <td>関数名, #rhs, #lhs </td> + + </tr> + + <tr> + + <td>"23"</td> + + <td>名前を指定して変数を作成</td> + + <td>変数名</td> + + </tr> + + <tr> + + <td>"24"</td> + + <td>0型の変数をスタックに代入</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"25"</td> + + <td>プロファイル用レコード</td> + + <td>コール数, 消費時間 </td> + + </tr> + + <tr> + + <td>"26"</td> + + <td>文字列ベクトルをスタック内に配置</td> + + <td>#rows, #columns, 要素のシーケンス</td> + + </tr> + + <tr> + + <td>"27"</td> + + <td>組み込みリファレンスをスタックに配置</td> + + <td>インターフェイス番号, インターフェイス内の位置, 関数名</td> + + </tr> + + <tr> + + <td>"28"</td> + + <td>continue コマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td>"29"</td> + + <td>代入</td> + + <td>#lhs, 表示モード, (変数名, #rhs)*</td> + + </tr> + + <tr> + + <td>"30"</td> + + <td>論理値式 省略形</td> + + <td>型, ジャンプの長さ</td> + + </tr> + + <tr> + + <td>"31"</td> + + <td>コメント</td> + + <td>コメント</td> + + </tr> + + <tr> + + <td>"99"</td> + + <td>return コマンド</td> + + <td>なし</td> + + </tr> + + <tr> + + <td> > "100"</td> + + <td>組み込みコール (古い)</td> + + <td>100*fun, #rhs, #lhs, fin</td> + + </tr> + + </informaltable> + + <para> + + <link linkend="fun2string">fun2string</link> 関数は, + + 初期コードを生成する際に使用できます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//DISPLAY +function y=foo(x,flag) + if flag then + y=sin(x) + else + y=cos(x) + end +endfunction +L=macr2lst(foo) +fun2string(L) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="macrovar">macrovar</link> + + </member> + + <member> + + <link linkend="fun2string">fun2string</link> + + </member> + + <member> + + <link linkend="macr2tree">macr2tree</link> + + </member> + + <member> + + <link linkend="tree2code">tree2code</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/macr2tree.xml b/modules/functions/help/ja_JP/macr2tree.xml new file mode 100755 index 000000000..af06b65a2 --- /dev/null +++ b/modules/functions/help/ja_JP/macr2tree.xml @@ -0,0 +1,100 @@ +<?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="macr2tree"> + + <refnamediv> + + <refname>macr2tree</refname> + + <refpurpose>ツリー変換用の関数</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>t=macr2tree(function-name)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>function-name</term> + + <listitem> + + <para>cilabマクロ</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>t</term> + + <listitem> + + <para>Scilab "ツリー"</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + このプリミティブは, コンパイル済みの Scilab 関数<literal>function-name</literal> + + を関数を内部表現にコード化したツリー (鱗状のtlists)に変換します. + + <literal>tree2code</literal>と共に使用します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="tree2code">tree2code</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/macro.xml b/modules/functions/help/ja_JP/macro.xml new file mode 100755 index 000000000..3a940942f --- /dev/null +++ b/modules/functions/help/ja_JP/macro.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="macro"> + + <refnamediv> + + <refname>macro</refname> + + <refpurpose>Scilabプロシージャおよび Scilabオブジェクト</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <para> + + マクロはScilabプロシージャ("macro", "function" および "procedure" + + は同じ意味です)です. + + 通常,これらはエディタによりファイルの中で定義され, + + <function>exec</function>または + + ライブラリによりScilabにロードされます. + + </para> + + <para> + + マクロをオンラインで定義することも可能です(<link linkend="deff">deff</link>参照). + + マクロを含むファイルは以下のように開始する必要があります: + + </para> + + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) + ]]></programlisting> + + <para> + + <literal>yi</literal> は, + + 入力変数およびマクロが実行される時点でScilabの中に存在する + + 変数の関数として計算される出力変数です. + + マクロはより高速に実行するためにコンパイルすることが可能です. + + 複数のマクロをライブラリに集約することができます. + + <literal>%</literal>記号で始まり(例: <literal>%foo</literal>), + + その引数がリストであるマクロは, + + 特定の処理を実行する際に使用されます: + + 例えば, <code>z=%rmr(x,y)</code> は + + <varname>x</varname> および <varname>z</varname>が + + 有理数の場合に<code>z=x*y</code>と等価です. + + (すなわち, 多項式<varname>n</varname> および + + <varname>d</varname> を指定した <code>x=list('r',n,d,[])</code>) + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="lib">lib</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/macrovar.xml b/modules/functions/help/ja_JP/macrovar.xml new file mode 100755 index 000000000..51c1e8bd8 --- /dev/null +++ b/modules/functions/help/ja_JP/macrovar.xml @@ -0,0 +1,161 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="macrovar"> + + <refnamediv> + + <refname>macrovar</refname> + + <refpurpose>関数の変数</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>vars = macrovar(function)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>vars</term> + + <listitem> + + <para> + + リスト, + + <literal>list(in, out, nolocal, called, locals)</literal>. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>function</term> + + <listitem> + + <para>関数名.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数で使用される変数の集合のリストを返します. + + <varname>vars</varname> は以下の5つの文字列の列ベクトルからなる + + リストです: + + </para> + + <simplelist type="inline"> + + <member> + + <varname>in</varname> 入力変数 (<code>vars(1)</code>); + + </member> + + <member> + + <varname>out</varname>: 出力変数 (<code>vars(2)</code>); + + </member> + + <member> + + <varname>nolocal</varname>: + + 関数内で定義されていない関数でない変数を参照 + + (<code>vars(3)</code>); + + </member> + + <member> + + <varname>called</varname>: コールされた関数の名前 (<code>vars(4)</code>); + + </member> + + <member> + + <varname>locals</varname>: ローカル変数 (<code>vars(5)</code>). + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc'); +vars = macrovar(f) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="string">string</link> + + </member> + + <member> + + <link linkend="macr2lst">macr2lst</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/mode.xml b/modules/functions/help/ja_JP/mode.xml new file mode 100755 index 000000000..3099ad19d --- /dev/null +++ b/modules/functions/help/ja_JP/mode.xml @@ -0,0 +1,255 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mode" xml:lang="ja"> + + <refnamediv> + + <refname>mode</refname> + + <refpurpose>ファイル実行のモードを選択</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mode(k) + + k = mode() + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para> + + ファイル実行またはScilab関数の中で<emphasis role="bold">排他的に</emphasis>に + + 使用され,<literal>mode(k)</literal>は<literal>k</literal>の値に応じて + + 次のように実行時に表示される情報を変更することができます: + + </para> + + <variablelist> + + <varlistentry> + + <term>k = 0</term> + + <listitem> + + <para> + + 新しい変数の値が必要に応じて表示されます + + (<link linkend="semicolon">セミコロン</link> + + または + + <link linkend="comma">カンマ</link>のヘルプを参照). + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>k = -1</term> + + <listitem> + + <para> + + ファイル実行またはScilab関数の実行時の + + 表示を行いません. + + (これはScilab関数に関するデフォルト値です) + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>k = 2</term> + + <listitem> + + <para>Scilabプロンプトのデフォルト値.</para> + + <para> + + <literal>mode(2)</literal>はプロンプトでは使用されず, + + ファイル実行またはScilab関数でのみ使用されることに + + 注意してください. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>k = 1 または k = 3</term> + + <listitem> + + <para> + + 命令の各行はプロンプトの前に表示されます. + + 新しい変数の値は必要に応じて表示されます. + + これはファイル実行時のデフォルトです. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>k = 4 または k = 7</term> + + <listitem> + + <para> + + 新しい変数の値は必要に応じて表示され, + + 各行の命令は表示され, + + プロンプト (>>) がキャレッジリターンを待つ各行の + + 後に出力されます. + + </para> + + <para>キャレッジリターンの後に "p" が続く場合, + + 実行は中断されています(<link linkend="pause">pause</link>参照). + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>k > 7</term> + + <listitem> + + <para>ユーザモード. ユーザが独自のモードを定義した場合, + + 100 より大きい値を使用することが推奨されます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para> + + コンパイル済みのScilab関数(<link linkend="comp">comp</link>参照) + + の場合,行の表示は無効化されます. + + デフォルトでScilab関数はサイレントモード("-1")で実行されます. + + </para> + + <para>関数ライブラリ内の関数は, "-1" モードで実行されます.</para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// scilab内にコピー/ペーストしてください +function example_mode( level_mode ) + mode(level_mode) + a = 3 + disp(mode()); +endfunction +mode(2) +example_mode(0) +example_mode(-1) +example_mode(2) +example_mode(1) +example_mode(3) +example_mode(7) +mode(2) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="exec">exec</link> + + </member> + + <member> + + <link linkend="execstr">execstr</link> + + </member> + + <member> + + <link linkend="semicolon">semicolon</link> + + </member> + + <member> + + <link linkend="comma">comma</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/overloading.xml b/modules/functions/help/ja_JP/overloading.xml new file mode 100755 index 000000000..17481d9cd --- /dev/null +++ b/modules/functions/help/ja_JP/overloading.xml @@ -0,0 +1,1208 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="overloading" xml:lang="ja"> + + <refnamediv> + + <refname>overloading</refname> + + <refpurpose>表示,関数および演算子オーバーロード機能</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <para> + + Scilabにおいては, 変数表示, 関数および演算子は + + 関数(Scilabコードまたはプリミティブ)により新規オブジェクト用に + + 定義することができます. + + </para> + + <variablelist> + + <varlistentry> + + <term>表示</term> + + <listitem> + + <para> + + <literal>tlist</literal>により定義される 新規オブジェクトの表示は, + + オーバーロードすることができます + + (デフォルトの表示は<literal>list</literal>の出力に似ています). + + オーバーロード関数は入力引数を1つとし,出力引数を持たない必要があります. + + その関数の名前は,<literal>%<tlist_type>_p</literal>のように 作成します. + + ただし, + + <literal>%<tlist_type></literal> は, + + <literal>tlist</literal>型の要素の最初のエントリを + + 最初の9文字に丸めたものを意味します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>演算子</term> + + <listitem> + + <para> + + 指定したオペランド型について定義されていない各演算子を定義することができます. + + オーバーロード関数は入力引数を1つ,オペランドの数に基づき 1個または + + 2個の入力を有する必要があります. + + 関数名は以下のように作成されます: + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para>2項演算子の場合: + + <literal>%<first_operand_type>_<op_code>_<second_operand_type></literal> + + </para> + + <para>単項演算子の場合: + + <literal>%<operand_type>_<op_code></literal> + + </para> + + <para>n項演算子の展開および挿入は以下のように記述されます.</para> + + <warning> + + <function>typename</function>関数に登録された型のみが + + オーバーロードマクロの中で使用できることに注意してください. + + </warning> + + <para> + + <literal><operand_type></literal>, + + <literal><first_operand_type></literal>, + + <literal><second_operand_type></literal> は, + + 以下のテーブルに記述された各データ型に関連する文字シーケンスです: + + </para> + + <informaltable border="1"> + + <tr> + + <td>データ型</td> + + <td>文字コード</td> + + <td>typeof</td> + + <td>コメント</td> + + </tr> + + <tr> + + <td>double行列</td> + + <td> + + <literal>s</literal> + + </td> + + <td> + + <literal>定数</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>多項式行列</td> + + <td> + + <literal>p</literal> + + </td> + + <td> + + <literal>多項式</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>論理値行列</td> + + <td> + + <literal>b</literal> + + </td> + + <td> + + <literal>論理値</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>疎行列</td> + + <td> + + <literal>sp</literal> + + </td> + + <td> + + <literal>疎行列</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>論理値疎行列</td> + + <td> + + <literal>spb</literal> + + </td> + + <td> + + <literal>論理値疎行列</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>Matlab 疎行列</td> + + <td> + + <literal>msp</literal> + + </td> + + <td> + + <literal>Matlab疎行列</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>整数行列</td> + + <td> + + <literal>i</literal> + + </td> + + <td> + + <literal>int8, int16, int32, uint8, uint16, uint32</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>文字列行列</td> + + <td> + + <literal>c</literal> + + </td> + + <td> + + <literal>文字列</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>ハンドル</td> + + <td> + + <literal>h</literal> + + </td> + + <td> + + <literal>ハンドル</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>コンパイルされた関数</td> + + <td> + + <literal>fptr</literal> + + </td> + + <td> + + <literal>fptr</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>スクリプト関数</td> + + <td> + + <literal>mc</literal> + + </td> + + <td> + + <literal>関数</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>ライブラリ</td> + + <td> + + <literal>l</literal> + + </td> + + <td> + + <literal>ライブラリ</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>リスト</td> + + <td> + + <literal>l</literal> + + </td> + + <td> + + <literal>リスト</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>tlist</td> + + <td> + + <literal>tlist型</literal> + + </td> + + <td> + + <literal>tlist型</literal> + + </td> + + <td>最初のtlistエントリの最初の文字列</td> + + </tr> + + <tr> + + <td>mlist</td> + + <td> + + <literal>mlist型</literal> + + </td> + + <td> + + <literal>mlist型</literal> + + </td> + + <td>最初のmlistエントリの最初の文字列</td> + + </tr> + + <tr> + + <td>ハイパー行列</td> + + <td> + + <literal>hm</literal> + + </td> + + <td> + + <literal>hypermat</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>ポインタ</td> + + <td> + + <literal>ptr</literal> + + </td> + + <td> + + <literal>ポインタ</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>セル</td> + + <td> + + <literal>ce</literal> + + </td> + + <td> + + <literal>ce</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>structure</td> + + <td> + + <literal>st</literal> + + </td> + + <td> + + <literal>st</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>有理数</td> + + <td> + + <literal>r</literal> + + </td> + + <td> + + <literal>有理数</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>線形状態空間</td> + + <td> + + <literal>lss</literal> + + </td> + + <td> + + <literal>状態空間</literal> + + </td> + + <td/> + + </tr> + + <tr> + + <td>暗黙の多項式</td> + + <td> + + <literal>ip</literal> + + </td> + + <td> + + <literal>size implicit</literal> + + </td> + + <td>1:1:$</td> + + </tr> + + </informaltable> + + <para> + + <literal><op_code></literal> は, 以下のテーブルに記述された + + 各演算子に関連する文字です: + + </para> + + <informaltable border="1"> + + <tr> + + <td> + + <literal>op</literal> + + </td> + + <td>char code</td> + + </tr> + + <tr> + + <td> + + <literal>'</literal> + + </td> + + <td>t</td> + + </tr> + + <tr> + + <td> + + <literal>+</literal> + + </td> + + <td>a</td> + + </tr> + + <tr> + + <td> + + <literal>-</literal> + + </td> + + <td>s</td> + + </tr> + + <tr> + + <td> + + <literal>*</literal> + + </td> + + <td>m</td> + + </tr> + + <tr> + + <td> + + <literal>/</literal> + + </td> + + <td>r</td> + + </tr> + + <tr> + + <td> + + <literal>\</literal> + + </td> + + <td>l</td> + + </tr> + + <tr> + + <td> + + <literal>^</literal> + + </td> + + <td>p</td> + + </tr> + + <tr> + + <td> + + <literal>.*</literal> + + </td> + + <td>x</td> + + </tr> + + <tr> + + <td> + + <literal>./</literal> + + </td> + + <td>d</td> + + </tr> + + <tr> + + <td> + + <literal>.\</literal> + + </td> + + <td>q</td> + + </tr> + + <tr> + + <td> + + <literal>.*.</literal> + + </td> + + <td>k</td> + + </tr> + + <tr> + + <td> + + <literal>./.</literal> + + </td> + + <td>y</td> + + </tr> + + <tr> + + <td> + + <literal>.\.</literal> + + </td> + + <td>z</td> + + </tr> + + <tr> + + <td> + + <literal>:</literal> + + </td> + + <td>b</td> + + </tr> + + <tr> + + <td> + + <literal>*.</literal> + + </td> + + <td>u</td> + + </tr> + + <tr> + + <td> + + <literal>/.</literal> + + </td> + + <td>v</td> + + </tr> + + <tr> + + <td> + + <literal>\.</literal> + + </td> + + <td>w</td> + + </tr> + + <tr> + + <td> + + <literal>[a,b]</literal> + + </td> + + <td>c</td> + + </tr> + + <tr> + + <td> + + <literal>[a;b]</literal> + + </td> + + <td>f</td> + + </tr> + + <tr> + + <td> + + <literal>() extraction</literal> + + </td> + + <td>e</td> + + </tr> + + <tr> + + <td> + + <literal>() insertion</literal> + + </td> + + <td>i</td> + + </tr> + + <tr> + + <td> + + <literal>==</literal> + + </td> + + <td>o</td> + + </tr> + + <tr> + + <td> + + <literal><></literal> + + </td> + + <td>n</td> + + </tr> + + <tr> + + <td> + + <literal>|</literal> + + </td> + + <td>g</td> + + </tr> + + <tr> + + <td> + + <literal>&</literal> + + </td> + + <td>h</td> + + </tr> + + <tr> + + <td> + + <literal>.^</literal> + + </td> + + <td>j</td> + + </tr> + + <tr> + + <td> + + <literal>.'</literal> + + </td> + + <td>0</td> + + </tr> + + <tr> + + <td> + + <literal><</literal> + + </td> + + <td>1</td> + + </tr> + + <tr> + + <td> + + <literal>></literal> + + </td> + + <td>2</td> + + </tr> + + <tr> + + <td> + + <literal><=</literal> + + </td> + + <td>3</td> + + </tr> + + <tr> + + <td> + + <literal>>=</literal> + + </td> + + <td>4</td> + + </tr> + + <tr> + + <td> + + <literal>~</literal> + + </td> + + <td>5</td> + + </tr> + + <tr> + + <td> + + <literal>iext</literal> + + </td> + + <td>6</td> + + </tr> + + </informaltable> + + <para> + + 展開構文<literal>b=a(i1,...,in)</literal>の オーバーロード関数は, + + 以下のような呼び出し手順となります: + + <literal>b=%<type_of_a>_e_(i1,...,in,a)</literal> + + </para> + + <para> + + そして,構文 <literal>[x1,..,xm]=a(i1,...,in)</literal> は + + 以下のような呼び出し手順となります: + + <literal>[x1,..,xm]=%<type_of_a>_e_(i1,...,in,a)</literal> + + </para> + + <para> + + 挿入構文に関するオーバーロード関数 <literal>a(i1,...,in)=b</literal> + + は以下のような呼び出し手順となります: + + <literal>a=%<type_of_b>_i_<type_of_a>(i1,...,in,b,a)</literal>. + + </para> + + <para> + + 文字コード<literal>6</literal> を + + <code>x.b(2) = 33</code>のような複雑な挿入アルゴリズム で使用することができます. + + ただし,<literal>b</literal>フィールドは構造体<literal>x</literal>で 定義されません. + + 挿入は自動的に<literal>temp=x.b;</literal> <code>temp(2) = 33</code>; + + <code>x.b = temp</code>に分解されます. 文字コード<literal>6</literal> + + がこのアルゴリズムの最初の手順で 使用されます.オーバーロード関数<literal>6</literal> は, + + <literal>e</literal>のものに非常によく似ています. + + </para> + + <variablelist> + + <varlistentry> + + <term>関数 :</term> + + <listitem> + + <para> + + いくつかの基本プリミティブ関数新規データ型に関してオーバーロードができます. + + 特定のデータ型に関してこのような関数が未定義の場合, + + 関数<literal>%<type_of_an_argument>_<function_name></literal> + + がコールされます. ユーザはこのコールされた関数に入力データ型に関する + + 定義を追加することができます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>例</title> + + </refsection> + + <refsection> + + <programlisting role="example">//表示 + + var = tlist('tab', ['a', 'b'], ['x'; 'y'], rand(2, 2)) // varの型は 'tab'です + + + + typeof(var) + + + + function [] = %tab_p(l) + + disp([[' '; l(3)] [l(2); string(l(4))]]) + + endfunction + + + + var // オーバーローディング後 + + </programlisting> + + </refsection> + + <refsection> + + <programlisting role="example">//演算子 + + 's' + 1 // 数値は文字列に加算できません + + + + function x = %c_a_s(a, b) + + x = a + string(b); + + endfunction + + + + 's' + 1 // オーバーローディング後 + + </programlisting> + + </refsection> + + <refsection> + + <programlisting role="example">//関数 + + sin('2 * x') // sin関数は文字列では動作しません + + + + function x = %c_sin(a) + + x = 'sin(' + a + ')' + + endfunction + + + + sin('2 * x') // オーバーローディング後 + + </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="tlist">tlist</link> + + </member> + + <member> + + <link linkend="disp">disp</link> + + </member> + + <member> + + <link linkend="symbols">symbols</link> + + </member> + + <member> + + <link linkend="typeof">typeof</link> + + </member> + + <member> + + <link linkend="type">type</link> + + </member> + + <member> + + <link linkend="typename">typename</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/add_profiling.xml b/modules/functions/help/ja_JP/profiling/add_profiling.xml new file mode 100755 index 000000000..453a8fef0 --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/add_profiling.xml @@ -0,0 +1,152 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="add_profiling" xml:lang="ja"> + + <refnamediv> + + <refname>add_profiling</refname> + + <refpurpose>プロファイル命令を関数に追加.</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>add_profiling(funname)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>funname</term> + + <listitem> + + <para>文字列, プロファイルされる関数の名前</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>add_profiling(funname)</literal> は, + + プロファイル命令を関数<literal>funname</literal>に + + 追加します. + + この関数が実行された時に,コール数と消費時間が + + 各行毎に保存されます. + + これらのデータは + + <link linkend="profile">profile</link>関数により + + 取得できます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction +add_profiling("foo") +foo(0.1,100) //関数を実行 +profile(foo) //プロファイル情報を展開 + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="plotprofile">plotprofile</link> + + </member> + + <member> + + <link linkend="remove_profiling">remove_profiling</link> + + </member> + + <member> + + <link linkend="reset_profiling">reset_profiling</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>使用される関数</title> + + <para> + + この関数は Scilab 関数<literal>bytecode</literal> および + + <literal>walkbytecode</literal> と使用します. + + </para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/plotprofile.xml b/modules/functions/help/ja_JP/profiling/plotprofile.xml new file mode 100755 index 000000000..b8d103ad7 --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/plotprofile.xml @@ -0,0 +1,228 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="plotprofile"> + + <refnamediv> + + <refname>plotprofile</refname> + + <refpurpose>関数のプロファイルチャートを表示する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>plotprofile(fun)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para>コンパイル済みのScilab 関数, または関数名 (文字列), または関数名の配列</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + ある関数に<literal>plotprofile</literal>を使用する場合, + + この関数についてプロファイル機能を有効にしてある必要があります: + + <itemizedlist> + + <listitem> + + <para> + + <link linkend="add_profiling">add_profiling</link> コマンド. + + </para> + + </listitem> + + <listitem> + + <para> + + または関数が<link linkend="deff">deff</link>コマンドで定義された場合, + + <link linkend="deff">deff</link>のオプション引数に "p" を指定, + + のどちらか + + </para> + + </listitem> + + </itemizedlist> + + </para> + + <para> + + この関数を一度実行した後で, + + <literal>plotprofile</literal>をコールすると, + + 2つのメインウインドウが表示され, + + 1番目には関数のソースコード, + + 2番目には以下を示す3つのヒストグラムが含まれます: + + <itemizedlist> + + <listitem> + <para>各行のコール回数</para> + </listitem> + + <listitem> + <para>各行で使用された合計CPU時間 (単位: 秒)</para> + </listitem> + + <listitem> + <para>各行を解釈するための労力の計測値 (任意の単位)</para> + </listitem> + + </itemizedlist> + + </para> + + + <para> + + ヒストグラムのビンをクリックすると, + + ソースコードウインドウ内で関係する行がハイライト表示されます. + + </para> + + <para> + + 注意: "plotprofile"グラフィックウインドウから出るには, "Exist"要素を使用します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// 関数のプロファイルの例 +function foo() + runs = 50; + b = 0; + for i = 1:runs + b = zeros(220, 220); + for j = 1:220 + for k = 1:220 + b(k,j) = abs(j - k) + 1; + end + end + end +endfunction + +// 関数のプロファイルを有効にする +add_profiling("foo"); + +// 関数を実行 +foo(); + +// プロファイルチャートを表示 +plotprofile(foo) // 出るには Exit をクリック + ]]></programlisting> + + <programlisting role="example"><![CDATA[ +// deffで定義した関数をプロファイルする例 +deff('x = foo2(n)', ['if n > 0 then' + ' x = 0;' + ' for k = 1:n' + ' s = svd(rand(n, n));' + ' x = x + s(1);' + ' end' + 'else' + ' x = [];' + 'end'], .. + 'p'); + +// 関数を実行 +foo2(200); + +// プロファイルチャートを表示 +plotprofile("foo2") // 出るには Exit をクリック + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="showprofile">showprofile</link> + + </member> + + <member> + + <link linkend="reset_profiling">reset_profiling</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/profile.xml b/modules/functions/help/ja_JP/profiling/profile.xml new file mode 100755 index 000000000..77fb4056f --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/profile.xml @@ -0,0 +1,286 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="profile"> + + <refnamediv> + + <refname>profile</refname> + + <refpurpose>関数のプロファイル結果を返す</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>c = profile(fun)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para>Scilab関数</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c</term> + + <listitem> + + <para>以下のプロファイル結果を含む nx3 行列: + + <itemizedlist> + + <listitem> + + <para> + + <literal>c(i,1)</literal> : 関数のi行目の実行回数 + + </para> + + </listitem> + + <listitem> + + <para> + + <literal>c(i,2)</literal> : 関数のi行目を実行する際に費やした累積CPI時間[単位:秒] + + </para> + + </listitem> + + <listitem> + + <para> + + <literal>c(i,3)</literal> : 関数のi行目を1回実行した際のインタプリタの + + 処理負荷の観測量 [任意の単位] + + </para> + + </listitem> + + </itemizedlist> + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + ある関数で<literal>profile</literal>を使用するには, + + この関数についてプロファイル機能を有効にしてある必要があります: + + <itemizedlist> + + <listitem> + + <para> + + <link linkend="add_profiling">add_profiling</link> コマンド. + + </para> + + </listitem> + + <listitem> + + <para> + + または関数が<link linkend="deff">deff</link>コマンドで定義された場合, + + <link linkend="deff">deff</link>のオプション引数に "p" を指定, + + のどちらか + + </para> + + </listitem> + + </itemizedlist> + + </para> + + <para> + + この関数が一度実行された後,<literal>profile</literal>をコールすると, + + 行列が返されます. + + この行列の各行には,(関数のヘッダ行を含む) + + 対応する関数の行に関するプロファイル結果が含まれます. + + この結果は,以下のような + + コール回数, この行に費やした合計CPU時間, この行の実行にかかったインタプリタ負荷 + + です: + + </para> + + <para> + + <informaltable border="1"> + + <tr> + + <td>Number of calls</td><td>Total CPU time (s)</td><td>Interpretor effort</td> + + </tr> + + <tr> + + <td>1</td><td>0</td><td>0</td> + + </tr> + + <tr> + + <td>300</td><td>0.1</td><td>0</td> + + </tr> + + <tr> + + <td>300</td><td>3.59</td><td>5</td> + + </tr> + + <tr> + + <td>...</td><td>...</td><td>...</td> + + </tr> + + </informaltable> + + </para> + + <para> + + ここでは,関数の3行目が300回コールされ, + + 合計CPU時間が 3.59秒であることがわかります. + + </para> + + <para> + + 注意: CPU時間の精度の制約(通常は1マイクロ秒)により, + + 実行時間が非常に速い実行された行は,CPUの合計時間が0と + + 表示される可能性があります. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// プロファイルする関す +function x = foo(n) + if n > 0 then + x = 0; + for k = 1:n + s = svd(rand(n, n)); + x = x + s(1); + end + else + x = []; + end +endfunction + +// 関数のプロファイルを有効化 +add_profiling("foo"); + +// 関数を実行 +foo(200); + +// 関数のプロファイル結果を返す +profile(foo) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="plotprofile">plotprofile</link> + + </member> + + <member> + + <link linkend="showprofile">showprofile</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/remove_profiling.xml b/modules/functions/help/ja_JP/profiling/remove_profiling.xml new file mode 100755 index 000000000..4214f0aed --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/remove_profiling.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="remove_profiling" xml:lang="ja"> + + <refnamediv> + + <refname>remove_profiling</refname> + + <refpurpose>指定した関数のプロファイルを無効にする</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>remove_profiling(funname)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>funname</term> + + <listitem> + + <para>文字列, プロファイルした関数の名前</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>remove_profiling</literal>は,関数のプロファイルに + + 必要な命令を削除します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction +add_profiling("foo") +foo(0.1,100) //関数を実行 +profile(foo) //プロファイル情報を展開 +remove_profiling("foo") + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="plotprofile">plotprofile</link> + + </member> + + <member> + + <link linkend="add_profiling">remove_profiling</link> + + </member> + + <member> + + <link linkend="reset_profiling">reset_profiling</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>使用する関数</title> + + <para> + + この関数は Scilab 関数 <literal>bytecode</literal> および + + <literal>walkbytecode</literal>を使用しています. + + </para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/reset_profiling.xml b/modules/functions/help/ja_JP/profiling/reset_profiling.xml new file mode 100755 index 000000000..46b43b1c5 --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/reset_profiling.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="reset_profiling" xml:lang="ja"> + + <refnamediv> + + <refname>reset_profiling</refname> + + <refpurpose>関数のプロファイル用カウンタをリセットする</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>reset_profiling(funname)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>funname</term> + + <listitem> + + <para>文字列, 関数名</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <literal>reset_profiling(funname)</literal> は, + + <literal>funname</literal>という名前の関数のプロファイル用カウンタをリセット + + します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction +add_profiling("foo") +foo(0.1,100) //関数を実行 +profile(foo) //プロファイル情報を展開 +reset_profiling("foo") +profile(foo) //プロファイル情報を展開 + ]]></programlisting> + + </refsection> + + <refsection> + + <title>S参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="plotprofile">plotprofile</link> + + </member> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="reset_profiling">reset_profiling</link> + + </member> + + <member> + + <link linkend="remove_profiling">remove_profiling</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>使用される関数</title> + + <para> + + この関数は Scilab 関数 <literal>bytecode</literal> および + + <literal>walkbytecode</literal>を使用します. + + </para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/profiling/showprofile.xml b/modules/functions/help/ja_JP/profiling/showprofile.xml new file mode 100755 index 000000000..ea55595c7 --- /dev/null +++ b/modules/functions/help/ja_JP/profiling/showprofile.xml @@ -0,0 +1,230 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="showprofile"> + + <refnamediv> + + <refname>showprofile</refname> + + <refpurpose>関数のプロファイル結果をコンソールに出力</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>showprofile(fun)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fun</term> + + <listitem> + + <para>Scilab関数</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + ある関数で<literal>showprofile</literal>を使用するには, + + この関数についてプロファイル機能を有効にしておく必要があります: + + <itemizedlist> + + <listitem> + + <para> + + <link linkend="add_profiling">add_profiling</link> コマンド. + + </para> + + </listitem> + + <listitem> + + <para> + + または関数が<link linkend="deff">deff</link>コマンドで定義された場合, + + <link linkend="deff">deff</link>のオプション引数に "p" を指定, + + のどちらか + + </para> + + </listitem> + + </itemizedlist> + + </para> + + <para> + + この関数が一度コールされた後, <literal>showprofile</literal>をコールすると, + + プロファイル結果がコンソールに出力されます. + + </para> + + <para> + + 出力される各行には(関数のヘッダ行を含む)対応する関数の行のプロファイル結果が含まれます. + + これには,この行のコール回数,合計CPU消費時間, + + この行の解釈に要したインタプリタ負荷, この行のソースコードが + + 含まれます. + + 出力の例を以下に示します: + + </para> + + <screen> + + |1 |0 |0| function x=fun(n) + + |1 |0 |0| if n > 0 then + + |1 |0 |2| x = 0; + + |200 |0.01 |0| for k = 1:n + + |200 |3.99 |5| s = svd(rand(n, n)); + + |... |... |.| ... + + </screen> + + <para> + + ここでは,関数の5行目が200回コールされ,合計CPU時間が3.99秒であったことがわかります. + + </para> + + <para> + + <literal>show_profile</literal> は + + <link linkend="profile">profile</link>に似ていますが, + + <link linkend="profile">profile</link> はプロファイル結果を + + 行列に返すのに対して, + + <literal>show_profile</literal> はコンソールに結果を出力するのみです. + + </para> + + <para> + + 注意: CPU時間の精度の制約(通常は1マイクロ秒)により, + + 実行時間が非常に速い実行された行は,CPUの合計時間が0と + + 表示される可能性があります. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// プロファイルする関数 +function x = foo(n) + if n > 0 then + x = 0; + for k = 1:n + s = svd(rand(n, n)); + x = x + s(1); + end + else + x = []; + end +endfunction + +// 関数のプロファイルを有効化 +add_profiling("foo"); + +// 関数を実行 +foo(200); + +// プロファイル結果をコンソールに出力 +showprofile(foo) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="add_profiling">add_profiling</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + <member> + + <link linkend="plotprofile">plotprofile</link> + + </member> + + <member> + + <link linkend="reset_profiling">reset_profiling</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/recompilefunction.xml b/modules/functions/help/ja_JP/recompilefunction.xml new file mode 100755 index 000000000..ce0186268 --- /dev/null +++ b/modules/functions/help/ja_JP/recompilefunction.xml @@ -0,0 +1,176 @@ +<?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="recompilefunction"> + + <refnamediv> + + <refname>recompilefunction</refname> + + <refpurpose>型を変更し,Scilab関数を再コンパイルする</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>recompilefunction(funname [,kind [,force]])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>funname</term> + + <listitem> + + <para>文字列, 再コンパイルする関数の名前 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>kind</term> + + <listitem> + + <para> + + 文字列: <emphasis role="bold">"n"</emphasis> (コンパイル前, 11型), + + <emphasis role="bold">"c"</emphasis> + + (コンパイル済み, 13型) または <emphasis role="bold">"p"</emphasis> + + (コンパイル済み, type 型, プロファイル用). デフォルト: "c". + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>force</term> + + <listitem> + + <para> + + 論理値. falseの場合, 関数は kind が変更された場合のみ再コンパイルされます; + + true の場合, 同じ kind が維持される場合でも再コンパイルされます + + (プロファイル統計をリセットするために "p" 関数を再コンパイルする場合に特に有用です). + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <itemizedlist> + + <listitem> + + <para> + + この関数は<link linkend="fun2string">fun2string</link>により + + 関数変数を逆コンパイルし, <link linkend="deff">deff</link>により + + 指定した種類に再コンパイルします. + + </para> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +for i=1:100; asinh(rand(100,100)); end +showprofile(asinh) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="function">function</link> + + </member> + + <member> + + <link linkend="deff">deff</link> + + </member> + + <member> + + <link linkend="comp">comp</link> + + </member> + + <member> + + <link linkend="fun2string">fun2string</link> + + </member> + + <member> + + <link linkend="profile">profile</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>参考文献</title> + + <para> + + http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation + + </para> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/sciargs.xml b/modules/functions/help/ja_JP/sciargs.xml new file mode 100755 index 000000000..a5dde6e87 --- /dev/null +++ b/modules/functions/help/ja_JP/sciargs.xml @@ -0,0 +1,72 @@ +<?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="sciargs"> + + <refnamediv> + + <refname>sciargs</refname> + + <refpurpose>scilab コマンドライン引数</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>args = sciargs()</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para> + + この関数は,Scilabコマンドライン引数を含む + + 文字列の行ベクトルを返します. + + <literal>args</literal>の最初のエントリには, + + 実行された実行ファイルのパスが含まれます. + + </para> + + <para> + + この関数はC言語の<literal>getarg</literal>関数と等価です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +args=sciargs() + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="getenv">getenv</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/str2code.xml b/modules/functions/help/ja_JP/str2code.xml new file mode 100755 index 000000000..0d1520614 --- /dev/null +++ b/modules/functions/help/ja_JP/str2code.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="str2code" xml:lang="en"> + + <refnamediv> + + <refname>str2code</refname> + + <refpurpose> + + 文字列に関するScilab整数コードを返す. + + <emphasis role="bold">この関数は廃止されました.</emphasis> + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>c = str2code(str)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>文字列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c</term> + + <listitem> + + <para>整数コード文字の列ベクトル.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>c = str2code(str)</code> は列ベクトル + + <varname>c</varname>を返します. + + ただし,<literal>c(i)</literal> は, + + <literal>part(str,i)</literal>のScilab整数コードです. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +str2code('Scilab')' +code2str([-28 12 18 21 10 11]) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="code2str">code2str</link> + + </member> + + <member> + + <link linkend="ascii">ascii</link> + + </member> + + <member> + + <link linkend="part">part</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>履歴</title> + + <revhistory> + + <revision> + + <revnumber>5.4.0</revnumber> + + <revremark>この関数は Scilab 6.0.0で削除されます.</revremark> + + </revision> + + </revhistory> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/tree2code.xml b/modules/functions/help/ja_JP/tree2code.xml new file mode 100755 index 000000000..821c87ebb --- /dev/null +++ b/modules/functions/help/ja_JP/tree2code.xml @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="tree2code"> + + <refnamediv> + + <refname>tree2code</refname> + + <refpurpose>Scilab関数のアスキー定義を生成する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>txt = tree2code(tree, prettyprint)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>tree</term> + + <listitem> + + <para> + + マクロツリー (<function>macr2tree</function>の出力) + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>prettyprint</term> + + <listitem> + + <para>オプションの論理値</para> + + <variablelist> + + <varlistentry> + + <term>%T</term> + + <listitem> + + <para>生成されるコードはインデント,整形されます</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>%F</term> + + <listitem> + + <para>生成されるコードは整形されません (デフォルト)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>txt</term> + + <listitem> + + <para>文字列の列ベクトルで, Scilab命令を指定するテキスト</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 読み込まれたScilab関数 "ツリー" (<function>macr2tree</function>の出力)を + + 指定することで, <function>tree2code</function> + + によりコードを再生成することができます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="macr2tree">macr2tree</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/functions/help/ja_JP/varargin.xml b/modules/functions/help/ja_JP/varargin.xml new file mode 100755 index 000000000..2e136c173 --- /dev/null +++ b/modules/functions/help/ja_JP/varargin.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargin" xml:lang="ja"> + <refnamediv> + <refname>varargin</refname> + <refpurpose>入力引数リストの引数の数を可変にする</refpurpose> + </refnamediv> + <refsection> + <title>説明</title> + <para> + 最後の入力引数が<literal>varargin</literal>となる関数は + 入力引数リストに示した数よりも多くの入力引数を指定して + コールすることができます. + <literal>varargin</literal>キーワードよりも後に渡された入力引数は, + 関数内では<literal>varargin</literal>という名前のリストとして取得することが + できます. + </para> + <para> + <literal>varargin</literal>キーワードが形式的な入力引数リストの中で + <literal>n</literal>番目の引数と仮定すると, + 関数が <literal>n-1</literal> 個未満の入力引数を指定して + コールされた場合, + <literal>varargin</literal>リストは定義されませんが, + <literal>n-1</literal>個の引数を指定してコールされた場合には + <literal>varargin</literal>リストは空のリストとなります. + </para> + <para> + <literal>function y= ex(varargin)</literal> は + 任意の数の入力引数を指定してコールすることが可能です. + 関数<literal>ex</literal>の中では, 入力引数は + <literal>varargin(i)</literal>, <literal>i=1:length(varargin)</literal> + により取得可能です. + </para> + <para> + 関数の最後の入力引数ではない場合, + <literal>varargin</literal>は,特殊な意味を持たない通常の + 入力引数の名前となります. + </para> + <para> + 実際の入力引数の総数は,<code>argn(2)</code>で取得できます. + </para> + </refsection> + <refsection> + <title>注意</title> + <para> + <literal>foo(...,key=value)</literal> のような名前付き引数構文は + <literal>varargin</literal>とは互換性がありません. + その理由は, + 値に対応する名前(すなわち, keys) が <literal>varargin</literal> リストに + 保存されないためです. + 例えば,以下について考えてみてください: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +function foo(varargin) + disp([varargin(1),varargin(2)]) +endfunction + ]]></programlisting> + <screen> + -->foo(a=1,b=2) + 1. 2. + -->foo(b=1,a=2) + 1. 2. + </screen> + <para>結果は同じですが, 引数は逆になります.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +function exampl(a,varargin) + [lhs,rhs]=argn(0) + if rhs>=1 then + disp(varargin) + end +endfunction +exampl(1) +exampl() +exampl(1,2,3) +l=list('a',%s,%t); +exampl(1,l(2:3)) +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ja_JP/varargout.xml b/modules/functions/help/ja_JP/varargout.xml new file mode 100755 index 000000000..9472e16ac --- /dev/null +++ b/modules/functions/help/ja_JP/varargout.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargout" xml:lang="ja"> + <refnamediv> + <refname>varargout</refname> + <refpurpose>出力変数リストの引数の数を可変にする</refpurpose> + </refnamediv> + <refsection> + <title>説明</title> + <para> + 出力引数リスト <literal>varargout</literal>を含む関数は + 出力引数に示されたよりも多くの出力引数を指定して + コールされる必要があります. + <literal>varargout</literal>キーワード以降に指定された引数は + 関数で定義された<literal>varargout</literal>リストから + 展開することができます. + </para> + <para> + <literal>varargout= function ex()</literal> は任意の数の + 出力引数を指定してコールすることができます. + 関数<literal>ex</literal>の中では + 出力引数を<literal>varargout(i)</literal>に保存することができます. + </para> + <para> + <literal>[X1,...,Xn,varargout] = function ex()</literal> も + 使用可能です. + この場合,<literal>Xi</literal>引数は, + <literal>varargout(i)</literal>と同様に + 関数内で代入される必要があります. + </para> + <para> + 出力引数の実際の総数は,<code>argn(1)</code>で取得できます. + </para> + </refsection> + <refsection> + <title>注記</title> + <para> + <literal>varargout</literal> 変数は関数内で作成され, + <link linkend="list">list</link>に代入される必要があります. + <literal>varargout</literal> が唯一の形式上の出力変数の場合, + リストには最低でも一つのエントリを含む必要があります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +function varargout=exampl() + varargout=list(1,2,3,4) +endfunction +x=exampl() +[x,y]=exampl() +[x,y,z]=exampl() +function [a,b,varargout]=exampl1() + a='first' + b='second' + varargout=list(1,2,3,4) +endfunction +exampl1() +[a,b]=exampl1() +[a,b,c]=exampl1() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/addchapter.sce b/modules/functions/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..a53fdb337 --- /dev/null +++ b/modules/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",SCI+"/modules/functions/help/pt_BR",%T); + diff --git a/modules/functions/help/pt_BR/argn.xml b/modules/functions/help/pt_BR/argn.xml new file mode 100755 index 000000000..938f24d80 --- /dev/null +++ b/modules/functions/help/pt_BR/argn.xml @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="argn" xml:lang="en"> + <refnamediv> + <refname>argn</refname> + <refpurpose>nmero de argumentos na chamada de uma funo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[lhs [,rhs] ]=argn() + lhs=argn(1) + rhs=argn(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Esta funo usada dentro da definio de uma funo. Ela fornece + os nmeros de parmetros de entrada <literal>rhs</literal> e sada + <literal>lhs</literal> passados funo quando esta chamada. Geralmente + usada em definies de funes para lidar com parmetros + opcionais. + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/CHAPTER b/modules/functions/help/pt_BR/built_in/CHAPTER new file mode 100755 index 000000000..4beffcea0 --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/CHAPTER @@ -0,0 +1,2 @@ +title = Built-in & external + diff --git a/modules/functions/help/pt_BR/built_in/clearfun.xml b/modules/functions/help/pt_BR/built_in/clearfun.xml new file mode 100755 index 000000000..8edda6f8b --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/clearfun.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="clearfun" xml:lang="en"> + <refnamediv> + <refname>clearfun</refname> + <refpurpose>remove funo primitiva</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>ret=clearfun('name')</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para> + <literal>clearfun('name')</literal> remove a primitiva + <literal>'name'</literal> do conjunto de primitivas (funes built-in). + clearfun retorna %t ou %f. Esta funo permite renomear uma primitiva : + uma primitiva Scilab pode ser substituda por uma funo definida pelo + usurio. Para usurios experientes... + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="funptr">funptr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/external.xml b/modules/functions/help/pt_BR/built_in/external.xml new file mode 100755 index 000000000..f3f7399ac --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/external.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="external" xml:lang="en"> + <refnamediv> + <refname>external</refname> + <refpurpose>objeto Scilab, funo ou rotina externa</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para>Funo ou rotina externa para uso com comandos especficos.</para> + <para>Uma "external" uma funo ou rotina que usada como argumento em + algumas primitivas de alto nvel (tais como <literal>ode</literal>, + <literal>optim</literal>, <literal>schur</literal>...). + </para> + <para>A seqncia de chamamento da "external" (funo ou rotina) imposta + pela primitiva de alto nvel que configura os argumentos da + external. + </para> + <para>Por exemplo, a funo externa costfunc um argumento da primitiva + optim . Sua seqncia de chamamento deve ser: + <literal>[f,g,ind]=costfunc(x,ind)</literal> e <literal>optim</literal> (a + primitiva de otimizao de alto nvel) invocada como segue: + </para> + <programlisting role=""><![CDATA[ +optim(costfunc,...) + ]]></programlisting> + <para> + Aqui <literal>costfunc</literal> (a funo de custo a ser minimizada + pela primitiva <literal>optim</literal>) avalia <literal>f=f(x)</literal> + e <literal>g=</literal> gradiente de <literal>f</literal> em + <literal>x</literal> (<literal>ind</literal> um inteiro. Seu uso + esclarecido na ajuda de <literal>optim</literal>). + </para> + <para>Se a funo externa necessita de outros valores, estas variveis + podem ser definidas em seu ambiente. Elas tambm podem ser colocadas em + uma lista. Por exemplo, a funo externa + </para> + <programlisting role=""><![CDATA[ +[f,g,ind]=costfunc(x,ind,a,b,c) + ]]></programlisting> + <para> + vlida para <literal>optim</literal> se o external (funo + externa) <literal>list(costfunc,a,b,c)</literal> e a chamada a + <literal>optim</literal> , ento: + </para> + <programlisting role=""><![CDATA[ +optim(list(costfunc,a1,b1,c1),.... + ]]></programlisting> + <para>Um external tambm pode ser uma rotina FORTRAN ou C: isto + conveniente para acelerar computaes. + </para> + <para>TO nome da rotina fornecido para a primitiva de alto nvel como um + string. A seqncia de chamamento da rotina tambm imposta. + </para> + <para>Rotinas FORTRAN ou C podem ser dinamicamente linkadas ("ligadas, + conectadas") (ver <literal>link</literal>) + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="ode">ode</link> + </member> + <member> + <link linkend="optim">optim</link> + </member> + <member> + <link linkend="impl">impl</link> + </member> + <member> + <link linkend="dassl">dassl</link> + </member> + <member> + <link linkend="intg">intg</link> + </member> + <member> + <link linkend="schur">schur</link> + </member> + <member> + <link linkend="gschur">gschur</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/funptr.xml b/modules/functions/help/pt_BR/built_in/funptr.xml new file mode 100755 index 000000000..dc0db56df --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/funptr.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="funptr" xml:lang="en"> + <refnamediv> + <refname>funptr</refname> + <refpurpose>codificao de primitivas </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[numptr] = funptr(name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para>string, nome de uma primitiva </para> + </listitem> + </varlistentry> + <varlistentry> + <term>numptr</term> + <listitem> + <para>o nmero de rotina interno da primitiva</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Fuo utilitria (para usurios mais experientes apenas) para + retornar o nmero de rotina interno <literal>numptr</literal> da primitiva + <literal>'name'</literal>. <literal>numptr</literal> formado a partir do + nmero de interface <literal>fun</literal> e do nmero de rotina + <literal>fin</literal> da primitiva em sua interface por <literal>numptr = + 100*fun + fin + </literal> + (fin < 100). De <literal>numptr</literal> + pode-se obter o nmero de interface <literal>fun = floor(numptr/100) + </literal> + que pode ser til para ligar uma interface dinmica com seus + argumentos passados por referncia (ver seo de exemplos). + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +// Suponha que voc queira carregar alguns cdigos atravs +// das facilidades de carregamento dinmico oferecidas por addinter. Por padro +// os argumentos so passados por valores, mas se voc quiser +// pass-los por referncia, voc pode fazer o seguinte +// (nome sendo o nome scilab de uma das rotinas com +// interface) : +// +// addinter(files,spnames,fcts) // argumentos passados por valores +// num_interface = floor(funptr(nome)/100) +// intppty(num_interface) // argumentos agora passados por referncia +// +// Note que se voc digitar o seguinte +// +// intppty() +// +// voc ver todas as interfaces funcionando por referncia + ]]></programlisting> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="intppty">intppty</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/intppty.xml b/modules/functions/help/pt_BR/built_in/intppty.xml new file mode 100755 index 000000000..ef3b30e0b --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/intppty.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="intppty" xml:lang="en"> + <refnamediv> + <refname>intppty</refname> + <refpurpose>ajusta propriedades de passagem de argumentos de + interface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>funs=intppty() + intppty(fun) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>inteiro, um nmero de interface (ver funptr)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>funs</term> + <listitem> + <para>vetor de inteiros, vetor de nmeros de interface (ver + funptr) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> Os programas de interface pode ser escritos de duas formas + diferentes para o modo de passagem de argumento de funes. + </para> + <para> No primeiro modo, que o padro, os argumentos so passados por + valor. A sintaxe a seguinte: + </para> + <programlisting role=""><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + o argumento associado a <literal>A</literal> ser passado por + valores (uma cpia de <literal>A</literal> feita antes de + <literal>foo</literal> i ser chamada, e o argumento associado a + <literal>1+2</literal> ser passado por valor. + </para> + <para>No segundo modo, os argumentos podem ser passados por referncia, se + houver "argumentos nomeados" (nenhuma cpia do valor da varivel feita). + <literal>intppty(fun)</literal> com <literal>fun>0</literal> diz ao + Scilab que a interface com o nmero <literal>fun</literal> pode manipular + argumentos passados por referncia. A sintaxe a seguinte: + </para> + <programlisting role=""><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + O argumento associado a <literal>A</literal> ser passado por + referncia e o argumento associado a <literal>1+2</literal> ser passado + por valor. + </para> + <para> + Aviso: a declarao de interface com nmero <literal>fun</literal> + pode manipular argumentos passados por referncia se no for o caso de + produzir resultados imprevisveis. + </para> + <para> + <literal>intppty(fun)</literal> com <literal>fun<0</literal> + suprime esta propriedade para para a interface + <literal>-fun</literal>. + </para> + <para> + <literal>intppty()</literal> retorna o vetor de interfaces que + manipulam argumentos passados por referncia. + </para> + <para>Esta funo pode ser til para interfaces dinamicamente carregadas + (ver addinter). + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="funptr">funptr</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/newfun.xml b/modules/functions/help/pt_BR/built_in/newfun.xml new file mode 100755 index 000000000..116809ec7 --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/newfun.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="newfun" xml:lang="en"> + <refnamediv> + <refname>newfun</refname> + <refpurpose>adiciona um nome tabela de funes</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>newfun("function-name",nameptr)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Funo utilitria (apenas para peritos). Adiciona o nome + <literal>"function-name"</literal> tabela de funes conhecidas pelo + interpretador. <literal>"nameptr"</literal> um inteiro + <literal>100*fun+fin</literal> onde <literal>fun</literal> e + <literal>fin</literal> a codficao interna da primitiva + <literal>"function-name"</literal>. Esta funo til para associar uma + primitiva a uma rotina com interface em <literal>"matusr.f"</literal> + (<literal>fun=14</literal>). Usado com <literal>funptr</literal> e + <literal>clearfun</literal> pode-se redefinir uma primitiva por uma funo + com o mesmo nome. + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/readgateway.xml b/modules/functions/help/pt_BR/built_in/readgateway.xml new file mode 100755 index 000000000..895e1c093 --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/readgateway.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="readgateway" xml:lang="en"> + <refnamediv> + <refname>readgateway</refname> + <refpurpose>retorna a lista de primitivas de um módulo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>readgateway(module_name) + primitives = readgateway(module_name); + [primitives,primitivesID] = readgateway(module_name); + [primitives,primitivesID,gatewayID] = readgateway(module_name); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrição</title> + <para>Retorna a lista de primitivas de um módulo.</para> + <para>Primitives : lista de primitivas de um módulo.</para> + <para>primitivesID : lista de identificadores das primitivas.</para> + <para>gatewayID : lista de identificadores de portas de ligaçãos + associados ao módulo. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +[primitives,primitivesID,gatewayID] = readgateway('core'); +primitives(1) // primitiva 'debug' primitive +primitivesID(1) // 1 é o ID de 'debug' na porta de ligação de 'core' +gatewayID(1) // 13 é o ID da porta de ligação de 'core' no Scilab + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="getmodules">getmodules</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/built_in/what.xml b/modules/functions/help/pt_BR/built_in/what.xml new file mode 100755 index 000000000..fbe0500bc --- /dev/null +++ b/modules/functions/help/pt_BR/built_in/what.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="what" xml:lang="pt"> + <refnamediv> + <refname>what</refname> + <refpurpose>lista de primitivas do Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title> Seqncia de Chamamento </title> + <synopsis>what() + [primitives,commands]=what(); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Lista de comandos e primitivas de nvel baixo.</para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="whereami">whereami</link> + </member> + <member> + <link linkend="pause">pause</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/bytecode.xml b/modules/functions/help/pt_BR/bytecode.xml new file mode 100755 index 000000000..7af6fd43d --- /dev/null +++ b/modules/functions/help/pt_BR/bytecode.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA Serge Steer + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + *--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="bytecode" xml:lang="pt"> + <refnamediv> + <refname>bytecode</refname> + <refpurpose>dada uma funo, retorna "bytecode" (cdigo de bytes) da + funo em um array Scilab e vice-versa. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis> + x = bytecode(f) + f = bytecode(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>f</term> + <listitem> + <para>funo Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>vetor linha int32</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <code>x = bytecode(f)</code> retorna o "bytecode" da funo + <varname>f</varname> no array Scilab de inteiros + <varname>x</varname>. + </para> + <para> + <code>f= bytecode(x)</code> retorna em <varname>f</varname> a + funo associada ao "bytecode" dado no array Scilab de inteiros + <varname>x</varname>. + <warning> + AVISO: a validade de <varname>x</varname> no + verificada. + </warning> + </para> + </refsection> + <refsection> + <title>Observao</title> + <para>O bytecode da funo Scilab evoluir drasticamente no futuro, ento + o uso dessa funo deve se restringir manipulao de instrues de + profiling. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function a=foo(),a=sin(3),endfunction +bytecode(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="bytecodewalk">bytecodewalk</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/bytecodewalk.xml b/modules/functions/help/pt_BR/bytecodewalk.xml new file mode 100755 index 000000000..fdd70b356 --- /dev/null +++ b/modules/functions/help/pt_BR/bytecodewalk.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Ajouter ici d'ventuels commentaires sur le fichier XML +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="bytecodewalk" xml:lang="fr"> + <refnamediv> + <refname>bytecodewalk</refname> + <refpurpose>caminha no bytecode (cdigo de bytes) da funo aplicando + transformao + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>c1 = bytecodewalk(code,query,job)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>code</term> + <listitem> + <para>vetor int32: array de bytecode de entrada</para> + </listitem> + </varlistentry> + <varlistentry> + <term>query</term> + <listitem> + <para>inteiro, o opcode (cdigo de operao) a ser procurado</para> + </listitem> + </varlistentry> + <varlistentry> + <term>job</term> + <listitem> + <para>a operao a ser realizada, requerida para</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c1</term> + <listitem> + <para>vetor int32: array de bytecode de sada</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>caminha no bytecode da funo aplicando transformao</para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="bytecode">bytecode</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/comp.xml b/modules/functions/help/pt_BR/comp.xml new file mode 100755 index 000000000..635496b9d --- /dev/null +++ b/modules/functions/help/pt_BR/comp.xml @@ -0,0 +1,76 @@ +<?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: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="comp" xml:lang="en"> + <refnamediv> + <refname>comp</refname> + <refpurpose>compilação de função Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>comp(function [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>function</term> + <listitem> + <para>uma função scilab não-compilada (tipo 11)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>flag com valor 0 (padrão), 1 ou 2.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>comp(function)</literal> compila a função + <literal>function</literal>. Funções compiladas e interpretadas são + equivalentes, mas geralmente as compiladas são mais rápidas. As funções + fornecidas nas bibliotecas padrões são compiladas. + </para> + <para>A definição online bem como a sintaxe curta dos comandos + <literal>exec</literal> e <literal>deff</literal> geram funções + compiladas. Então comp tem que ser usado apenas em casos bem particulares. + Para se produzir uma função não compilada, deve-se usar <link linkend="exec">exec</link> ou <link linkend="deff">deff</link> com a opção + <literal>"n"</literal>. + </para> + <para>O valor opt==2 faz com que a função seja compilada "para definição + de perfil". Note que agora é possível adicionar a instrução de definição + de perfil após a compilação utilizando a função <link linkend="add_profiling">add_profiling</link> . + </para> + <para>A opção obsoleta opt==1 era específica para propósitos de análise de + códigos e agora é ignorada, i.e tratada como opt==0. + </para> + <para>Note: na compilação a função original é modificada e nenhum objeto + novo é criado. + </para> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/deff.xml b/modules/functions/help/pt_BR/deff.xml new file mode 100755 index 000000000..b7799bc08 --- /dev/null +++ b/modules/functions/help/pt_BR/deff.xml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="deff" xml:lang="pt"> + <refnamediv> + <refname>deff</refname> + <refpurpose>definio on-line de funo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>deff('[s1, s2, ...] = newfunction(e1, e2,...)',text [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>e1, e2, ...</term> + <listitem> + <para>variveis de entrada.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s1, s2, ...</term> + <listitem> + <para>variveis de sada.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para>matriz de strings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>string opcional:</para> + <variablelist> + <varlistentry> + <term>'c'</term> + <listitem> + <para>a funo "compilada" para ser eficiente + (padro); + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>'p'</term> + <listitem> + <para>a funo compilada e preparada para profiling (ver + <link linkend="profile">profile</link>); + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>'n'</term> + <listitem> + <para>a funo no "compilada".</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <function>deff</function> pode ser usada para definir funes de + seqncias de instrues escritas em strings de textos. Objeto funo + resultante tem as mesmas propriedades que qualquer outra funo definida + em um arquivo de texto e carregada atravs de <function>exec</function> ou + <function>exec</function>. + </para> + <para>Aspas em instrues (delimitando strings ou indicando transposio + de matrizes) devem ser dobradas para serem interpretadas corretamente (ver + quote). Isto pode tornar a escrita um tanto estranha. Uma alternativa em + tais casos definir funes em arquivos, como de uso, para carreg-las no + Scilab atravs de <function>exec</function> (com a opo + <literal>'n'</literal>) e utilizar <function>sci2exp</function> para uma + impresso das instrues <function>deff</function> correspondentes. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +deff('[x]=myplus(y,z)','x=y+z') + +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="quote">quote</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/edit.xml b/modules/functions/help/pt_BR/edit.xml new file mode 100755 index 000000000..f2b5f3870 --- /dev/null +++ b/modules/functions/help/pt_BR/edit.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="edit" xml:lang="en"> + <refnamediv> + <refname>edit</refname> + <refpurpose>edição de funções</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>edit(functionname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>functionname</term> + <listitem> + <para>string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para>Se functionname for o nome de uma função Scilab definida + <literal>edit(functionname)</literal> tente abrir o arquivo associado + <literal>functionname.sci</literal>. + </para> + <para>Se functionname for o nome de uma função Scilab indefinida, + <literal>edit</literal> cria o arquivo functionname.sci no diretório + TMPDIR. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +edit('edit') //abre o editor com o texto dessa função +edit('myfunction') //abre o editor para uma nova função + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="manedit">manedit</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/exec.xml b/modules/functions/help/pt_BR/exec.xml new file mode 100755 index 000000000..47c004041 --- /dev/null +++ b/modules/functions/help/pt_BR/exec.xml @@ -0,0 +1,193 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="exec" xml:lang="pt"> + <refnamediv> + <refname>exec</refname> + <refpurpose>execução de arquivo script ("script" significa + roteiro) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>exec(path [,mode]) + exec(fun [,mode]) + ierr = exec(path,'errcatch' [,mode]) + ierr = exec(fun,'errcatch' [,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>string, o endereço do arquivo script </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para>escalar inteiro, o modo de execução (ver abaixo) </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fun</term> + <listitem> + <para>uma função do Scilab </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>inteiro, 0 ou número de erro</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <code>exec(path [,mode])</code> executa seqüencialmente as + instruções contidas no arquivo fornecido por <varname>path</varname> com + um modo de execução opcional <varname>mode</varname> . + </para> + <para> + Os casos diferentes para <varname>mode</varname> são : + </para> + <variablelist> + <varlistentry> + <term>0</term> + <listitem> + <para> + o valor padrão. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>-1</term> + <listitem> + <para> + nada é impresso. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>1</term> + <listitem> + <para> + eco de cada linha de comando. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + prompt <literal>--></literal> é impresso. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>3</term> + <listitem> + <para> + ecos + prompts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + pára antes de cada prompt. A execução retorna + após cada retorno de carro. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para> + paradas + prompts + ecos : útil para demos. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>exec(fun [,mode])</code> executa a função + <varname>fun</varname> como um script: sem argumentos de entrada ou saída + nem ambientes de variáveis específicos. Esta forma é mais eficiente, + porque o código script pode se pré-compilado (ver <link linkend="comp">comp</link>). Este método + para avaliação de scripts permite armazenar scripts como funções em + bibliotecas. + </para> + <para> + Se um erro é encontrado durante a execução, se o flag <literal>'errcatch'</literal> + estiver presente <function>exec</function> não imprime mensagem de erro, + aborta execução de instruções e retorna com <varname>ierr</varname> e + igual ao número de erro. Se o flag <literal>'errcatch'</literal> não estiver presente, a + manipulação de erros padrão é utilizada. + </para> + </refsection> + <refsection> + <title>Observação </title> + <para>Arquivos executáveis (exec files) podem agora ser usados para + definir funções "inline" utilizando a sintaxe de definição (ver + <link linkend="function">function</link>). + </para> + </refsection> + <!-- + <para><function>exec</function> supports files encoded as ANSI/ASCII and UTF-8 (NO-BOM).</para> + <para>The length of each line in a file is limited to 4096 characters.</para> +--> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +// criando um arquivo script +mputl('a=1;b=2',TMPDIR+'/meuscript') +// executando-o +exec(TMPDIR+'/meuscript') +whos -name "a " + +// criando uma função +deff('y=foo(x)','a=x+1;y=a^2') +clear a b +// chamando a função +foo(1) +// a é uma variável criada no ambiente da função foo +// ela é destruída quando foo retorna +whos -name "a " + +x=1 //criando x para torná-la conhecida pelo script foo +exec(foo) +// a e y são criadas no ambiente corrente +whos -name "a " +whos -name "y " + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="mode">mode</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/execstr.xml b/modules/functions/help/pt_BR/execstr.xml new file mode 100755 index 000000000..746efa960 --- /dev/null +++ b/modules/functions/help/pt_BR/execstr.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="execstr" xml:lang="pt"> + <refnamediv> + <refname>execstr</refname> + <refpurpose>executa cdigo Scilab em strings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>execstr(instr) + ierr = execstr(instr, 'errcatch' [,msg]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>instr</term> + <listitem> + <para>vetor de strings, instruo Scilab a ser executada. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>inteiro, 0 ou nmero de erro. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para> + string com valores <literal>'m'</literal> ou + <literal>'n'</literal>. O padro <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Executa as instrues Scilab fornecidas pelo argumento + <varname>instr</varname>. + </para> + <note> + Note que <varname>instr</varname> no deve fazer uso de marcas de continuao (..) + </note> + <para> + Se o flag <literal>'errcatch'</literal> no estiver presente, a manipulao de erros + ocorre de maneira usual. + </para> + <para> + Se o flag <literal>'errcatch'</literal> for ajustado, e um erro for encontrado enquanto + so executadas as instrues definidas em <varname>instr</varname>, + <function>execstr</function> no imprime uma mensagem de erro, mas aborta a + execuo das instrues <varname>instr</varname> (no ponto onde o erro + ocorreu) e retorna com <varname>ierr</varname> igual ao nmero de erro. + Neste caso a exibio da mensagem de erro controlada pela opo + <varname>msg</varname> : + </para> + <variablelist> + <varlistentry> + <term>"m"</term> + <listitem> + <para>a mensagem exibida e registrada.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>"n"</term> + <listitem> + <para>nenhuma mensagem de erro exibida, mas a mensagem de erro + registrada (ver <literal>lasterror</literal>). Este o + padro. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>ierr = execstr(instr, 'errcatch')</code> pode manipular erros sintticos. + Isto til para a avaliao de uma instruo obtida por uma pegunta ao + usurio. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +execstr('a=1') // ajusta a=1. +execstr('1+1') // faz nada (enquanto evstr('1+1') retorna 2) + +execstr(['if %t then'; + ' a=1'; + ' b=a+1'; + 'else' + ' b=0' + 'end']) + +execstr('a=zzzzzzz','errcatch') +execstr('a=zzzzzzz','errcatch','m') + +//erros de sintaxe +execstr('a=1?02','errcatch') +lasterror(%t) + +execstr('a=[1 2 3)','errcatch') +lasterror(%t) + +// variable1 does not exist +if execstr('variable1;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end + +// variable2 exists ... no error is triggered by execstr +variable2=[2,3]; +if execstr('variable2;','errcatch')<>0 then + disp("Trigger an error"); +else + disp("execstr is happy"); +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="lasterror">lasterror</link> + </member> + <member> + <link linkend="error">error</link> + </member> + <member> + <link linkend="try">try</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/fun2string.xml b/modules/functions/help/pt_BR/fun2string.xml new file mode 100755 index 000000000..ce9403d31 --- /dev/null +++ b/modules/functions/help/pt_BR/fun2string.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fun2string" xml:lang="pt"> + <refnamediv> + <refname>fun2string</refname> + <refpurpose>gera definio ASCII de uma funo Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>txt = fun2string(fun, name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>varivel do tipo funo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para>string, o nome da funo gerada</para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>vetor coluna de strings, o texto fornecendo as instrues + Scilab + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Dado um pseudo-cdigo de funo Scilab carregada <function>fun2string</function> permite + gerar novamente o cdigo. O cdigo gerado identado e embelezado. + </para> + <para> + O mecanismo similar, mas mais simples que o de <function>mfile2sci</function>. Tambm + pode ser adaptado para tradues de sintaxe. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +txt = fun2string(asinh,'foo'); +write(%io(2),txt,'(a)') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="edit">edit</link> + </member> + <member> + <link linkend="macrovar">macrovar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/funcprot.xml b/modules/functions/help/pt_BR/funcprot.xml new file mode 100755 index 000000000..a3b030673 --- /dev/null +++ b/modules/functions/help/pt_BR/funcprot.xml @@ -0,0 +1,74 @@ +<?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="funcprot" xml:lang="en"> + <refnamediv> + <refname>funcprot</refname> + <refpurpose>alterna o modo de proteo de funes Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>funcprot(prot) + previousprot = funcprot(prot) + prot = funcprot() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>prot</term> + <listitem> + <para>inteiro com valores possveis 0,1 ou 2</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Funes Scilab so variveis, <function>funcprot</function> permite especificar o que o + Scilab faz quando tais variveis so redefinidas. + </para> + <itemizedlist> + <listitem> + <para> + Se <code>prot==0</code> nada especial feito + </para> + </listitem> + <listitem> + <para> + Se <code>prot==1</code> o Scilab exibe uma mensagem de aviso quando a funo + redefinida (modo padro) + </para> + </listitem> + <listitem> + <para> + Se <code>prot==2</code> o Scilab exibe uma mensagem de erro quando a funo + redefinida + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +previousprot = funcprot(1) +deff('x = foo(a)','x = a;') +deff('x = foo(a)','x = a + 1;') +foo = 33 +funcprot(0) +deff('x = foo(a)', 'x = a;') +deff('x = foo(a)', 'x = a + 1;') +foo = 33 +funcprot(previousprot) +]]></programlisting> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>Previous value is returned as output argument when setting a new value.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/function.xml b/modules/functions/help/pt_BR/function.xml new file mode 100755 index 000000000..396588a4b --- /dev/null +++ b/modules/functions/help/pt_BR/function.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="function" xml:lang="pt"> + <refnamediv> + <refname>function</refname> + <refpurpose>abre definio de funo</refpurpose> + </refnamediv> + <refnamediv xml:id="endfunction"> + <refname>endfunction</refname> + <refpurpose>encerra definio de funo</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <programlisting role='no-scilab-exec'><![CDATA[ +function <lhs_arguments>=<function_name><rhs_arguments> +<statements> +endfunction + ]]></programlisting> + <para>Onde</para> + <variablelist> + <varlistentry> + <term><function_name></term> + <listitem> + <para> o nome da funo</para> + </listitem> + </varlistentry> + <varlistentry> + <term><rhs_arguments></term> + <listitem> + <para> a lista de argumentos de entrada. Pode ser:</para> + <itemizedlist> + <listitem> + <para>uma seqncia separada por vrgula de nomes de variveis + encerrada por parnteses, como <literal>(x1,...,xm)</literal>. O + ltimo nome de varivel pode ser a palavra-chave + <literal>varargin</literal> (ver <link linkend="varargin">varargin</link>) + </para> + </listitem> + <listitem> + <para> + a seqncia <literal>()</literal> ou nada, se a funo no + possui argumentos de entrada. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><lhs_arguments></term> + <listitem> + <para> a lista de argumentos de sada. Pode ser:</para> + <itemizedlist> + <listitem> + <para>uma seqncia separada por vrgula de nomes de variveis + encerrada por colchetes, como <literal>[y1,...,yn]</literal>. O + ltimo nome de varivel pode ser a palavra-chave + <literal>varargout</literal> (ver <link linkend="varargout">varargout</link>) + </para> + </listitem> + <listitem> + <para> + a seqncia <literal>[]</literal>, se a funo no possui + argumentos de sada. neste caso, a sintaxe tambm, pode ser: + <literal>function + <function_name><rhs_arguments> + </literal> + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><statements></term> + <listitem> + <para>conjunto de instrues Scilab (declaraes). Esta sintaxe pode + ser usada para definir funes (ver <link linkend="functions">functions</link>) inline ou em arquivo + script (ver <link linkend="exec">exec</link>). Para compatibilidade com verses Scilab antigas, + as funes podem ser definidas em um arquivo script contendo apenas + definies de funes podem ser "carregadas" no Scilab atravs da + funo <function>exec</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + A seqncia <literal>function + <lhs_arguments>=<function_name><rhs_arguments> + </literal> + no pode ser separada em vrias linhas. Esta seqncia pode ser seguida + por declaraes na mesma linha, se uma vrgula ou ponto-e-vrgula for + adicionado ao seu fim. + </para> + <note> + Note that <literal><function_name></literal> must respect some syntax rules (see <link linkend="names">names</link>). + </note> + <para>Definies de funes podem ser aninhadas.</para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//definio inline +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +//uma definio de funo de uma linha +function y=sq(x),y=x^2,endfunction + +sq(3) + +//definio de funo aninhada +function y=foo(x) +a=sin(x) +function y=sq(x), y=x^2,endfunction +y=sq(a)+1 +endfunction + +foo(%pi/3) + +// definio em um arquivo script (ver exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="functions">functions</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="names">names</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/functions.xml b/modules/functions/help/pt_BR/functions.xml new file mode 100755 index 000000000..65b9b0aba --- /dev/null +++ b/modules/functions/help/pt_BR/functions.xml @@ -0,0 +1,174 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="functions" xml:lang="pt"> + <refnamediv> + <refname>functions</refname> + <refpurpose>procedimentos Scilab e objetos Scilab</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para>Funes so procedimentos Scilab ("macro", "funo" e "procedure" + possuem o mesmo significado). + </para> + </refsection> + <refsection> + <title>Definio de Funo</title> + <para>Geralmente, elas so definidas em arquivos com um edito e carregadas + no Scilab atravs da funo <link linkend="exec">exec</link> ou atravs de + uma biblioteca (ver <link linkend="lib">lib</link> ou <link linkend="genlib">genlib</link>). Mas tambm podem ser definidas on-line + (ver <link linkend="deff">deff</link> ou <link linkend="function">function</link>. Uma funo definida por dois + componentes: + </para> + <itemizedlist> + <listitem> + <para>uma parte "definio de sintaxe" como segue:</para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) +function [y1,...,yn,varargout]=foo(x1,...,xm,varargin) + ]]></programlisting> + </listitem> + <listitem> + <para>uma seqncia de instrues Scilab.</para> + </listitem> + </itemizedlist> + <para>A linha de "definio de sintaxe" fornece a sintaxe de chamamento + "completa" para esta funo. As variveis <literal>yi</literal> so + variveis de sada calculadas em funo das variveis de entrada + <literal>xi</literal> e variveis existentes no Scilab quando a funo + executada. + </para> + </refsection> + <refsection> + <title>Chamada de Funo</title> + <itemizedlist> + <listitem> + <para>A sintaxe de chamamento de funo usual + <literal>[y1,...,yn]=foo(x1,...,xm)</literal>. Listas de argumentos de + entrada ou sada mais curtos que as da definio podem ser usadas. Em + tais casos, apenas as primeiras variveis da esquerda para direita so + usadas ou definidas. + </para> + <para> + A funo <link linkend="argn">argn</link> pode ser utilizada + para se o nmero total real de argumentos de chamada. + </para> + </listitem> + <listitem> + <para> possvel definir funes com nmero mximo indeterminado de + argumentos de entrada ou sada. Isto pode ser feito utilizando-se as + palavras-chave <link linkend="varargin">varargin</link> e <link linkend="varargout">varargout</link> keywords. Veja os links para + detalhes. + </para> + </listitem> + <listitem> + <para>Tambm possvel utilizar "argumentos nomeados" para + especificar argumentos de entrada: suponha que a funo <function>fun1</function> seja + definida como <code>function y1 = fun1(x1, x2, x3)</code>, ento pode ser chamada com uma sintaxe + como <code>y = fun1(x1=33, x3=[1 2 3])</code>. Dentro de + <function>fun1</function> <varname>x2</varname> ser indefinida. + </para> + <para>Tambm pode ser chamada com sintaxe como + <code>y = fun1(x1=33, y='foo')</code>. Em tal caso, a varivel + <varname>y</varname> estar disponvel no contexto da funo + <function>fun1</function>. + <note> + Note que o nmero mximo de argumentos deve + ser menor que ou igual ao nmero de argumentos de entrada fornais + utilizados na parte de sintaxe da funo. + </note> + </para> + <para> possvel buscar por variveis definidas atravs da funo + <link linkend="exists">exists</link>. + </para> + </listitem> + <listitem> + <para>Quando uma funo no possui argumento de lado esquerdo e + chamada apenas com argumentos strings, a sintaxe de chamamento pode + ser simplificada: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun('a','toto','a string') + ]]></programlisting> + <para>is equivalent to:</para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun a toto 'a string' + ]]></programlisting> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Miscelnea</title> + <para>Funes Scilab so objetos (com nmeros de tipo 13 ou 11). Elas + podem ser manipuladas (construdas, salvas, carregadas, passadas como + argumentos,...) como outros tipos de variveis. + </para> + <para>Colees de funes podem ser reunidas em bibliotecas. Funes que + comeam pelo sinal <literal>%</literal> (ex: <literal>%foo</literal>) so + geralmente utilizadas para operaes de sobrecarga (ver <link linkend="overloading">overloading</link>) ou so funes para novos tipos + de dados. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//definio inline (ver function) +function [x,y]=myfct(a,b) + x=a+b + y=a-b +endfunction + +[x,y]=myfct(3,2) + +//definio inline (ver deff) +deff('[x,y]=myfct(a,b)',['x=a+b'; + 'y=a-b']) +// definio em um arquivo ASCI (ver exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="exists">exists</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/getd.xml b/modules/functions/help/pt_BR/getd.xml new file mode 100755 index 000000000..b4bc6962b --- /dev/null +++ b/modules/functions/help/pt_BR/getd.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getd" xml:lang="pt"> + <refnamediv> + <refname>getd</refname> + <refpurpose>retorna todas as funes definidas em um + diretrio + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>getd(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>string Scilab. O endereo do diretrio</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Carrega todos os arquivos <literal>.sci</literal> (contendo funes + Scilab) definidos no diretrio <varname>path</varname>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +getd('SCI/modules/cacsd/macros') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/head_comments.xml b/modules/functions/help/pt_BR/head_comments.xml new file mode 100755 index 000000000..275a4ef2e --- /dev/null +++ b/modules/functions/help/pt_BR/head_comments.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="head_comments" xml:lang="pt"> + <refnamediv> + <refname>head_comments</refname> + <refpurpose>exibe comentrios do cabealho da funo Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>head_comments(name) + head_comments(name,%paths) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para>string, nome da funo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>%paths</term> + <listitem> + <para>vetor de strings, endereos onde se deve procurar o arquivo + sci + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <code>head_comments(name)</code> exibe comentrios do cabealho da + funo (como a ajuda do Matlab). Os comentrios so lidos do arquivo sci + associado. Se <varname>name</varname> for uma funo em uma biblioteca, o + endereo do arquivo sci aquele dado pelo endereo da biblioteca (ver + <link linkend="lib">lib</link>). Se <varname>name</varname> for uma funo que no + est na biblioteca, um arquivo de nome <varname>name</varname><literal>.sci</literal> + procurado nos outros diretrios fornecidos pela varivel + <varname>%paths</varname>. + </para> + <warning> + AVISO: a maior parte das funes Scilab predefinidas no possui comentrios de cabealho. + </warning> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +head_comments sinc + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="help">help</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/CHAPTER b/modules/functions/help/pt_BR/libraries/CHAPTER new file mode 100755 index 000000000..4cd7693b5 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/CHAPTER @@ -0,0 +1,2 @@ +title = Libraries + diff --git a/modules/functions/help/pt_BR/libraries/genlib.xml b/modules/functions/help/pt_BR/libraries/genlib.xml new file mode 100755 index 000000000..43e3f9d72 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/genlib.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="genlib" xml:lang="en"> + <refnamediv> + <refname>genlib</refname> + <refpurpose>constri biblioteca a partir de funes em um + diretrio + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>genlib(lib_name [[,dir_name, [ Force [,verb [,Names]]]]) + genlib(lib_name [,path=dir_name] [,verbose=verb] [,force=Force] [,names=Names]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>lib_name:</term> + <listitem> + <para>string. O nome da varivel biblioteca a ser (re)criada.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>dir_name:</term> + <listitem> + <para>string. O nome do diretrio onde se deve procurar arquivos + <literal>.sci</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Force</term> + <listitem> + <para> + booleano (o padro <literal>%f</literal>). Para forar + recompilao de arquivos .sci, ajuste-o para + <literal>%t</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>verb</term> + <listitem> + <para> + booleano (o padro <literal>%f</literal>). Para obter + informaes ajuste-o para <literal>%t</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Names</term> + <listitem> + <para>vetor de strings, os nomes das funes a serem inclusas na + bibilioteca. Por padro, todos os arquivos sci so levados em + conta. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Para cada arquivo <literal>.sci</literal> em + <literal>dir_name</literal> (ou apenas para aqueles especificados pelo + argumento <literal>Names</literal>), <literal>genlib</literal> executa um + <literal>exec</literal> e salva as funes no arquivo + <literal>.bin</literal> correspondente. O arquivo <literal>.sci</literal> + s pode conter instrues Scilab. Se um arquivo <literal>.bin</literal> + for mais novo que o arquivo <literal>.sci</literal> assicuadi, + <literal>genlib</literal> no traduz nem salva o arquivo. + </para> + <para>O comportamento padro pode ser modificado se + <literal>force</literal> for fornecido e ajustado para + <literal>%t</literal>. Neste ltimo caso, a recompilao sempre feita + para cada arquivo <literal>.sci</literal>. + </para> + <para> + Quando todos os arquivos <literal>.sci</literal> tiverem sido + processados, <literal>genlib</literal> cria uma biblioteca nomeada + <literal>lib_name</literal> e a salva arquivo <literal>lib</literal> em + <literal>dir_name</literal>. Se a varivel Scilab + <literal>lib_name</literal> no estiver protegida (ver <link linkend="predef">predef</link>), esta varivel atualizada. + </para> + <para> + Se <literal>verb</literal> estiver ajustado para + <literal>%t</literal> informaes so exibidas durante o processo de + construo. + </para> + <para> + Seo argumento <literal>dir_name</literal> no for fornecido e se a + varivel Scilab <literal>lib_name</literal> existe e uma varivel + dir_name tomado como sendo igual a o endereo de bibilioteca + <literal>lib_name</literal> (modo de atualizao). + </para> + </refsection> + <refsection> + <title>Restries</title> + <para> + Scilab assume implicitamente que <literal>foo.sci</literal> define + pelo menos uma funo de nome <literal>foo</literal>. Se funes + subsidirias estiverem inlusas, elas so tornadas conhecidas ao Scilab + apenas depois que funo <literal>foo</literal> tiver sido + referencida. + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/get_function_path.xml b/modules/functions/help/pt_BR/libraries/get_function_path.xml new file mode 100755 index 000000000..2740a6853 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/get_function_path.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="get_function_path" xml:lang="en"> + <refnamediv> + <refname>get_function_path</refname> + <refpurpose>retorna o endereo do arquivo fonte de uma funo de + biblioteca + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>path=get_function_path(fun_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>fun_name</term> + <listitem> + <para>string, o nome da funo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>string, o nome absoluto do endereo do arquivo fonte da funo + (.sci) ou []. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Dadi o nome de uma uma funo, get_function_path o nome absoluto do + endereo do arquivo fonte da funo se a funo estiver definida em uma + biblioteca Scilab (ver lib) ou [] se nenhum nome corresponde a uma funo + de biblioteca. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +get_function_path('median') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="string">string</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/lib.xml b/modules/functions/help/pt_BR/libraries/lib.xml new file mode 100755 index 000000000..5228a87a4 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/lib.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="lib" xml:lang="en"> + <refnamediv> + <refname>lib</refname> + <refpurpose>definio de biblioteca</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>xlib = lib('lib-dir')</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>lib-dir</term> + <listitem> + <para>string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <literal>lib-dir</literal> um string definindo um diretrio que + contm arquivos de funes compiladas do Scilab + (<literal>.bin</literal>). + </para> + <para> + Em adio a esses arquivos <literal>lib-dir</literal> deve conter um + arquivo chamado <literal>names</literal>, que contm os nomes das funes + definidas em <literal>lib-dir</literal>. Com sucesso, todas as funes em + <literal>lib-dir</literal> estaro disponveis dentro do Scilab. Elas so + carregadas em demanda quando so chamadas pela primeira vez. + </para> + <para>Arquivos binrios podem ser criados de dentro do Scilab com o + comando <literal>save</literal>. + </para> + <para>As bibliotecas padres do Scilab so definidas utilizando-se + <literal>lib</literal> nos subdiretrios + <literal>SCI/modules/*/macros/*</literal>. + </para> + <para>Uma varivel biblioteca geralmente salva para carregamento + posterior, tanto on-line quanto do arquivo de inicializao especfico do + usurio (ver startup). + </para> + </refsection> + <refsection> + <title>Restries</title> + <para>O Scilab assume tacitamente que cada arquivo xxxx.bin define uma + varivel chamada <literal>xxxx</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//define some variables +function z = myplus(x, y), z = x + y,endfunction +function z = yourplus(x, y), x = x - y,endfunction +A=1:10; + +//create the *.bin files in libdir +libdir=TMPDIR +save(libdir + '/myplus.bin', myplus); +save(libdir + '/yourplus.bin', yourplus); +save(libdir + '/A.bin', A); + +//create the name file +mputl(['myplus';'yourplus';'A'],TMPDIR+'/names'); + +//build the library containing myplus and yourplus +xlib = lib(libdir+'/') + +//erase the variables +clear myplus yourplus A + +//Automatic loading and execution +myplus(1,2) + +A + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="library">library</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="whereis">whereis</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/librarieslist.xml b/modules/functions/help/pt_BR/libraries/librarieslist.xml new file mode 100755 index 000000000..3deb18226 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/librarieslist.xml @@ -0,0 +1,43 @@ +<?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="librarieslist" xml:lang="en"> + <refnamediv> + <refname>librarieslist</refname> + <refpurpose>retorna as bibliotecas do Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>s=librarieslist()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>uma matriz de strings</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Retorna em <literal>s</literal> todas as bibliotecas na pilha + Scilab. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +librarieslist() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="libraryinfo">libraryinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/library.xml b/modules/functions/help/pt_BR/libraries/library.xml new file mode 100755 index 000000000..0a45063c5 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/library.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="library" xml:lang="en"> + <refnamediv> + <refname>library</refname> + <refpurpose>descrio de tipo de dado bibilioteca</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Uma bibilioteca um tipo de dado com nmero 14. Contm um nome de + endereo e um conjunto de nomes. Permite o carregamento automtico de + variveis utilizando o seguinte algoritmo: + </para> + <para>Suponha o usurio Scilab referencie a varivel de nome + <literal>foo</literal>. O Scilab procura primeiro se + <literal>foo</literal> o nome de uma primitiva, ou de uma varivel j + definida. Se na for, procura por <literal>foo</literal> seqencialmente + (a mais nova) em toda a biblioteca definida . + </para> + <para> + Suponha que <literal>foo</literal> pertence ao conjunto de nomes da + biblioteca <literal>xlib</literal>. Ento o Scilab tenta carregar o + arquivo <xlib-path-name>/foo.bin. <xlib-path-name>/foo.bin + deve ter sido criado utilizando-se a funo + <literal>save</literal>. + </para> + <para>Bibliotecas geralmente so utilizadas para colees de funes, mas + tambm podem ser utilizadas para colees de variveis Scilab. + </para> + <para>Se uma funo estiver definida em mais de uma biblioteca, o + algoritmo de busca padro carrega aquela contida na mais nova. possvel + forar o uso de uma biblioteca especfica utilizando a notao de + ponto: + </para> + <para> + <literal>xlib.foo</literal> carrega a varivel + <literal>foo</literal> contida em <literal>xlib</literal>, if + <literal>foo</literal> for uma funo e <literal>xlib.foo(args)</literal> + executa as funes. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +// elemlib uma biblioteca predefinida +elementary_functionlib //exibindo o contedo da biblioteca +A=rand(3,3); +cosm(A) //carregando cosm e executando-o +whos -name cosm // agora, cosm uma varivel +elementary_functionlib.sinm //carregando sinm da biblioteca +elementary_functionlib.cosm(A) //carregando novamente cosm e executando-o + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="save">save</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/libraryinfo.xml b/modules/functions/help/pt_BR/libraries/libraryinfo.xml new file mode 100755 index 000000000..d08229a55 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/libraryinfo.xml @@ -0,0 +1,65 @@ +<?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="libraryinfo" xml:lang="en"> + <refnamediv> + <refname>libraryinfo</refname> + <refpurpose>retorna macros e endereo de uma biblioteca + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>macros = libraryinfo(libraryname) + [macros,path] = libraryinfo(libraryname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>macros</term> + <listitem> + <para>uma matriz de strings (todas as funes principais da + biblioteca) + </para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>um string (endereo da biblioteca)</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>libraryname</term> + <listitem> + <para>string (nome da biblioteca)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Retorna nomes de funes e o endereo de uma biblioteca Scilab. Os + nomes de funes so aqueles que correspondem aos nomes de arquivo + associados .sci ou .bin. Os outros so funes subsidirias. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +[m,p]=libraryinfo('corelib') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="librarieslist">librarieslist</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/libraries/whereis.xml b/modules/functions/help/pt_BR/libraries/whereis.xml new file mode 100755 index 000000000..79bc344f2 --- /dev/null +++ b/modules/functions/help/pt_BR/libraries/whereis.xml @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="whereis" xml:lang="en"> + <refnamediv> + <refname>whereis</refname> + <refpurpose>ome da biblioteca contendo a funo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[librname]=whereis(function-name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Retorna um string correspondente ao nome da biblioteca onde a funo + <literal>function-name</literal>. se encontra. O endereo da biblioteca + retornado digitando-se <literal>"librname"</literal>. + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/listfunctions.xml b/modules/functions/help/pt_BR/listfunctions.xml new file mode 100755 index 000000000..eed04b371 --- /dev/null +++ b/modules/functions/help/pt_BR/listfunctions.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="listfunctions" xml:lang="pt"> + <refnamediv> + <refname>listfunctions</refname> + <refpurpose>propriedades de todas as funes no espao de + trabalho + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>[flist,compiled,profilable,called] = listfunctions([scope])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>scope</term> + <listitem> + <para> + string, <literal>"local"</literal> (padro) ou <literal>"global"</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flist</term> + <listitem> + <para>array de strings, names nomes de todas as variveis funes + especificadas no espao de trabalho + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>compiled</term> + <listitem> + <para>array de booleanos, verdadeiro se o elemento correspondente de + <varname>flist</varname> for do tipo 13 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>profilable</term> + <listitem> + <para>array de booleanos, verdadeiro se o elemento correspondente de + <varname>flist</varname> for do tipo 13, e adicionalmente informaes sobre profiling + forem encontradas no pseudo-cdigo da funo. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>called</term> + <listitem> + <para>array uint32, nmero de vezes que o elemento correspondente de + <varname>flist</varname> foi chamado (no-zero apenas se a funo possuir + profiling) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <itemizedlist> + <listitem> + <para>Esta funo verifica todas as variveis do espao de trabalho + (dadas por <link linkend="who">who</link>) e coleta aquelas de tipo 11 + ou 13; para as ltimas, <code>lst = macr2lst(fun)</code> chamada, de modo a verificar + a entrada para magic profiling ao fim da primeira linha de cdigo, + i.e. <code>lst(5)(1)=="25"</code>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +[flist,compiled,profilable,called] = listfunctions(); +flist(profilable) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="recompilefunction">recompilefunction</link> + </member> + <member> + <link linkend="who">who</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Bibliografia</title> + <para> + <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/macr2lst.xml b/modules/functions/help/pt_BR/macr2lst.xml new file mode 100755 index 000000000..06d681905 --- /dev/null +++ b/modules/functions/help/pt_BR/macr2lst.xml @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="macr2lst" xml:lang="en"> + <refnamediv> + <refname>macr2lst</refname> + <refpurpose>converso de funo para lista</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>lst = macr2lst(function_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para>a function to be converted.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>lst</term> + <listitem> + <para>a list.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Esta primitiva converte uma verso compilada do Scilab + <varname>function_name</varname> em uma lista que codifica a representao + interna da funo (notao polonesa inversa). + </para> + <para>A primeira entrada da lista o nome da funo, as segunda e + terceira so, respectivamente, os vetores das variveis de lado esquerdo e + direito (lhs e rhs). As entradas seguintes so registros de operao + bsica ou listas que contm as estruturas de controle hierrquicas como <literal>if</literal>, <literal>for</literal>, ... + </para> + <para>Registros de operao bsica so descritos por um vetor de strings + cujo primeiro elemento representa cdigo do operador (op code). + </para> + <informaltable border="1"> + <tr> + <td>op codes</td> + <td>significado</td> + <td>parmetros</td> + </tr> + <tr> + <td>"0"</td> + <td>opcode ignorado</td> + <td>nenhum</td> + </tr> + <tr> + <td>"1"</td> + <td>no mais usado</td> + <td/> + </tr> + <tr> + <td>"2"</td> + <td>referncia funo ou varivel</td> + <td>nome da varivel, #rhs, #lhs</td> + </tr> + <tr> + <td>"3"</td> + <td>coloca um string na pilha</td> + <td>um string</td> + </tr> + <tr> + <td>"4"</td> + <td>coloca uma matriz vazia na pilha</td> + <td>nenhum</td> + </tr> + <tr> + <td>"5"</td> + <td>aplica uma operao</td> + <td>cdigo de operao, #rhs,#lhs</td> + </tr> + <tr> + <td>"6"</td> + <td>coloca um nmero na pilha</td> + <td>o nmero</td> + </tr> + <tr> + <td>"12"</td> + <td>comando pause</td> + <td>nenhum</td> + </tr> + <tr> + <td>"13"</td> + <td>comando break</td> + <td>nenhum</td> + </tr> + <tr> + <td>"14"</td> + <td>comando abort</td> + <td>nenhum</td> + </tr> + <tr> + <td>"15"</td> + <td>marca de fim da linha</td> + <td>nenhum</td> + </tr> + <tr> + <td>"17"</td> + <td>comando quit</td> + <td>nenhum</td> + </tr> + <tr> + <td>"18"</td> + <td>varivel nomeada</td> + <td>nome da varivel</td> + </tr> + <tr> + <td>"19"</td> + <td>cria estrutura de ndice recursiva</td> + <td>comprimento do endereo, nmero de ndices finais</td> + </tr> + <tr> + <td>"20"</td> + <td>chamada a funo</td> + <td>nome da funo, #rhs, #lhs</td> + </tr> + <tr> + <td>"23"</td> + <td>cria varivel a partir do nome</td> + <td>nome da varivel</td> + </tr> + <tr> + <td>"24"</td> + <td>coloca uma varivel de tipo 0 na pilha</td> + <td>nenhum</td> + </tr> + <tr> + <td>"25"</td> + <td>registro de perfil</td> + <td>nmero da chamada, gasto de tempo</td> + </tr> + <tr> + <td>"26"</td> + <td>coloca um vetor de strings na pilha</td> + <td>#linhas, #colunas, seqncia de elementos</td> + </tr> + <tr> + <td>"27"</td> + <td>coloca uma referncia a um builtin na pilha</td> + <td>nmero da interface, posio da interface, nome da funo</td> + </tr> + <tr> + <td>"28"</td> + <td>comando continue</td> + <td>nenhum</td> + </tr> + <tr> + <td>"29"</td> + <td>atribuio</td> + <td>#lhs, modo de exibio, (nome da varivel, #rhs)*</td> + </tr> + <tr> + <td>"30"</td> + <td>curto circuito de expresso lgica</td> + <td>tipo, tamanho do salto (jump)</td> + </tr> + <tr> + <td>"31"</td> + <td>comentrio</td> + <td>o comentrio</td> + </tr> + <tr> + <td>"99"</td> + <td>comando return</td> + <td>nenhum</td> + </tr> + <tr> + <td>> "100"</td> + <td>chamada a um builtin (obsoleto)</td> + <td>100*fun, #rhs, #lhs, fin</td> + </tr> + </informaltable> + <para> + A funo <link linkend="fun2string">fun2string</link> pode ser usada + para se gerar o cdigo inicial + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//EXIBIO +function y=foo(x,flag) + if flag then + y=sin(x) + else + y=cos(x) + end +endfunction +L=macr2lst(foo) +fun2string(L) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="macrovar">macrovar</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/macr2tree.xml b/modules/functions/help/pt_BR/macr2tree.xml new file mode 100755 index 000000000..685c76e2d --- /dev/null +++ b/modules/functions/help/pt_BR/macr2tree.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="macr2tree" xml:lang="en"> + <refnamediv> + <refname>macr2tree</refname> + <refpurpose>converso de funo para rvore</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>t=macr2tree(function-name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>function-name</term> + <listitem> + <para>macro do Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>uma "rvore" do Scilab</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Esta primitiva converte uma funo Scilab compilada + <literal>function-name</literal> em uma rvore (tlistas imbricadas) que + codifica a representao interna da funo. Deve ser usada com + <literal>tree2code</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/macro.xml b/modules/functions/help/pt_BR/macro.xml new file mode 100755 index 000000000..fb5f1cf7a --- /dev/null +++ b/modules/functions/help/pt_BR/macro.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="macro" xml:lang="pt"> + <refnamediv> + <refname>macro</refname> + <refpurpose>Procedimento Scilab e objeto Scilab</refpurpose> + </refnamediv> + <refsection> + <title>Descrio</title> + <para>Macros so procedimentos Scilab ("macro", "funo" e "procedimento" + possuem o mesmo significado). Geralmente, eles so definidos em arquivos + com um editor e carregados no Scilab com <function>exec</function> ou + atravs de uma biblioteca. + </para> + <para> + Tambm podem ser definidos on-line (ver <link linkend="deff">deff</link>). Um + arquivo que contm uma macro deve comear como segue: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) + ]]></programlisting> + <para> + Os <literal>yi</literal> so variveis de sada calculadas como + funes de variveis de entrada e variveis existentes no Scilab quando o + macro executado. Um macro pode ser compilado para uma execuo mais + rpida. Colees de macros podem ser armazenadas em bibliotecas. Macros + que comeam pelo smbolo <literal>%</literal> (ex.: + <literal>%foo</literal>) e cujos argumentos so listas so usadas para + executar operaes especficas: por exemplo, + <code>z=%rmr(x,y)</code> equivalente a <code>z=x*y</code> + quando <varname>x</varname> e <varname>z</varname> so racionais (i.e. + <code>x=list('r',n,d,[])</code> com <varname>n</varname> e + <varname>d</varname> polinmios). + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/macrovar.xml b/modules/functions/help/pt_BR/macrovar.xml new file mode 100755 index 000000000..6cecf8cd8 --- /dev/null +++ b/modules/functions/help/pt_BR/macrovar.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="macrovar" xml:lang="pt"> + <refnamediv> + <refname>macrovar</refname> + <refpurpose>variveis de uma funo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>vars = macrovar(function)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>vars</term> + <listitem> + <para>list + <literal>list(in,out,globals,called,locals)</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>function</term> + <listitem> + <para>nome de uma funo</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Retorna em uma lista o conjunto de variveis utilizadas por uma + funo. <varname>vars</varname> uma lista feita de cinco vetores colunas + de strings: + </para> + <simplelist type="inline"> + <member> + <varname>in</varname>: variveis de entrada + (<code>vars(1)</code>); + </member> + <member> + <varname>out</varname>: variveis de sada + (<code>vars(2)</code>); + </member> + <member> + <varname>globals</varname>: variveis globais + (<code>vars(3)</code>); + </member> + <member> + <varname>called</varname>: nomes de funes chamadas + (<code>vars(4)</code>); + </member> + <member> + <varname>locals</varname>: variveis locais + (<code>vars(5)</code>). + </member> + </simplelist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +deff('y=f(x1,x2)','loc=1;y=a*x1+x2-loc') +vars=macrovar(f) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/mode.xml b/modules/functions/help/pt_BR/mode.xml new file mode 100755 index 000000000..fa082b716 --- /dev/null +++ b/modules/functions/help/pt_BR/mode.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mode" xml:lang="en"> + <refnamediv> + <refname>mode</refname> + <refpurpose>seleciona um modo em um arquivo executvel</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>mode(k) + k=mode() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Usado exclusivamente dentro de um arquivo executvel ou uma funo + do Scilab, <literal>mode(k)</literal> permite mudar as informaes + exibidas durante a execuo, dependendo do valor de + <literal>k</literal>: + </para> + <variablelist> + <varlistentry> + <term>k=0</term> + <listitem> + <para>os novos valores de variveis so exibidos, se requeridos (ver + ajuda em semi ou comma). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k=-1</term> + <listitem> + <para>o arquivo executvel ou a funo Scilab roda + "silenciosamente". (este o valor padro para funes do Scilab) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k=1 or k=3</term> + <listitem> + <para>cada linha de instrues ecoada precedida do prompt (se + possvel). Os novos valores de variveis so exibidos, se requerido. + Este o padro para arquivos executveis. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k=7</term> + <listitem> + <para>Os novos valores de variveis so exibidos, se requerido. Cada + linha de instrues ecoada (se possvel) e um prompt (>>) + aparece aps cada linha esperando por um retorno de carro. + </para> + <para>Se o retorno de carro segue o caractere "p", a execuo + pausada (ver <link linkend="pause">pause</link>). + </para> + </listitem> + </varlistentry> + </variablelist> + <para>A exibio de linha desabilitada para funes do Scilab compiladas + (ver comp). Por padro, funes do Scilab so executadas no modo + "silencioso" ("-1"). + </para> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="semicolon">semicolon</link> + </member> + <member> + <link linkend="comma">comma</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/overloading.xml b/modules/functions/help/pt_BR/overloading.xml new file mode 100755 index 000000000..22f333ad3 --- /dev/null +++ b/modules/functions/help/pt_BR/overloading.xml @@ -0,0 +1,489 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="overloading" xml:lang="pt"> + <refnamediv> + <refname>overloading</refname> + <refpurpose>capacidades de overloading ("sobrecarga") de exibições, + funções e operadores + </refpurpose> + </refnamediv> + <refsection> + <title>Descrição</title> + <para>No Scilab, exibições, funções e operadores de variáveis podem ser + definidos para novos objetos utilizando funções (codificadas no Scilab ou + primitivas). + </para> + <variablelist> + <varlistentry> + <term>Exibição (Display)</term> + <listitem> + <para>a exibição de objetos definidos por uma estrutura + <literal>tlist</literal> pode ser sobrecarregada (a exibição padrão + é semelhante a de <literal>list</literal>'s). A função de sobrecarga + não deve ter argumentos de saída e deve ter um único argumento de + entrada. Seu nome é formado como segue: + <literal>%<tlist_type>_p</literal> onde + <literal>%<tlist_type></literal> significa a primeira entrada + do componente do tipo <literal>tlist</literal> truncado aos 9 + primeiros caracteres. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Operadores (Operators)</term> + <listitem> + <para>cada operador que não está definido para dados tipos de + operandos pode ser definido. A função de sobrecarga deve ter um + único argumento de saída e um ou dois de entrada de acordo com o + número de operandos. O nome da função é definido como segue: + </para> + </listitem> + </varlistentry> + </variablelist> + <para>para operadores binários: + <literal>%<tipo_do_primeiro_operando>_<código_do_ + operador>_<tipo_do_segundo_operando> + </literal> + </para> + <para>para operadores unários: + <literal>%<tipo_do_operando>_<código_do_operador></literal> + </para> + <para>Operadores de extração e inserção que são n-nários são descritos + abaixo. + </para> + <warning> + Be careful, only the types registered by the + <function>typename</function> function can be used in an + overloading macros. + </warning> + <para> + <literal><tipo_do_operando></literal>, + <literal><tipo_do_primeiro_operando></literal>, + <literal><tipo_do_segundo_operando></literal> são seqüências de + caracteres associadas a cada tipo de dado como descrito na tabela + seguinte: + </para> + <informaltable border="1"> + <tr> + <td>tipo de dado</td> + <td>código "char"</td> + <td>tipo de dado</td> + <td>código "char"</td> + </tr> + <tr> + <td>constante</td> + <td> + <literal>s</literal> + </td> + <td>booleano</td> + <td> + <literal>b</literal> + </td> + </tr> + <tr> + <td>string</td> + <td> + <literal>c</literal> + </td> + <td>bibilioteca</td> + <td> + <literal>f</literal> + </td> + </tr> + <tr> + <td>ponteiro de função</td> + <td> + <literal>fptr</literal> + </td> + <td>manipulador</td> + <td> + <literal>h</literal> + </td> + </tr> + <tr> + <td>inteiro</td> + <td> + <literal>i</literal> + </td> + <td>lista</td> + <td> + <literal>l</literal> + </td> + </tr> + <tr> + <td>função</td> + <td> + <literal>m</literal> + </td> + <td>função compilada</td> + <td> + <literal>mc</literal> + </td> + </tr> + <tr> + <td>polinômio</td> + <td> + <literal>p</literal> + </td> + <td>esparso</td> + <td> + <literal>sp</literal> + </td> + </tr> + <tr> + <td>esparso booleano</td> + <td> + <literal>spb</literal> + </td> + <td>tlist</td> + <td> + <literal>tlist_type</literal> + </td> + </tr> + <tr> + <td>polinômio de tamanho implícito</td> + <td> + <literal>ip</literal> + </td> + <td>matriz esparsa do Matlab</td> + <td> + <literal>msp</literal> + </td> + </tr> + <tr> + <td>mlist</td> + <td> + <literal>mlist_type</literal> + </td> + <td>ponteiro</td> + <td> + <literal>ptr</literal> + </td> + </tr> + </informaltable> + <para> + <literal><código_do_operador></literal> é um único caractere + associado a cada operador como descrito na tabela seguinte: + </para> + <informaltable border="1"> + <tr> + <td> + <literal>op</literal> + </td> + <td>char code</td> + </tr> + <tr> + <td> + <literal>'</literal> + </td> + <td>t</td> + </tr> + <tr> + <td> + <literal>+</literal> + </td> + <td>a</td> + </tr> + <tr> + <td> + <literal>-</literal> + </td> + <td>s</td> + </tr> + <tr> + <td> + <literal>*</literal> + </td> + <td>m</td> + </tr> + <tr> + <td> + <literal>/</literal> + </td> + <td>r</td> + </tr> + <tr> + <td> + <literal>\</literal> + </td> + <td>l</td> + </tr> + <tr> + <td> + <literal>^</literal> + </td> + <td>p</td> + </tr> + <tr> + <td> + <literal>.*</literal> + </td> + <td>x</td> + </tr> + <tr> + <td> + <literal>./</literal> + </td> + <td>d</td> + </tr> + <tr> + <td> + <literal>.\</literal> + </td> + <td>q</td> + </tr> + <tr> + <td> + <literal>.*.</literal> + </td> + <td>k</td> + </tr> + <tr> + <td> + <literal>./.</literal> + </td> + <td>y</td> + </tr> + <tr> + <td> + <literal>.\.</literal> + </td> + <td>z</td> + </tr> + <tr> + <td> + <literal>:</literal> + </td> + <td>b</td> + </tr> + <tr> + <td> + <literal>*.</literal> + </td> + <td>u</td> + </tr> + <tr> + <td> + <literal>/.</literal> + </td> + <td>v</td> + </tr> + <tr> + <td> + <literal>\.</literal> + </td> + <td>w</td> + </tr> + <tr> + <td> + <literal>[a,b]</literal> + </td> + <td>c</td> + </tr> + <tr> + <td> + <literal>[a;b]</literal> + </td> + <td>f</td> + </tr> + <tr> + <td> + <literal>() extraction</literal> + </td> + <td>e</td> + </tr> + <tr> + <td> + <literal>() insertion</literal> + </td> + <td>i</td> + </tr> + <tr> + <td> + <literal>==</literal> + </td> + <td>o</td> + </tr> + <tr> + <td> + <literal><></literal> + </td> + <td>n</td> + </tr> + <tr> + <td> + <literal>|</literal> + </td> + <td>g</td> + </tr> + <tr> + <td> + <literal>&</literal> + </td> + <td>h</td> + </tr> + <tr> + <td> + <literal>.^</literal> + </td> + <td>j</td> + </tr> + <tr> + <td> + <literal>.'</literal> + </td> + <td>0</td> + </tr> + <tr> + <td> + <literal><</literal> + </td> + <td>1</td> + </tr> + <tr> + <td> + <literal>></literal> + </td> + <td>2</td> + </tr> + <tr> + <td> + <literal><=</literal> + </td> + <td>3</td> + </tr> + <tr> + <td> + <literal>>=</literal> + </td> + <td>4</td> + </tr> + <tr> + <td> + <literal>~</literal> + </td> + <td>5</td> + </tr> + <tr> + <td> + <literal>iext</literal> + </td> + <td>6</td> + </tr> + </informaltable> + <para>A função de sobrecarga para sintaxe de extração + <literal>b=a(i1,...,in)</literal> tem a seguinte seqüência de chamamento: + <literal>b=%<tipo_de_a>_e_(i1,...,in,a)</literal> + </para> + <para> + e a sintaxe<literal>[x1,..,xm]=a(i1,...,in)</literal> tem a seguinte + seqüência de chamamento: + <literal>[x1,..,xm]=%<tipo_de_a>_e_(i1,...,in,a)</literal> + </para> + <para>A função de sobrecarga associada à sintaxe de inserção + <literal>a(i1,...,in)=b</literal> tem a segunite seqüência de + chamamento:<literal> + a=%<tipo_de_b>_i_<tipo_de_a>(i1,...,in,b,a) + </literal> + . + </para> + <para> + O código "char" <literal>6</literal> pode ser usado para alguns + algoritmos de inserção complexos como <code>x.b(2) = 33</code> onde o + campo <literal>b</literal> não está definido na estrutura + <literal>x</literal>. A inserção é automaticamente decomposta em + <literal>temp=x.b;</literal> <code>temp(2) = 33</code>; + <code>x.b = temp</code>. O código "char" <literal>6</literal> é usado + para o primeiro passo desse algoritmo. A função de sobrecarga de + <literal>6</literal> é muito semelhante à função de + <literal>e</literal>'s. + </para> + <variablelist> + <varlistentry> + <term>Funções (Functions)</term> + <listitem> + <para>algumas funções primitivas básicas também podem ser + sobrecarregadas para novos tipo de dados. Quando tal função não é + definida para tipos de dados particulares, a função <literal> + %<tipo_de_um_argumento>_<nome_da_função> + </literal> + é + chamada. O usuário pode adicionar a esta função chamada a definição + associada aos tipos de dados de entrada. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Exemplos</title> + </refsection> + <refsection> + <programlisting role="example">//EXIBIÇÃO + var = tlist('tab', ['a', 'b'], ['x'; 'y'], rand(2, 2)) // the type of var is 'tab' + + typeof(var) + + function [] = %tab_p(l) + disp([[' '; l(3)] [l(2); string(l(4))]]) + endfunction + + var // after overloading + </programlisting> + </refsection> + <refsection> + <programlisting role="example">//OPERADOR + 's' + 1 // it is impossible to add a number to a string + + function x = %c_a_s(a, b) + x = a + string(b); + endfunction + + 's' + 1 // after overloading + </programlisting> + </refsection> + <refsection> + <programlisting role="example">//FUNÇÃO + sin('2 * x') // the sin function does not work with a string + + function x = %c_sin(a) + x = 'sin(' + a + ')' + endfunction + + sin('2 * x') // after overloading + </programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="disp">disp</link> + </member> + <member> + <link linkend="symbols">symbols</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typename">typename</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/add_profiling.xml b/modules/functions/help/pt_BR/profiling/add_profiling.xml new file mode 100755 index 000000000..a59ef4aba --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/add_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="add_profiling" xml:lang="fr"> + <refnamediv> + <refname>add_profiling</refname> + <refpurpose>adiciona instruções de profiling (análise de performance) a + uma função + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>add_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>string, o nome da função</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>add_profiling(funname)</literal> adiciona instruções de + profiling a uma função de nome <literal>funname</literal>. Então, quando + esta função é chamada, o número de chamadas e o tempo gasto é armazenado + para cada linha da função. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //executando a função +profile(foo) //extraindo informação de profile + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Funções Utilizadas</title> + <para> + Esta função utiliza as funções Scilab <literal>bytecode</literal> e + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/plotprofile.xml b/modules/functions/help/pt_BR/profiling/plotprofile.xml new file mode 100755 index 000000000..0fe19ac87 --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/plotprofile.xml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="plotprofile" xml:lang="en"> + <refnamediv> + <refname>plotprofile</refname> + <refpurpose>extrai e exibe execuo de profiles (dossis) de uma funo + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>plotprofile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>funo Scilab compilada, ou nome de funo (string), ou array + de nomes de funes + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Para utilizar <literal>plotprofile</literal>, a funo Scilab deve + ter sido preparada para profiling (anlise de desempenho) (ver + exec). + </para> + <para>Quando tal funo executada, o sistema conta quantas vezes cada + linha foi executada e quanto tempo de cpu foi gasto para cada linha. Estes + dados so armazenados dentro da estrutura de dados da funo. A funo + <literal>plotprofile</literal> um comando interativo que exibe os + resultados em uma janela grfica. Quando uma linha clcada, a fonte da + funo exibida com a linha selecionada realada. + </para> + <para>NOTA: voc deve clicar no item "Exit" na janela de grficos para + sair de "plotprofile". + </para> + <para> + O cdigo da funo gerado com <literal>fun2string</literal> e + guardado em um arquivo temporrio. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//definindo funo e preparando-a para profiling +deff('x=foo(n)',['if n==0 then' + ' x=[]' + 'else' + ' x=0' + ' for k=1:n' + ' s=svd(rand(n+10,n+10))' + ' x=x+s(1)' + ' end' + 'end'],'p') +//chamando a funo +foo(30) +//obtendo profiles de execuo +plotprofile(foo) // clique em Exit para sair + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="showprofile">showprofile</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/profile.xml b/modules/functions/help/pt_BR/profiling/profile.xml new file mode 100755 index 000000000..0a31360cb --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/profile.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="profile" xml:lang="pt"> + <refnamediv> + <refname>profile</refname> + <refpurpose>extrai profiles (dossis) de execuo de uma funo do + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>c=profile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetro</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>funo Scilab</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>uma matriz nx3 contendo os profiles de execuo</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Para utilizar <literal>profile</literal> a funo Scilab deve ter + sido preparada para profiling (anlise de desempenho) (ver exec). + </para> + <para>Pata tal funo, quando tal funo executada, o sistema conta + quantas vezes cada linha foi executada e quanto tempo de cpu foi gasto + para cada execuo da linha. Estes dados so armazenados na estrutura de + dados da funo. A funo profile permite extrair esses dados e + retorn-los nas duas primeiras colunas de <literal>c</literal>. A terceira + coluna de <literal>c</literal> fornece a medida do esforo do + interpretador para a execuo da linha correspondente. A i-sima linha de + <literal>c</literal> corresponde i-sima linha da funo (inclusa + primeiro) + </para> + <para>Note que, devido preciso do clock do processador (tipicamente, um + microssegundo), algumas linhas executadas aparecem com tempo de execuo + 0, mesmo que o tempo de execuo de cpu total realmente gasto seja + grande. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//definindo a funo e preparando-a para profiling +deff('x=foo(n)',['if n==0 then' + ' x=[]' + 'else' + ' x=0' + ' for k=1:n' + ' s=svd(rand(n+10,n+10))' + ' x=x+s(1)' + ' end' + 'end'],'p') +//chamando a funo +foo(10) +//obtendo profiles de execuo +profile(foo) +//chamando a funo +foo(20) +profile(foo) //a execuo de profiles acumulada + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="showprofile">showprofile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/remove_profiling.xml b/modules/functions/help/pt_BR/profiling/remove_profiling.xml new file mode 100755 index 000000000..5ec6ac2f3 --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/remove_profiling.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="remove_profiling" xml:lang="fr"> + <refnamediv> + <refname>remove_profiling</refname> + <refpurpose>remove instruções de profiling (análise de performance) de uma + função + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>remove_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>string, o nome da função</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>remove_profiling(funname)</literal> remove instruções de + profiling (se houver alguma) da função de nome + <literal>funname</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //executando a função +profile(foo) //extraindo informação de profile +remove_profiling("foo") + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">remove_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Funções Utilizadas</title> + <para> + Esta função utiliza as funções Scilab <literal>bytecode</literal> e + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/reset_profiling.xml b/modules/functions/help/pt_BR/profiling/reset_profiling.xml new file mode 100755 index 000000000..1a24e1c02 --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/reset_profiling.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="reset_profiling" xml:lang="fr"> + <refnamediv> + <refname>reset_profiling</refname> + <refpurpose>reinicia contadores de profiling de uma função</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>reset_profiling(funname)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>string, o nome da função</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para> + <literal>reset_profiling(funname)</literal> reinicia contadores de + profiling (se houver) da função de nome <literal>funname</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function x=foo(a,n) + x=0; + for i=1:n + if x<10 then + x=x+a + else + x=x+1 + end + end + x=x^2+1 +endfunction + +add_profiling("foo") +foo(0.1,100) //executando a função +profile(foo) //extraindo informação de profile +reset_profiling("foo") +profile(foo) //extraindo informação de profile + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="reset_profiling">reset_profiling</link> + </member> + <member> + <link linkend="remove_profiling">remove_profiling</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Funções Utilizadas</title> + <para> + Esta função utiliza as funções Scilab <literal>bytecode</literal> e + <literal>walkbytecode</literal> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/profiling/showprofile.xml b/modules/functions/help/pt_BR/profiling/showprofile.xml new file mode 100755 index 000000000..4af7778e5 --- /dev/null +++ b/modules/functions/help/pt_BR/profiling/showprofile.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="showprofile" xml:lang="en"> + <refnamediv> + <refname>showprofile</refname> + <refpurpose>extrai e exibe profiles (dossis) de execuo de uma funo + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>showprofile(fun)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para>funo Scilab</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Para utilizar <literal>showprofile</literal> a funo Scilab deve + ter sido preparada para profiling (anlise de performance) (ver + exec). + </para> + <para>Para tal funo,Quando tal funo executada, o sistema conta + quantas nmero de vezes que cada linha executada e quanto tempo de cpu + gasto para execuo de cada linha. Estes dados so armazenados dentro da + estrutura de dados da funo. A funo <literal>showprofile</literal> + retorna resultados de profiling (ver <literal>profile</literal>) com o + texto das linhas da funo. + </para> + <para>O texto da funo reconstrudo com + <literal>fun2string</literal>. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +//definindo funo e preparando-a para profiling +deff('x=foo(n)',['if n==0 then' + ' x=[]' + 'else' + ' x=0' + ' for k=1:n' + ' s=svd(rand(n+10,n+10))' + ' x=x+s(1)' + ' end' + 'end'],'p') +//chamada funo +foo(30) +//obtendo profiles +showprofile(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="plotprofile">plotprofile</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/recompilefunction.xml b/modules/functions/help/pt_BR/recompilefunction.xml new file mode 100755 index 000000000..4c35128c8 --- /dev/null +++ b/modules/functions/help/pt_BR/recompilefunction.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="recompilefunction" xml:lang="en"> + <refnamediv> + <refname>recompilefunction</refname> + <refpurpose>recompila uma funo Scilab modificando o seu + tipo + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>recompilefunction(funname [,kind [,force]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>funname</term> + <listitem> + <para>string, nome da funo a ser recompilada</para> + </listitem> + </varlistentry> + <varlistentry> + <term>kind</term> + <listitem> + <para> + string: <emphasis role="bold">"n"</emphasis> (no compilado, + tipo 11), <emphasis role="bold">"c"</emphasis> (compilado, tipo 13) + or <emphasis role="bold">"p"</emphasis> (compilado, tipo 13, + preparado para profiling). Pardro: "c". + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>force</term> + <listitem> + <para>booleano. Se falso, a funo recompilada apenas se seu tipo + mudar; se verdadeiro, recompilada ainda que mantenha o tipo + (notavelmente til para compilar uma funo "p" function, para + reiniciar as estatsticas de profiling). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <itemizedlist> + <listitem> + <para> + Esta funo compila reversamente uma varivel funo via <link linkend="fun2string">fun2string</link>, e a recompila para o tipo + desejado atravs de <link linkend="deff">deff</link>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +for i=1:100; asinh(rand(100,100)); end +showprofile(asinh) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Bibliografia</title> + <para> + <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/sciargs.xml b/modules/functions/help/pt_BR/sciargs.xml new file mode 100755 index 000000000..21aedc18d --- /dev/null +++ b/modules/functions/help/pt_BR/sciargs.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="sciargs" xml:lang="en"> + <refnamediv> + <refname>sciargs</refname> + <refpurpose>scilab command line arguments</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>args=sciargs()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Descrio</title> + <para>Esta funo retorna um vetor de strings contendo os argumentos da + linha de comando do Scilab. As primeiras entradas de + <literal>args</literal> contm o endereo do arquivo executvel + rodado. + </para> + <para> + Esta funo corresponde a <literal>getarg</literal> na linguagem + C. + </para> + </refsection> + <refsection> + <title> Ver Tambm </title> + <simplelist type="inline"> + <member> + <link linkend="getenv">getenv</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/tree2code.xml b/modules/functions/help/pt_BR/tree2code.xml new file mode 100755 index 000000000..510803925 --- /dev/null +++ b/modules/functions/help/pt_BR/tree2code.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="tree2code" xml:lang="pt"> + <refnamediv> + <refname>tree2code</refname> + <refpurpose>gera a definio ASCII de uma funo Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>txt = tree2code(tree, prettyprint)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>tree</term> + <listitem> + <para> + uma rvore macro (vinda de <function>macr2tree</function>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>prettyprint</term> + <listitem> + <para>valor opcional booleano</para> + <variablelist> + <varlistentry> + <term>%T</term> + <listitem> + <para>o cdigo gerado identado e embelezado</para> + </listitem> + </varlistentry> + <varlistentry> + <term>%F</term> + <listitem> + <para>o cdigo gerado no embelezado (padro)</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>um vetor coluna de strings, o texto fornecendo as instrues + Scilab + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + Dada uma funo Scilab carregada "tree" (retornada por <function>macr2tree</function>), + <function>tree2code</function> permite gerar novamente o cdigo. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/varargin.xml b/modules/functions/help/pt_BR/varargin.xml new file mode 100755 index 000000000..5ca92cdb1 --- /dev/null +++ b/modules/functions/help/pt_BR/varargin.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargin" xml:lang="pt"> + <refnamediv> + <refname>varargin</refname> + <refpurpose>variável do número de argumentos de saída em uma lista de + argumentos de entrada + </refpurpose> + </refnamediv> + <refsection> + <title>Descrição</title> + <para>Uma função cujo último argumento de entrada é + <literal>varargin</literal> pode ser chamada com mais argumentos de + entrada que os indicados pela lista de argumentos de entrada. Os + argumentos de chamada passados da palavra-chave + <literal>varargin</literal> em diante podem ser recuperados em uma lista + chamada <literal>varargin</literal>. + </para> + <para> + Suponha que a palavra-chave <literal>varargin</literal> é o n-ésimo + argumento da lista de argumentos de entrada formal, então, se a função é + chamada com <literal>n-1</literal> argumentos de entrada, a lista + <literal>varargin</literal> não é definida. Se a função for chamada com + <literal>n-1</literal> argumentos, então <literal>varargin</literal> é uma + lista vazia + </para> + <para> + <literal>function y= ex(varargin)</literal> pode ser chamada com + qualquer número de argumentos de entrada. Dentro da função + <literal>ex</literal> argumentos de entrada podem ser recuperados em + <literal>varargin(i)</literal>, <literal>i=1:length(varargin)</literal> + </para> + <para>Se não for o último argumento de entrada da função, + <literal>varargin</literal> é um argumento de entrada normal, sem nenhum + significado especial. + </para> + <para> + O número de argumentos de entrada real é dado por <code>argn(2)</code>. + </para> + </refsection> + <refsection> + <title>Observações</title> + <para> + Sintaxe de argumento nomeada, como <literal>foo(...,key=value)</literal>, é incompatível com o uso de <literal>varargin</literal>. A razão é que os nomes + (i.e. keys) associados aos valores value não são armazenados na lista + <literal>varargin</literal>. Considere por exemplo: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +function foo(varargin) + disp([varargin(1),varargin(2)]) +endfunction + ]]></programlisting> + <screen> + -->foo(a=1,b=2) + + 1. 2. + + -->foo(b=1,a=2) + + 1. 2. + </screen> + <para>O resultado é o mesmo, mas os argumentos foram invertidos.</para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function exampl(a,varargin) + [lhs,rhs]=argn(0) + if rhs>=1 then + disp(varargin) + end +endfunction + +exampl(1) +exampl() +exampl(1,2,3) +l=list('a',%s,%t); +exampl(1,l(2:3)) +]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/pt_BR/varargout.xml b/modules/functions/help/pt_BR/varargout.xml new file mode 100755 index 000000000..4a10632a2 --- /dev/null +++ b/modules/functions/help/pt_BR/varargout.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargout" xml:lang="en"> + <refnamediv> + <refname>varargout</refname> + <refpurpose>variável do número de argumentos de saída em uma lista de + argumentos de saída + </refpurpose> + </refnamediv> + <refsection> + <title>Descrição</title> + <para>Uma função cuja lista de argumentos de saída contém + <literal>varargout</literal> deve ser chamada com mais argumentos de saída + que indicado na lista de argumentos de saída. A chamada de argumentos + passados da palavra-chave <literal>varargout</literal> em diante são + extraídos da lista <literal>varargout</literal> definida na função. + </para> + <para> + <literal>varargout = function ex()</literal> pode ser chamado com + qualquer número de argumentos de saída. Dentro da função + <literal>ex</literal>, argumentos de saída podem ser armazenados em + <literal>varargout(i)</literal>. + </para> + <para> + <literal>[X1,...,Xn,varargout] = function ex()</literal> também pode + ser usado. Neste caso, as variáveis <literal>Xi</literal> devem estar + atribuídas na função tanto quanto <literal>varargout(i)</literal>. + </para> + <para> + O número total real de argumentos de saída é dado por <code>argn(1)</code> + </para> + </refsection> + <refsection> + <title>Observação</title> + <para> + A variável <literal>varargout</literal> deve ser criada dentro de + uma função e atribuída a uma <link linkend="list">list</link>. Se + <literal>varargout</literal> for a única variável de saída formal, a lista deve conter pelo + menos uma entrada. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +function varargout=exampl() + varargout=list(1,2,3,4) +endfunction + +x=exampl() +[x,y]=exampl() +[x,y,z]=exampl() + +function [a,b,varargout]=exampl1() + a='first' + b='second' + varargout=list(1,2,3,4) +endfunction + +exampl1() +[a,b]=exampl1() +[a,b,c]=exampl1() + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/addchapter.sce b/modules/functions/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..7e06fc05b --- /dev/null +++ b/modules/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/functions/help/ru_RU",%T); + diff --git a/modules/functions/help/ru_RU/argn.xml b/modules/functions/help/ru_RU/argn.xml new file mode 100755 index 000000000..fee66e2e6 --- /dev/null +++ b/modules/functions/help/ru_RU/argn.xml @@ -0,0 +1,49 @@ +<?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="argn"> + <refnamediv> + <refname>argn</refname> + <refpurpose>Возвращает количество входных/выходных аргументов в вызове функции</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[lhs [,rhs] ]=argn() + lhs=argn(1) + rhs=argn(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + Эта функция используется внутри определения функции. Она даёт количество фактических входных + аргументов (<literal>rhs</literal>) и выходных аргументов (<literal>lhs</literal>), + переданных в функцию при её вызове. Она обычно используется в определениях функции для работы + с необязательными аргументами. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +function concat=myOwnFunction(name,optional) + [lhs,rhs]=argn(0) + if rhs <= 1 then + optional="my Optional value" + end + if rhs == 0 then + error("Ожидался по меньшей мере один аргумент") + end + concat=name+" "+optional +endfunction + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/CHAPTER b/modules/functions/help/ru_RU/built_in/CHAPTER new file mode 100755 index 000000000..06861307a --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/CHAPTER @@ -0,0 +1,2 @@ +title = Встроенные и внешние + diff --git a/modules/functions/help/ru_RU/built_in/clearfun.xml b/modules/functions/help/ru_RU/built_in/clearfun.xml new file mode 100755 index 000000000..70fda7b78 --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/clearfun.xml @@ -0,0 +1,50 @@ +<?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="clearfun"> + <refnamediv> + <refname>clearfun</refname> + <refpurpose>удаляет примитивы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>ret=clearfun('name')</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>'name'</term> + <listitem> + <para>имя примитива</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ret</term> + <listitem> + <para>логическое значение</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <literal>clearfun('name')</literal> удаляет примитив с именем <literal>'name'</literal> + из набора примитивов (встроенных функций)from the set of + primitives (built-in functions). <literal>clearfun</literal> возвращает + <literal>%t</literal> или <literal>%f</literal>. Эта функция позволяет переименовывать + примитивы: примитивы Scilab'а могут быть заменены функцией, определённой пользователем. + Для экспертов... + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="funptr">funptr</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/external.xml b/modules/functions/help/ru_RU/built_in/external.xml new file mode 100755 index 000000000..eff7d19de --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/external.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="external"> + <refnamediv> + <refname>external</refname> + <refpurpose>объект Scilab'а, внешняя функция или подпрограмма</refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Внешняя функция или подпрограмма для использования со специальными командами. + </para> + <para> + "external" -- это функция или подпрограмма, которая используется в качестве + аргумента некоторых примитивов высокого уровня (таких как <literal>ode</literal>, + <literal>optim</literal>, <literal>schur</literal>...). + </para> + <para> + Последовательность вызова внешней функции или подпрограммы предписывается + примитивом высокого уровня, который устанавливает аргументы данной внешней + функции или подпрограммы. + </para> + <para> + Например, внешняя функция <literal>costfunc</literal> является аргументом примитива + <literal>optim</literal> (примитив оптимизации высокого уровня). Её последовательность + вызова должна быть: + <literal>[f,g,ind]=costfunc(x,ind)</literal> и + <literal>optim</literal> вызывается следующим образом: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +optim(costfunc,...) + ]]></programlisting> + <para> + Здесь <literal>costfunc</literal> (функция цены должна быть минимизирована примитивом + <literal>optim</literal>) вычисляет <literal>f=f(x)</literal> и <literal>g</literal> -- + градиент <literal>f</literal> в <literal>x</literal> (<literal>ind</literal> -- целое + число. Его использование уточняется в справке по <literal>optim</literal>). + </para> + <para> + Если необходимы другие значения для внешней функции, то эти переменные могут быть + определены в её окружении. Также они могут быть вложены в список. Например, + внешняя функция: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +[f,g,ind]=costfunc(x,ind,a,b,c) + ]]></programlisting> + <para> + является корректной для <literal>optim</literal>, если внешняя функция является списком + <literal>list(costfunc,a,b,c)</literal> и тогда вызов <literal>optim</literal>: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +optim(list(costfunc,a1,b1,c1),.... + ]]></programlisting> + <para> + Внешняя подпрограмма может быть процедурой Fortran или C: это удобно для быстрых вычислений. + </para> + <para> + Имя подпрограммы указывается примитиву высокого уровня в виде символьной строки. + Последовательность подпрограммы также предписывается. + </para> + <para> + Внешние процедуры Fortran или C могут быть также динамически связаны (см. + <literal>link</literal>). + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="ode">ode</link> + </member> + <member> + <link linkend="optim">optim</link> + </member> + <member> + <link linkend="impl">impl</link> + </member> + <member> + <link linkend="dassl">dassl</link> + </member> + <member> + <link linkend="intg">intg</link> + </member> + <member> + <link linkend="schur">schur</link> + </member> + <member> + <link linkend="gschur">gschur</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/funptr.xml b/modules/functions/help/ru_RU/built_in/funptr.xml new file mode 100755 index 000000000..057b741c4 --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/funptr.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="ru" xml:id="funptr"> + <refnamediv> + <refname>funptr</refname> + <refpurpose>кодирование примитивов (для экспертов) </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[numptr] = funptr(name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para>строка, имя примитива</para> + </listitem> + </varlistentry> + <varlistentry> + <term>numptr</term> + <listitem> + <para>число внутренней подпрограммы примитива</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Специальная функция (только для экспертов) для получения числа внутренней подпрограммы + <literal>numptr</literal> примитива с именем <literal>'name'</literal>. + <literal>numptr</literal> формируется из числа интерфейса <literal>fun</literal> + и числа подпрограммы <literal>fin</literal> примитива в его интерфейсе как + <literal>numptr = 1000*fun + fin</literal> (fin < 1000). Из <literal>numptr</literal> + можно получить число интерфейса <literal>fun = floor(numptr/1000)</literal>, которое может + быть полезным для связи динамического интерфейса с аргументами, переданными по ссылке + (см. раздел "Примеры"). + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// Предположим, что вы хотите загрузить некоторые коды через +// предлагаемые средства динамической загрузки с помощью addinter. +// По умолчанию аргументы передаются по значению, но вы можете захотеть +// передавать их по ссылки, для чего нужно сделать следующее +// (name - это scilab-имя одной из подпрограмм в интерфейсе): +// +// addinter(files,spnames,fcts) // аргументы передаются по значению +// num_interface = floor(funptr(name)/1000) +// intppty(num_interface) // теперь аргументы передаются по ссылке +// +// Заметьте, что, если вы введете следующее +// +// intppty() +// +// то вы увидите все интерфейсы, работающие по ссылке + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + <member> + <link linkend="newfun">newfun</link> + </member> + <member> + <link linkend="intppty">intppty</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/intppty.xml b/modules/functions/help/ru_RU/built_in/intppty.xml new file mode 100755 index 000000000..71471786c --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/intppty.xml @@ -0,0 +1,93 @@ +<?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="intppty"> + <refnamediv> + <refname>intppty</refname> + <refpurpose>установка свойств передачи аргумента интерфейса</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>funs=intppty() + intppty(fun) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para> + целое число, номер интерфейса (see <link linkend="funptr">funptr</link>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>funs</term> + <listitem> + <para> + вектор целых чисел, вектор номеров интерфейса (see <link linkend="funptr">funptr</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Программы интерфейса могут быть написаны двумя различными способами для + режима передачи аргументов функции. + </para> + <para> + В первом способе (этот способ используется по умолчанию) аргументы + передаются по значению. Через следующий синтаксис: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + аргумент, связанный с <literal>A</literal>, будет передан по значению (копия + <literal>A</literal> делается до того, как вызывается <literal>foo</literal>), и + аргумент, связанный с <literal>1+2</literal> будет передан по значению. + </para> + <para> + В втором способе аргументы могут быть переданы по ссылке, если есть "именованные аргументы" + (копия значений переменных не делается). <literal>intppty(fun)</literal> с + <literal>fun>0</literal> говорит Scilab'у, что интерфейс с номером <literal>fun</literal> + может обрабатывать аргументы, переданные по ссылке. Через следующий интерфейс: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +foo(A,1+2) + ]]></programlisting> + <para> + аргумент, связанный с <literal>A</literal>, будет передан по ссылке, а + аргумент, связанный с <literal>1+2</literal>, будет передан по значению. + </para> + <para> + Внимание! Заявление, что интерфейс с номером <literal>fun</literal> + может обрабатывать аргументы, переданные по ссылке, в случае, если это + не так, может привести к непредсказуемым результатам. + </para> + <para> + <literal>intppty(fun)</literal> с <literal>fun<0</literal> подавляет + это свойство для интерфейса <literal>-fun</literal>. + </para> + <para> + <literal>intppty()</literal> возвращает вектор интерфейсов, который обрабатывают аргументы по ссылке. + </para> + <para> + Эта функция может быть полезна для динамически загружаемого интерфейса + (см. <link linkend="addinter">addinter</link>). + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="funptr">funptr</link> + </member> + <member> + <link linkend="addinter">addinter</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/newfun.xml b/modules/functions/help/ru_RU/built_in/newfun.xml new file mode 100755 index 000000000..40ac83f59 --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/newfun.xml @@ -0,0 +1,89 @@ +<?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: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="newfun" xml:lang="ru"> + <refnamediv> + <refname>newfun</refname> + <refpurpose>добавление имени в таблицу функций</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>newfun(function_name, function_ptr)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para> + символьная строка, указывающая корректное имя функции + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>function_ptr</term> + <listitem> + <para> + положительное целое число (см. ниже) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Специальная функция (только для экспертов). + </para> + <para> + Добавляет имя<literal>function_name</literal> в таблицу функций, известных интерпретатору. + </para> + <para> + <literal>function_ptr</literal> целое число <literal>1000*fun+fin</literal>, где + <literal>fun</literal> и <literal>fin</literal> являются внутренним кодом примитива + <literal>function_name</literal>. + </para> + <para> + Эта функция может быть полезная для связи примитива со шлюзом, вызываемым в + <literal>"gw_user.c"</literal> (<literal>fun=14</literal>). Тем не менее, заметьте, что + функция <link linkend="ilib_build">ilib_build</link> является более лёгким способом расширить + Scilab новыми функциями, основанными на программном коде C, C++ или Fortran. + </para> + <para> + Эта функция также может быть использована для добавления псевдонимов или для того, чтобы переименовать существующие функции-примитивы. + </para> + <para> + Используя вместе с <literal>funptr</literal> и <literal>clearfun</literal> можно добавить + псевдоним или переименовать существующую функцию-примитив. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + absptr=funptr("abs");// получить function_ptr, связанный с функцией abs + newfun("abs_bis",absptr) // создать псевдоним функции abs + abs_bis(-1+%i) + clearfun("abs") // удалить abs, как известную функцию + + //переопределить abs + function y=abs(x) + y=abs_bis(real(x)); + endfunction + + abs(-1+%i) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="clearfun">clearfun</link> + </member> + <member> + <link linkend="funptr">funptr</link> + </member> + <member> + <link linkend="ilib_build">ilib_build</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/readgateway.xml b/modules/functions/help/ru_RU/built_in/readgateway.xml new file mode 100755 index 000000000..3c6ea5612 --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/readgateway.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="readgateway" xml:lang="ru"> + <refnamediv> + <refname>readgateway</refname> + <refpurpose>получение списка примитивов модуля</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + readgateway(module_name) + primitives = readgateway(module_name); + [primitives,primitivesID] = readgateway(module_name); + [primitives,primitivesID,gatewayID] = readgateway(module_name); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>module_name</term> + <listitem> + <para>строка</para> + </listitem> + </varlistentry> + <varlistentry> + <term>primitives, primitivesID, gatewayID</term> + <listitem> + <para>матрицы строк</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <literal>readgateway(module_name)</literal> возвращает список переменных модуля + <literal>module_name</literal>. + </para> + <para> + <literal>primitives</literal>: список примитивов модуля <literal>module_name</literal>. + </para> + <para> + <literal>primitivesID</literal>: список идентификаторов примитивов. + </para> + <para> + <literal>gatewayID</literal>: список идентификаторов шлюзов, связанных с модулем + <literal>module_name</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[primitives,primitivesID,gatewayID] = readgateway('core'); +primitives(1) // примитив 'debug' +primitivesID(1) // идентификатор примитива 'debug' в шлюзе 'core' +gatewayID(1) // идентификатор шлюза 'core' в Scilab + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getmodules">getmodules</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/built_in/what.xml b/modules/functions/help/ru_RU/built_in/what.xml new file mode 100755 index 000000000..6c8be9f5d --- /dev/null +++ b/modules/functions/help/ru_RU/built_in/what.xml @@ -0,0 +1,20 @@ +<?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="what"> + <refnamediv> + <refname>what</refname> + <refpurpose> + список примитивов Scilab'а + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + what() + [primitives,commands]=what(); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para>Список низкоуровневых примитивов и команд.</para> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/bytecode.xml b/modules/functions/help/ru_RU/bytecode.xml new file mode 100755 index 000000000..2ca37b9b5 --- /dev/null +++ b/modules/functions/help/ru_RU/bytecode.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) ????-2008 - INRIA Serge Steer + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + *--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="bytecode"> + <refnamediv> + <refname>bytecode</refname> + <refpurpose> + возвращает "байт-код" указанной функции в виде Scilab-массива и наоборот. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + x = bytecode(f) + f = bytecode(x) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>f</term> + <listitem> + <para> + Scilab-функция. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + вектор-строка значений типа int32 + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>x = bytecode(f)</code> возвращает "байт-код" функции + <varname>f</varname> в виде целочисленного массива + <varname>x</varname>. + </para> + <para> + <code>f= bytecode(x)</code> возвращает в <varname>f</varname> + функцию, связанную с "байт-кодом", заданным в целочисленном + массиве <varname>x</varname>. + <warning> + Внимание: корректность <varname>x</varname> не проверяется. + </warning> + </para> + </refsection> + <refsection> + <title>Примечание</title> + <para> + Байт-код Scilab-функции будет в будущем значительно преобразован, поэтому использование этой функции должно быть ограничено обработкой инструкций профилирования. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +function a=foo(),a=sin(3),endfunction +bytecode(foo) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="bytecodewalk">bytecodewalk</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/code2str.xml b/modules/functions/help/ru_RU/code2str.xml new file mode 100755 index 000000000..407b3a28b --- /dev/null +++ b/modules/functions/help/ru_RU/code2str.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) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="code2str" xml:lang="ru"> + <refnamediv> + <refname>code2str</refname> + <refpurpose> + возвращает символьную строку, связанную с целочисленными + Scilab-кодами. + <emphasis role="bold">Эта функция устарела.</emphasis> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>str = code2str(c)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>str</term> + <listitem> + <para>символьная строка.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>вектор целочисленных кодов символов.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>str = code2str(c)</code> возвращает символьную строку, + связанную с целочисленными Scilab-кодами. + <varname>str</varname> такая, что <literal>c(i)</literal> + является целочисленным Scilab-кодом символа + <literal>part(str,i)</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +code2str([-28 12 18 21 10 11]) +str2code('Scilab')' + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="str2code">str2code</link> + </member> + <member> + <link linkend="ascii">ascii</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>This function will be removed in Scilab 6.0.0</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/comp.xml b/modules/functions/help/ru_RU/comp.xml new file mode 100755 index 000000000..9af7788b9 --- /dev/null +++ b/modules/functions/help/ru_RU/comp.xml @@ -0,0 +1,79 @@ +<?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: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="comp" xml:lang="ru"> + <refnamediv> + <refname>comp</refname> + <refpurpose>компиляция scilab-функции</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>comp(function [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>function</term> + <listitem> + <para>некомпилированная scilab-функция (тип 11)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>флаг со значениями 0 (по умолчанию), 1 или 2</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <literal>comp(function)</literal> компилирует функцию + <literal>function</literal>. Компилированные и интерпретируемые функции + эквивалентны, но обычно компилированные функции гораздо быстрее. Функции, + предоставленные в стандартных библиотеках, являются компилированными. + </para> + <para> + Определение в реальном времени, как и краткий синтаксис команд + <literal>exec</literal> и <literal>deff</literal> генерирует компилированные + функции. Так что <literal>comp</literal> используется в исключительных случаях. + Чтобы сделать некомпилированные функции нужно использовать <link linkend="exec">exec</link> + или <link linkend="deff">deff</link> с опцией <literal>"n"</literal>. + </para> + <para> + Значение <literal>opt==2</literal> приводит к тому, что функция компилируется "для + профилирования". Заметьте, что сейчас можно добавлять инструкции профилирования после компиляции, используя функцию <link linkend="add_profiling">add_profiling</link>. + </para> + <para> + Устаревшая опция <literal>opt==1</literal> была специально в целях анализа кода, а сейчас + игнорируется, т. е. обрабатывается как <literal>opt==0</literal>. + </para> + <para> + Примечание: компиляция работает "на месте", т.е. исходная функция модифицируется, но никакого + нового объекта не создаётся. + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="add_profiling">add_profiling</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/deff.xml b/modules/functions/help/ru_RU/deff.xml new file mode 100755 index 000000000..dfc880298 --- /dev/null +++ b/modules/functions/help/ru_RU/deff.xml @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="deff"> + <refnamediv> + <refname>deff</refname> + <refpurpose> + определение функции во время выполнения программы + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>deff('[s1, s2, ...] = newfunction(e1, e2, ...)',text [,opt])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>e1, e2, ...</term> + <listitem> + <para>входные переменные.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s1, s2, ...</term> + <listitem> + <para>выходные переменные.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para>матрица символьных строк.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>opt</term> + <listitem> + <para>необязательная символьная строка:</para> + <variablelist> + <varlistentry> + <term>'c'</term> + <listitem> + <para> + функция "скомпилирована" для большей производительности (по умолчанию); + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>'p'</term> + <listitem> + <para> + функция "скомпилирована" и подготовлена к профилированию (см. справку <link linkend="profile">profile</link>); + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>'n'</term> + <listitem> + <para> + функция не "скомпилирована". + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>deff</function> может быть использована + для определения функций из ряда инструкций, написанных в + текстовых строках. Полученный объект функции имеет те же + свойства, что и любая другая функция, определённая в + текстовом файле и загруженная с помощью функции + <function>exec</function>. + </para> + <para> + Кавычки в инструкциях (разделяющие строки или означающие + транспонирование матрицы) должны быть удвоены для правильной + интерпретации (см. справку <link linkend="quote">кавычки</link>). Это может сделать написание + несколько неудобным. Как вариант, в таких случаях можно + определять функции в файлах, как обычно, для загрузки их в + Scilab с помощью функции <function>exec</function> (с опцией + <literal>'n'</literal>) и можно использовать функцию + <function>sci2exp</function> для получения распечатки + соответствующих инструкций в функции <function>deff</function>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +deff('[x]=myplus(y,z)','x=y+z') +deff('[x]=mymacro(y,z)',['a=3*y+1'; 'x=a*z+y']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="quote">кавычка</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/edit.xml b/modules/functions/help/ru_RU/edit.xml new file mode 100755 index 000000000..286172659 --- /dev/null +++ b/modules/functions/help/ru_RU/edit.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="edit" xml:lang="ru"> + <refnamediv> + <refname>edit</refname> + <refpurpose>функция редактирования</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>edit(functionname[,linenumber])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>functionname</term> + <listitem> + <para>имя функции, символьная строка</para> + </listitem> + </varlistentry> + <varlistentry> + <term>linenumber</term> + <listitem> + <para>номер строки, целое число</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Если <literal>functionname</literal> является именем определённой Scilab-функции, + то <literal>edit(functionname)</literal> пытается открыть соответствующий файл + <literal>functionname.sci</literal>. + </para> + <para> + Если <literal>functionname</literal> является именем неопределённой Scilab-функции, то + <literal>edit(functionname)</literal> создаёт файл <literal>functionname.sci</literal> в + текущей директории. + </para> + <para> + Если <literal>functionname</literal> является некорректным макросом или функцией, то + <literal>edit(functionname)</literal> открывает файл с именем + <literal>functionname</literal>. + </para> + <para> + Если задан номер строки <literal>linenumber</literal>, то файл открывается на этой строке относительно определения макроса с тем же именем, что и файл. Если определение макроса не найдено, то файл открывается на строке с номером <literal>linenumber</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +//открыть редактор с текстом этой функции +edit('edit') + +//открыть редактор для новой функции +edit('myfunction') + +//открыть файл bar.sci в директории TMPDIR +edit(fullfile(TMPDIR+'bar.sci')) + +// открыть файл test_run.sci на строке 123 +// относительно определения test_run() +edit('test_run', 123) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="manedit">manedit</link> + </member> + <member> + <link linkend="names">имена</link> + </member> + <member> + <link linkend="editor">editor</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/exec.xml b/modules/functions/help/ru_RU/exec.xml new file mode 100755 index 000000000..08388de9b --- /dev/null +++ b/modules/functions/help/ru_RU/exec.xml @@ -0,0 +1,191 @@ +<?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="exec"> + <refnamediv> + <refname>exec</refname> + <refpurpose>исполнение файла-сценария</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>exec(path [,mode]) + exec(fun [,mode]) + ierr = exec(path, 'errcatch' [,mode]) + ierr = exec(fun, 'errcatch' [,mode]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + строка, путь к файлу-сценарию. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para> + целочисленный скаляр, режим исполнения (см. ниже). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fun</term> + <listitem> + <para>Scilab-функция.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>целое число, 0 либо номер ошибки.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>exec(path [,mode])</code> исполняет последовательно + Scilab-инструкции, содержащиеся в файле, указанном в пути + <varname>path</varname>, в режиме исполнения, указанным + необязательным аргументом <varname>mode</varname>. + </para> + <para> + Режим исполнения <varname>mode</varname> имеет следующие + значения: + </para> + <variablelist> + <varlistentry> + <term>0</term> + <listitem> + <para> + значение по умолчанию. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>-1</term> + <listitem> + <para> + вывод на экран не производится. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>1</term> + <listitem> + <para> + отображает каждую командную строку. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>2</term> + <listitem> + <para> + на экран выводится строка приглашения <literal>--></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>3</term> + <listitem> + <para> + отображения командных строк + строки приглашения. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>4</term> + <listitem> + <para> + останавливается перед каждой строкой + приглашения. Исполнение возобновляется после + возврата каретки. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>7</term> + <listitem> + <para> + остановки + строки приглашения + вывод на экран командных строк: режим, полезный для демонстраций. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>exec(fun [,mode])</code> исполняет функцию <varname>fun</varname> как файл-сценарий: ни входного, ни выходного аргумента, ни особого окружения переменных. Эта форма более эффективна, поскольку код сценария может быть предварительно скомпилирован (см. <link linkend="comp">comp</link>). Этот метод исполнения сценария позволяет хранить сценарии в виде функций в библиотеках. + </para> + <para> + Если во время исполнения произойдёт ошибка, и если будет + указан флаг <literal>'errcatch'</literal>, то функция + <function>exec</function> не будет выдавать сообщения об + ошибке, прервёт исполнение инструкций и вернёт номер ошибки + <varname>ierr</varname>. Если же флаг + <literal>'errcatch'</literal> не будет указан, то будет + работать стандартная обработка ошибок. + </para> + </refsection> + <refsection> + <title>Примечания</title> + <para> + Теперь файлы для функции <function>exec</function> можно использовать для определения функций, используя синтаксис определения функции в строке (см. <link linkend="function">function</link>). + </para> + <para> + Функция <function>exec</function> поддерживает файлы с кодировкой ANSI/ASCII и UTF-8. + </para> + <para> + Длина каждой строки в файле ограничена 4096 символами. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// создадим файл-сценарий +mputl('a=1;b=2',TMPDIR+'/myscript') +// выполним его +exec(TMPDIR+'/myscript') +whos -name "a " +// создадим функцию +deff('y=foo(x)','a=x+1;y=a^2') +clear a b +// вызовем функцию +foo(1) +// a - переменная, созданная в окружении функции foo; +// она будет уничтожена после возврата из foo +whos -name "a " +x=1 //создадим x чтобы его узнал сценарий foo +exec(foo) +// a и y созданы в текущем окружении +whos -name "a " +whos -name "y " + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="mode">mode</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/execstr.xml b/modules/functions/help/ru_RU/execstr.xml new file mode 100755 index 000000000..e89ab2911 --- /dev/null +++ b/modules/functions/help/ru_RU/execstr.xml @@ -0,0 +1,153 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="execstr"> + <refnamediv> + <refname>execstr</refname> + <refpurpose> + исполняет Scilab-код, заданный в строках + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + execstr(instr) + ierr = execstr(instr,'errcatch' [,msg]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>instr</term> + <listitem> + <para> + вектор символьных строк, Scilab-инструкции, которые нужно исполнить. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para> + целое число, 0 или номер ошибки. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para> + символьная строка со значениями <literal>'m'</literal> или <literal>'n'</literal>. Значение по умолчанию - <literal>'n'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Исполняет Scilab-инструкции, указанные в аргументе + <varname>instr</varname>. + </para> + <note> + Заметьте, что инструкции <varname>instr</varname> не должны использовать символы продолжения (..) + </note> + <para> + Если флаг <literal>'errcatch'</literal> не указан, то обработка ошибок ведётся как обычно. + </para> + <para> + Если указан флаг <literal>'errcatch'</literal>, и во время исполнения инструкций в <varname>instr</varname> произойдёт ошибка, то функция <function>execstr</function> не выдаст сообщения об ошибке, но прекратит исполнение инструкций <varname>instr</varname> (в том месте, где произошла ошибка), и вернёт номер ошибки <varname>ierr</varname>. В этом случае отображение ошибки управляется опцией <varname>msg</varname>: + </para> + <variablelist> + <varlistentry> + <term>"m"</term> + <listitem> + <para> + сообщение об ошибке выводится на экран и записывается. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"n"</term> + <listitem> + <para> + сообщение об ошибке не отображается, однако записывается (see <link linkend="lasterror">lasterror</link>). Это значение по умолчанию. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + <code>ierr = execstr(instr, 'errcatch')</code> может + обрабатывать синтаксические ошибки. Это полезно для + выполнения инструкций, полученных по запросу пользователя. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +execstr('a=1') // устанавливает a=1. + +execstr('1+1') // ничего не делает (тогда как evstr('1+1') возвращает 2) + +execstr(['if %t then'; + ' a=1'; + ' b=a+1'; + 'else' + ' b=0' + 'end']) + +execstr('a=zzzzzzz','errcatch') + +execstr('a=zzzzzzz','errcatch','m') + +//syntax errors +execstr('a=1?02','errcatch') +lasterror(%t) + +execstr('a=[1 2 3)','errcatch') +lasterror(%t) + +// variable1 не существует +if execstr('variable1;','errcatch')<>0 then + disp("Взведена ошибка"); +else + disp("execstr полна счастья"); +end + +// variable2 существует ... execstr не взводит ошибки +variable2=[2,3]; +if execstr('variable2;','errcatch')<>0 then + disp("Взведена ошибка"); +else + disp("execstr полна счастья"); +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="evstr">evstr</link> + </member> + <member> + <link linkend="lasterror">lasterror</link> + </member> + <member> + <link linkend="error">error</link> + </member> + <member> + <link linkend="try">try</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/fun2string.xml b/modules/functions/help/ru_RU/fun2string.xml new file mode 100755 index 000000000..2069f208c --- /dev/null +++ b/modules/functions/help/ru_RU/fun2string.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="fun2string"> + <refnamediv> + <refname>fun2string</refname> + <refpurpose> + формирует ASCII-определение Scilab-функции + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>txt = fun2string(fun, name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fun</term> + <listitem> + <para> + переменная типа <literal>function</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem> + <para> + символьная строка, имя формируемой функции. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para> + вектор-столбец строковых значений, текст, указывающий Scilab-инструкции. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>fun2string</function> позволяет + воспроизвести код псевдокода указанной загруженной функции. + Сформированный код имеет отступы и красивый вид. + </para> + <para> + Механизм схож с механизмом <function>mfile2sci</function>, но + проще. Он может применяться для переводов синтаксиса. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +txt = fun2string(asinh,'foo'); +write(%io(2),txt,'(a)') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="edit">edit</link> + </member> + <member> + <link linkend="macrovar">macrovar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/funcprot.xml b/modules/functions/help/ru_RU/funcprot.xml new file mode 100755 index 000000000..ab4b21f45 --- /dev/null +++ b/modules/functions/help/ru_RU/funcprot.xml @@ -0,0 +1,81 @@ +<?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="funcprot"> + <refnamediv> + <refname>funcprot</refname> + <refpurpose>переключает режим защиты функций Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + funcprot(prot) + previousprot = funcprot(prot) + prot = funcprot() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>prot</term> + <listitem> + <para>целое число с возможными значениями 0, 1, 2</para> + </listitem> + </varlistentry> + <varlistentry> + <term>previousprot</term> + <listitem> + <para>целое число с возможными значениями 0, 1, 2; возвращает предыдущее значение</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функции Scilab являются переменными. <function>funcprot</function> + позволяет пользователю определить что Scilab должен делать при + переопределении таких переменных. + </para> + <itemizedlist> + <listitem> + <para> + Если <code>prot == 0</code>, то ничего особого не будет делаться. + </para> + </listitem> + <listitem> + <para> + Если <code>prot == 1</code>, то Scilab формирует сообщение с + предупреждением во время переопределения функции (это режим по умолчанию). + </para> + </listitem> + <listitem> + <para> + Если <code>prot == 2</code>, то Scilab формирует ошибку во время переопределения функции. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +previousprot = funcprot(1) +deff('x = foo(a)','x = a;') +deff('x = foo(a)','x = a + 1;') +foo = 33 +funcprot(0) +deff('x = foo(a)', 'x = a;') +deff('x = foo(a)', 'x = a + 1;') +foo = 33 +funcprot(previousprot) +]]></programlisting> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>Предыдущее значение возвращается в виде выходного аргумента при установке нового значения.</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/function.xml b/modules/functions/help/ru_RU/function.xml new file mode 100755 index 000000000..1024f37f4 --- /dev/null +++ b/modules/functions/help/ru_RU/function.xml @@ -0,0 +1,162 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="function"> + <refnamediv> + <refname>function</refname> + <refpurpose> + открывает определение функции + </refpurpose> + </refnamediv> + <refnamediv xml:id="endfunction"> + <refname>endfunction</refname> + <refpurpose> + закрывает определение функции + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <programlisting role='no-scilab-exec'><![CDATA[ +function <выходные_аргументы>=<имя_функции><входные_аргументы> + <операторы> +endfunction + ]]></programlisting> + <para> + Где: + </para> + <variablelist> + <varlistentry> + <term><имя_функции></term> + <listitem> + <para> + указывает имя функции + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><входные_аргументы></term> + <listitem> + <para> + указывает список входных аргументов. Он может быть + </para> + <itemizedlist> + <listitem> + <para> + рядом имён переменных, разделённых + запятой и заключённым в круглые скобки, + например <literal>(x1,...,xm)</literal>. + Последнее имя переменной может быть + ключевым словом + <literal>varargin</literal> (см. <link linkend="varargin">varargin</link>); + </para> + </listitem> + <listitem> + <para> + последовательностью <literal>()</literal> + или ничего, если у функции нет входных + аргументов. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><выходные_аргументы></term> + <listitem> + <para> + указывает список выходных аргументов. Он может быть + </para> + <itemizedlist> + <listitem> + <para> + рядом имён переменных, заключённым в + квадратные скобки, например <literal>[y1,...,yn]</literal>. Последнее имя переменной может быть ключевым словом <literal>varargout</literal> (см. <link linkend="varargout">varargout</link>); + </para> + </listitem> + <listitem> + <para> + последовательностью <literal>[]</literal>, если у функции нет выходных аргументов. В этом случае синтаксис может быть таким: <literal>function <имя_функции><входные_аргументы></literal> + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><операторы></term> + <listitem> + <para> + указывает набор Scilab-инструкций (операторов). + Этот синтаксис можно использовать для + определения функции (см. <link linkend="functions">functions</link>) как встраиваемую, либо в файле-сценарии (см. <link linkend="exec">exec</link>). Для совместимости + со старыми версиями Scilab'а функции, + определённые в файле-сценарии, содержащем только + определения функций, могут быть "загружены" в + Scilab используя функцию <function>exec</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Последовательность <literal>function <выходные_аргументы>=<имя_функции><входные_аргументы></literal> + нельзя разделять на несколько строк. После этой последовательности можно ставить в этой же строке операторы, если в конце добавить запятую или точку с запятой. + </para> + <note> + Заметьте, что <literal><имя_функции></literal> должно удовлетворять некоторым правилам синтаксиса (см. <link linkend="names">имена</link>). + </note> + <para> + Определения функций могут быть вложенными. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +//определение встраиваемой функции +function [x,y]=myfct(a,b) +x=a+b +y=a-b +endfunction + +[x,y]=myfct(3,2) + +//определение функции в одну строку +function y=sq(x),y=x^2,endfunction + +sq(3) + +//определение вложенных функций +function y=foo(x) +a=sin(x) +function y=sq(x), y=x^2,endfunction +y=sq(a)+1 +endfunction + +foo(%pi/3) + +// определение функции в файле-сценарии (см. exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="functions">functions</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="names">имена</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/functions.xml b/modules/functions/help/ru_RU/functions.xml new file mode 100755 index 000000000..e536b6f45 --- /dev/null +++ b/modules/functions/help/ru_RU/functions.xml @@ -0,0 +1,195 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="functions"> + <refnamediv> + <refname>функции</refname> + <refpurpose> + Scilab-процедуры и Scilab-объекты + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Функции являются процедурами Scilab ("макрос", "функция" и + "процедура" имеют одно и то же значение). + </para> + </refsection> + <refsection> + <title>Определение функции</title> + <para> + Обычно они определяются в файлах с помощью редактора и загружаются в Scilab, используя функцию <link linkend="exec">exec</link> или через библиотеку (см. + <link linkend="lib">lib</link> либо <link linkend="genlib">genlib</link>). Однако, они также могут быть определены во время исполнения программы (см. <link linkend="deff">deff</link> либо <link linkend="function">function</link>). + Функция определяется двумя составляющими: + </para> + <itemizedlist> + <listitem> + <para>часть "синтаксис определения", как например:</para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) +function [y1,...,yn,varargout]=foo(x1,...,xm,varargin) + ]]></programlisting> + </listitem> + <listitem> + <para>ряд Scilab-инструкций.</para> + </listitem> + </itemizedlist> + <para> + Строка "синтаксиса определения" указывает "полный" синтаксис + вызова этой функции. <literal>yi</literal> - выходные + переменные, вычисленные в зависимости от входных переменных + <literal>xi</literal> и переменные, существующие в Scilab'е + в момент исполнения функции. + </para> + </refsection> + <refsection> + <title>Вызов функции</title> + <itemizedlist> + <listitem> + <para> + Обычно синтаксис вызова функции следующий: + <literal>[y1,...,yn]=foo(x1,...,xm)</literal>. Можно + использовать более короткий список входных или + выходных аргументов, чем определённый. В таких + случаях используются или устанавливаются только + самые первые переменные, начиная слева. + </para> + <para> + Функция <link linkend="argn">argn</link> может быть + использована для получения фактического количества + аргументов при вызове. + </para> + </listitem> + <listitem> + <para> + Можно определять функцию с неопределённым + максимальным количеством входных или выходных + аргументов. Это можно сделать, используя ключевые + слова <link linkend="varargin">varargin</link> и + <link linkend="varargout">varargout</link>. + </para> + </listitem> + <listitem> + <para> + Также можно использовать "именованный аргумент" для определения входных аргументов: предположим, что функция <function>fun1</function>, определённая как + <code>function y1 = fun1(x1, x2, x3)</code>, тогда её можно вызвать следующим синтаксисом: + <code>y = fun1(x1=33, x3=[1 2 3])</code>; внутри + <function>fun1</function> переменная <varname>x2</varname> не будет определена. + </para> + <para> + Её можно также вызвать следующим синтаксисом: + <code>y = fun1(x1=33, y='foo')</code>. В таком + случае переменная <varname>y</varname> будет + доступна в контексте функции + <function>fun1</function>. + <note> + Обратите внимание, что максимальное количество + аргументов должно быть меньше или равно числу + формальных входных аргументов, используемых в + части синтаксиса функции. + </note> + </para> + <para> + Проверить определены ли переменные можно с помощью + функции <link linkend="exists">exists</link>. + </para> + </listitem> + <listitem> + <para> + Когда у функции нет аргументов слева и она вызывается только с аргументами символьных строк, синтаксис вызова может быть упрощён: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun('a','toto','a string') + ]]></programlisting> + <para>что эквивалентно: </para> + <programlisting role='no-scilab-exec'><![CDATA[ +fun a toto 'a string' + ]]></programlisting> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Прочие вопросы</title> + <para> + Функции являются Scilab-объектами (с номерами типа 13 или + 11). И ими можно управлять (создавать, сохранять, загружать, + передавать в качестве аргументов, и т. д.) как и другими + типами переменных. + </para> + <para> + Коллекции функций можно собирать в библиотеки. Функции, + которые начинаются со знака <literal>%</literal> (например, + <literal>%foo</literal>) часто используются чтобы + перегрузить (см. <link linkend="overloading">перегрузку</link>) операции или + функции для нового типа данных. + </para> + <note> + Заметьте, что имя функции должно удовлетворять некоторым правилам синтаксиса (см. <link linkend="names">имена</link>). + </note> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +//определение встраиваемой функции (см. function) +function [x,y]=myfct(a,b) + x=a+b + y=a-b +endfunction +[x,y]=myfct(3,2) + +//определение встраиваемой функции (см. deff) +deff('[x,y]=myfct(a,b)',['x=a+b'; + 'y=a-b']) + +// определение в ASCII-файле (см. exec) +exec SCI/modules/elementary_functions/macros/asinh.sci; + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="getd">getd</link> + </member> + <member> + <link linkend="genlib">genlib</link> + </member> + <member> + <link linkend="exists">exists</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + <member> + <link linkend="names">имена</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/getd.xml b/modules/functions/help/ru_RU/getd.xml new file mode 100755 index 000000000..bb269185b --- /dev/null +++ b/modules/functions/help/ru_RU/getd.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="getd"> + <refnamediv> + <refname>getd</refname> + <refpurpose> + загрузка всех функций, определённых в директории + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>getd(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + строка, имя путь к директории. + </para> + <para> + Если функция <function>getd</function> вызвана без входного аргумента, либо если <varname>path</varname> - пустая строка, то путь к директории ".". + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Загружает все <literal>.sci</literal> файлы (содержащие + Scilab-функции), определённые в директории + <varname>path</varname>. + </para> + <para> + Если файл не содержит функции, то этот сценарий будет исполнен. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +getd('SCI/modules/cacsd/macros') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/head_comments.xml b/modules/functions/help/ru_RU/head_comments.xml new file mode 100755 index 000000000..0b50faf44 --- /dev/null +++ b/modules/functions/help/ru_RU/head_comments.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) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr> + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="head_comments"> + <refnamediv> + <refname>head_comments</refname> + <refpurpose> + выводит на экран комментарии в начале Scilab-функции + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + head_comments(name) + head_comments(name,%paths) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>name</term> + <listitem> + <para> + символьная строка, имя функции. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>%paths</term> + <listitem> + <para> + вектор символьных строк, пути по которым + разыскивается соответствующий sci-файл. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Команда <code>head_comments(name)</code> выводит на экран + комментарии в начале функции (как справка в Matlab'е). + Комментарии считываются из соответствующего sci-файла. Если + <varname>name</varname> - это имя функции из библиотеки, то + путь к sci-файлу тогда указывается путём к библиотеке (см. + <link linkend="lib">lib</link>). Если <varname>name</varname> - + это функция не из библиотеки, то файл с именем + <varname>name</varname><literal>.sci</literal> разыскивается + в директориях, указанных переменной <varname>%paths</varname>. + </para> + <warning> + Внимание: большинство предопределённых Scilab-функций не имеет начальных комментариев. + </warning> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +head_comments sinc + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="help">help</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/libraries/CHAPTER b/modules/functions/help/ru_RU/libraries/CHAPTER new file mode 100755 index 000000000..9c4df3635 --- /dev/null +++ b/modules/functions/help/ru_RU/libraries/CHAPTER @@ -0,0 +1,2 @@ +title = Библиотеки + diff --git a/modules/functions/help/ru_RU/listfunctions.xml b/modules/functions/help/ru_RU/listfunctions.xml new file mode 100755 index 000000000..bd13b34bd --- /dev/null +++ b/modules/functions/help/ru_RU/listfunctions.xml @@ -0,0 +1,132 @@ +<?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="listfunctions"> + <refnamediv> + <refname>listfunctions</refname> + <refpurpose> + свойства всех функций в рабочем пространстве + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + [flist,compiled,profilable,called] = listfunctions([scope]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>scope</term> + <listitem> + <para> + строка, <literal>"local"</literal> (по умолчанию) или <literal>"global"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flist</term> + <listitem> + <para> + массив строк, имена всех переменных-функций в + указанном рабочем пространстве. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>compiled</term> + <listitem> + <para> + массив логических значений, ИСТИНА, если + соответствующий элемент из списка + <varname>flist</varname> имеет тип 13. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>profilable</term> + <listitem> + <para> + массив логических значений, ИСТИНА, если + соответствующий элемент из списка + <varname>flist</varname> имеет тип 13 и к тому + же в псевдокоде функции найдена информация + профилирования. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>called</term> + <listitem> + <para> + массив значений типа uint32, количество раз, + когда соответствующий элемент из списка + <varname>flist</varname> уже был вызван + (ненулевой только для профилируемых функций). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <itemizedlist> + <listitem> + <para> + Эта функция проверяет все переменные в рабочем + пространстве (указанные с помощью функции + <link linkend="who">who</link>) и собирает те, + которые имеют тип 11 или 13; для последних + вызывается <code>lst = macr2lst(fun)</code> для + того, чтобы проверить магический вход профилирования + в конце первой строки кода, т. е. <code>lst(5)(1)=="25"</code>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +recompilefunction("asinh","p") +[flist,compiled,profilable,called] = listfunctions(); +flist(profilable) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + <member> + <link linkend="profile">profile</link> + </member> + <member> + <link linkend="recompilefunction">recompilefunction</link> + </member> + <member> + <link linkend="who">who</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Литература</title> + <para> + <ulink url="http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation">http://wiki.scilab.org/Scilab_function_variables%3A_representation%2C_manipulation</ulink> + </para> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/macr2lst.xml b/modules/functions/help/ru_RU/macr2lst.xml new file mode 100755 index 000000000..d5893f28b --- /dev/null +++ b/modules/functions/help/ru_RU/macr2lst.xml @@ -0,0 +1,217 @@ +<?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="macr2lst"> + <refnamediv> + <refname>macr2lst</refname> + <refpurpose>преобразование функции в список</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>lst = macr2lst(function_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para> + функция, которую требуется преобразовать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>lst</term> + <listitem> + <para>список.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Этот примитив преобразует компилированную функцию Scilab + <varname>function_name</varname> в список, который кодирует внутреннее + представление функции (обратная бесскобочная запись). + </para> + <para> + Первый элемент списка является именем функции, второй и третий являются, соответственно, именами выходных переменных и входных переменных. Следующие элементы являются или записями основных операций или списками, содержащими иерархические управляющие структуры, такие, как + <literal>if</literal>, <literal>for</literal>, ... + </para> + <para> + Записи основных операций описываются вектором символьных строк, чей первый элемент представляет собой код операции. + </para> + <informaltable border="1"> + <tr> + <td>коды операций</td> + <td>значение</td> + <td>параметры</td> + </tr> + <tr> + <td>"0"</td> + <td>игнорируемый код операции</td> + <td>ничего</td> + </tr> + <tr> + <td>"1"</td> + <td>более не используется</td> + <td/> + </tr> + <tr> + <td>"2"</td> + <td>ссылка на переменную или функцию</td> + <td>имя переменной, #rhs, #lhs</td> + </tr> + <tr> + <td>"3"</td> + <td>положить строку в стек</td> + <td>строка</td> + </tr> + <tr> + <td>"4"</td> + <td>положить пустую матрицу в стек</td> + <td>ничего</td> + </tr> + <tr> + <td>"5"</td> + <td>применить операцию</td> + <td>код операции, #rhs,#lhs</td> + </tr> + <tr> + <td>"6"</td> + <td>положить число в стек</td> + <td>число</td> + </tr> + <tr> + <td>"12"</td> + <td>команда pause</td> + <td>ничего</td> + </tr> + <tr> + <td>"13"</td> + <td>команда break</td> + <td>ничего</td> + </tr> + <tr> + <td>"14"</td> + <td>команда abort</td> + <td>ничего</td> + </tr> + <tr> + <td>"15"</td> + <td>конец метки строки</td> + <td>ничего</td> + </tr> + <tr> + <td>"17"</td> + <td>команда quit</td> + <td>ничего</td> + </tr> + <tr> + <td>"18"</td> + <td>именованная переменная</td> + <td>имя переменной</td> + </tr> + <tr> + <td>"19"</td> + <td>создать рекурсивную структуру индексов</td> + <td>длина пути, количество конечных индексов</td> + </tr> + <tr> + <td>"20"</td> + <td>вызов функции</td> + <td>имя функции, #rhs, #lhs </td> + </tr> + <tr> + <td>"23"</td> + <td>создать переменную из имени</td> + <td>имя переменной</td> + </tr> + <tr> + <td>"24"</td> + <td>положить переменную с типом 0 в стек</td> + <td>ничего</td> + </tr> + <tr> + <td>"25"</td> + <td>запись профиля</td> + <td>количество вызовов, затраченное время</td> + </tr> + <tr> + <td>"26"</td> + <td>положить вектор строк в стек</td> + <td>кол-во строк, кол-во столбцов, последовательность элементов</td> + </tr> + <tr> + <td>"27"</td> + <td>положить встроенную ссылку в стек</td> + <td>номер интерфейса, положение в интерфейсе, имя функции</td> + </tr> + <tr> + <td>"28"</td> + <td>команда continue</td> + <td>ничего</td> + </tr> + <tr> + <td>"29"</td> + <td>присвоение</td> + <td>#lhs, режим отображения, (имя переменной, #rhs)*</td> + </tr> + <tr> + <td>"30"</td> + <td>сокращённое вычисление логического выражения</td> + <td>тип, размер скачка</td> + </tr> + <tr> + <td>"31"</td> + <td>комментарий</td> + <td>комментарий</td> + </tr> + <tr> + <td>"99"</td> + <td>команда return</td> + <td>ничего</td> + </tr> + <tr> + <td> > "100"</td> + <td>встроенный вызов (устарело)</td> + <td>100*fun, #rhs, #lhs, fin</td> + </tr> + </informaltable> + <para> + Функция <link linkend="fun2string">fun2string</link> может быть использована для генерации исходного кода. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// ОТОБРАЖЕНИЕ +function y=foo(x,flag) + if flag then + y=sin(x) + else + y=cos(x) + end +endfunction +L=macr2lst(foo) +fun2string(L) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="macrovar">macrovar</link> + </member> + <member> + <link linkend="fun2string">fun2string</link> + </member> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/macr2tree.xml b/modules/functions/help/ru_RU/macr2tree.xml new file mode 100755 index 000000000..a7cf584a3 --- /dev/null +++ b/modules/functions/help/ru_RU/macr2tree.xml @@ -0,0 +1,53 @@ +<?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="macr2tree"> + <refnamediv> + <refname>macr2tree</refname> + <refpurpose>преобразование функции в дерево</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>t=macr2tree(function_name)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>function_name</term> + <listitem> + <para>макрос Scilab'а</para> + </listitem> + </varlistentry> + <varlistentry> + <term>t</term> + <listitem> + <para>"дерево" Scilab'а</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Этот примитив преобразует компилированную функцию Scilab с именем + <literal>function_name</literal> в дерево (перекрываемые типизированные + списки), которое кодирует внутреннее представление функции. + Для использования совместно с <literal>tree2code</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="tree2code">tree2code</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/macro.xml b/modules/functions/help/ru_RU/macro.xml new file mode 100755 index 000000000..e394ed801 --- /dev/null +++ b/modules/functions/help/ru_RU/macro.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="macro"> + <refnamediv> + <refname>макрос</refname> + <refpurpose>Scilab-процедура и Scilab-объект</refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Макросы - это Scilab-процедуры ("макрос", "функция" и + "процедура" имеют одно и то же значение). Обычно они + определяются в файле с помощью редактора и загружаются в + Scilab с помощью функции <function>exec</function> или через + библиотеку. + </para> + <para> + Они могут быть также определены в ходе выполнения программы + (см. <link linkend="deff">deff</link>). Файл, который содержит макрос, должен начинаться следующим образом: + </para> + <programlisting role='no-scilab-exec'><![CDATA[ +function [y1,...,yn]=foo(x1,...,xm) + ]]></programlisting> + <para> + <literal>yi</literal> - выходные переменные, вычисленные в зависимости от входных переменных и переменных, существующих в Scilab'е в момент исполнения макроса. Макрос может быть скомпилированным для более быстрого исполнения. Коллекции макросов могут быть собраны в библиотеки. + </para> + <para> + Макросы, которые начинаются со знака <literal>%</literal> (например, <literal>%foo</literal>) и чьи аргументы являются списками, используются для выполнения особых операций: например, <code>z=%rmr(x,y)</code> эквивалентно + <code>z=x*y</code>, когда <varname>x</varname> и <varname>z</varname> являются рациональными переменными + (например, <code>x=list('r',n,d,[])</code>, где <varname>n</varname> и <varname>d</varname> - полиномы). + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="deff">deff</link> + </member> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + <member> + <link linkend="lib">lib</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/macrovar.xml b/modules/functions/help/ru_RU/macrovar.xml new file mode 100755 index 000000000..d1b9c7d8d --- /dev/null +++ b/modules/functions/help/ru_RU/macrovar.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) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="macrovar"> + <refnamediv> + <refname>macrovar</refname> + <refpurpose>переменные в функции</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>vars = macrovar(function)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>vars</term> + <listitem> + <para> + список, <literal>list(in, out, nolocal, called, locals)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>function</term> + <listitem> + <para>имя функции.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Возвращает в списке набор переменных, используемых функцией. + <varname>vars</varname> - это список, сделанный из пяти вектор-столбцов символьных строк: + </para> + <simplelist type="inline"> + <member> + <varname>in</varname>: входные переменные (<code>vars(1)</code>); + </member> + <member> + <varname>out</varname>: выходные переменные (<code>vars(2)</code>); + </member> + <member> + <varname>nolocal</varname>: переменные, к которым обращаются, но которые не определены внутри функции и не являются функциями (<code>vars(3)</code>); + </member> + <member> + <varname>called</varname>: имена вызываемых функций (<code>vars(4)</code>); + </member> + <member> + <varname>locals</varname>: локальные переменные (<code>vars(5)</code>); + </member> + </simplelist> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc'); +vars = macrovar(f) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="string">string</link> + </member> + <member> + <link linkend="macr2lst">macr2lst</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/mode.xml b/modules/functions/help/ru_RU/mode.xml new file mode 100755 index 000000000..bfe6fb705 --- /dev/null +++ b/modules/functions/help/ru_RU/mode.xml @@ -0,0 +1,144 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.Scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mode" xml:lang="ru"> + <refnamediv> + <refname>mode</refname> + <refpurpose>выбор режима отображения информации во время исполнения файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mode(k) + k = mode() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + Используется <emphasis role="bold">исключительно</emphasis> внутри исполняемого файла + или Scilab-функции. <literal>mode(k)</literal> позволяет менять информацию, отображаемую + во время исполнения; зависит от значения <literal>k</literal>: + </para> + <variablelist> + <varlistentry> + <term>k = 0</term> + <listitem> + <para> + Новые значения переменных отображаются, если требуется (см. справку + по <link linkend="semicolon">точке с запятой</link> или + <link linkend="comma">запятой</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = -1</term> + <listitem> + <para> + Исполняемый файл или Scilab-функция работает молча (это для Scilab-функций + значение по умолчанию). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 2</term> + <listitem> + <para>Это значение по умолчанию для командной строки Scilab'а.</para> + <para> + Обратите внимание, что <literal>mode(2)</literal> не используется в + командной строке, только в исполняемом файле или Scilab-функции. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 1 или k = 3</term> + <listitem> + <para> + Каждая строка инструкции выводится в командной строке (если возможно). + Новые значения переменных отображаются в случае запроса. Это режим по умолчанию + для исполняемых файлов. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k = 4 или k = 7</term> + <listitem> + <para> + Новые значения переменных отображаются в случае запроса, в командной строке + отображается каждая строка инструкций (если возможно), и выдаётся приглашение к вводу + (>>) после каждой строки в ожидании возврата каретки. + </para> + <para> + Если возврат каретки следует после латинской буквы "p", то исполнение приостанавливается + (см. <link linkend="pause">pause</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>k > 7</term> + <listitem> + <para> + Пользовательский режим отображения. Если вы определите ваш собственный режим отображения, то рекомендуется использовать + значение > 100. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Отображение строк отключено для компилированных Scilab-функций (см. <link linkend="comp">comp</link>). + По умолчанию Scilab-функции исполняются в режиме молчания ("-1"). + </para> + <para>Функции из библиотеки функций исполняются в режиме "-1".</para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// скопируйте и вставьте в Scilab + +function example_mode( level_mode ) + mode(level_mode) + a = 3 + disp(mode()); +endfunction + +mode(2) + +example_mode(0) +example_mode(-1) +example_mode(2) +example_mode(1) +example_mode(3) +example_mode(7) + +mode(2) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="exec">exec</link> + </member> + <member> + <link linkend="execstr">execstr</link> + </member> + <member> + <link linkend="semicolon">точка с запятой</link> + </member> + <member> + <link linkend="comma">запятая</link> + </member> + <member> + <link linkend="comp">comp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/overloading.xml b/modules/functions/help/ru_RU/overloading.xml new file mode 100755 index 000000000..44616dd9a --- /dev/null +++ b/modules/functions/help/ru_RU/overloading.xml @@ -0,0 +1,633 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) INRIA + * Copyright (C) DIGITEO - 2012 - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="overloading" xml:lang="ru"> + <refnamediv> + <refname>перегрузка</refname> + <refpurpose> + возможности перегрузки отображения, функций и операторов + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + В Scilab'е вывод на экран переменной, функции и операторы могут быть определены для новых объектов с помощью функций (в Scilab-коде или примитивов). + </para> + <variablelist> + <varlistentry> + <term>Вывод на экран</term> + <listitem> + <para> + Вывод на экран новых объектов, определённых с + помощью структуры типизированного списка + <literal>tlist</literal>, может быть перегружен + (по умолчанию вывод на экран схож с выводом на + экран списка <literal>list</literal>). Функция + перегрузки не должна иметь выходных аргументов, + но должна иметь один входной аргумент. Её имя + формируется следующим образом: + <literal>%<тип_tlist>_p</literal>, + где <literal>%<тип_tlist></literal> + указывает на первый вход компонента типа + <literal>tlist</literal>, усечённого до первых + 9-ти символов. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Операторы</term> + <listitem> + <para> + Каждый оператор, который не определён для типов + указанных операндов, может быть определён. + Функция перегрузки должна иметь один выходной + аргумент и один или два входных в соответствии с + количеством операндов. Имя функции формируется + следующим образом: + </para> + </listitem> + </varlistentry> + </variablelist> + <para>для бинарных операторов: + <literal>%<тип_первого_операнда>_<код_оператора>_<тип_второго_операнда></literal>; + </para> + <para>для унарных операторов: + <literal>%<operand_type>_<код_оператора></literal>; + </para> + <para> + операторы выделения и вставки, которые являются n-арными + операторами, описаны ниже. + </para> + <warning> + Будьте осторожны. В макросе перегрузки можно использовать + только те типы, которые зарегистрированы функцией + <function>typename</function>. + </warning> + <para> + <literal><operand_type></literal>, + <literal><тип_первого_операнда></literal>, + <literal><тип_второго_операнда></literal> являются + последовательностями символов, связанных с каждым типом + данных как это описано в следующей таблице: + </para> + <informaltable border="1"> + <tr> + <td>тип данных</td> + <td>символьный код</td> + <td>typeof</td> + <td>комментарии</td> + </tr> + <tr> + <td>матрица чисел удвоенной точности</td> + <td> + <literal>s</literal> + </td> + <td> + <literal>constant</literal> + </td> + <td/> + </tr> + <tr> + <td>матрица полиномов</td> + <td> + <literal>p</literal> + </td> + <td> + <literal>polynomial</literal> + </td> + <td/> + </tr> + <tr> + <td>матрица логических значений</td> + <td> + <literal>b</literal> + </td> + <td> + <literal>boolean</literal> + </td> + <td/> + </tr> + <tr> + <td>разрежённая матрица</td> + <td> + <literal>sp</literal> + </td> + <td> + <literal>sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>разрежённая матрица логических значений</td> + <td> + <literal>spb</literal> + </td> + <td> + <literal>boolean sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>разрежённая матрица Matlab'а</td> + <td> + <literal>msp</literal> + </td> + <td> + <literal>Matlab sparse</literal> + </td> + <td/> + </tr> + <tr> + <td>матрица целочисленных значений</td> + <td> + <literal>i</literal> + </td> + <td> + <literal>int8, int16, int32, uint8, uint16, uint32</literal> + </td> + <td/> + </tr> + <tr> + <td>матрица строк</td> + <td> + <literal>c</literal> + </td> + <td> + <literal>string</literal> + </td> + <td/> + </tr> + <tr> + <td>дескриптор</td> + <td> + <literal>h</literal> + </td> + <td> + <literal>handle</literal> + </td> + <td/> + </tr> + <tr> + <td>компилированная функция</td> + <td> + <literal>fptr</literal> + </td> + <td> + <literal>fptr</literal> + </td> + <td/> + </tr> + <tr> + <td>сценарий, функция</td> + <td> + <literal>mc</literal> + </td> + <td> + <literal>function</literal> + </td> + <td/> + </tr> + <tr> + <td>библиотека</td> + <td> + <literal>f</literal> + </td> + <td> + <literal>library</literal> + </td> + <td/> + </tr> + <tr> + <td>список</td> + <td> + <literal>l</literal> + </td> + <td> + <literal>list</literal> + </td> + <td/> + </tr> + <tr> + <td>типизированный список</td> + <td> + <literal>tlist type</literal> + </td> + <td> + <literal>tlist type</literal> + </td> + <td>первая строка первого элемента типизированного списка</td> + </tr> + <tr> + <td>матричноориентированный список</td> + <td> + <literal>mlist type</literal> + </td> + <td> + <literal>mlist type</literal> + </td> + <td>первая строка первого элемента матричноориентированного списка</td> + </tr> + <tr> + <td>гиперматрица</td> + <td> + <literal>hm</literal> + </td> + <td> + <literal>hypermat</literal> + </td> + <td/> + </tr> + <tr> + <td>указатель</td> + <td> + <literal>ptr</literal> + </td> + <td> + <literal>pointer</literal> + </td> + <td/> + </tr> + <tr> + <td>cell-массив</td> + <td> + <literal>ce</literal> + </td> + <td> + <literal>ce</literal> + </td> + <td/> + </tr> + <tr> + <td>структура</td> + <td> + <literal>st</literal> + </td> + <td> + <literal>st</literal> + </td> + <td/> + </tr> + <tr> + <td>рациональное значение</td> + <td> + <literal>r</literal> + </td> + <td> + <literal>rational</literal> + </td> + <td/> + </tr> + <tr> + <td>линейное пространство состояний</td> + <td> + <literal>lss</literal> + </td> + <td> + <literal>state-space</literal> + </td> + <td/> + </tr> + <tr> + <td>неявный полином</td> + <td> + <literal>ip</literal> + </td> + <td> + <literal>size implicit</literal> + </td> + <td>1:1:$</td> + </tr> + </informaltable> + <para> + <literal><код_оператора></literal> - это одиночный + символ, связанный с каждым оператором, как описано в + следующей таблице: + </para> + <informaltable border="1"> + <tr> + <td> + оператор + </td> + <td> + символьный код + </td> + </tr> + <tr> + <td> + <literal>'</literal> + </td> + <td>t</td> + </tr> + <tr> + <td> + <literal>+</literal> + </td> + <td>a</td> + </tr> + <tr> + <td> + <literal>-</literal> + </td> + <td>s</td> + </tr> + <tr> + <td> + <literal>*</literal> + </td> + <td>m</td> + </tr> + <tr> + <td> + <literal>/</literal> + </td> + <td>r</td> + </tr> + <tr> + <td> + <literal>\</literal> + </td> + <td>l</td> + </tr> + <tr> + <td> + <literal>^</literal> + </td> + <td>p</td> + </tr> + <tr> + <td> + <literal>.*</literal> + </td> + <td>x</td> + </tr> + <tr> + <td> + <literal>./</literal> + </td> + <td>d</td> + </tr> + <tr> + <td> + <literal>.\</literal> + </td> + <td>q</td> + </tr> + <tr> + <td> + <literal>.*.</literal> + </td> + <td>k</td> + </tr> + <tr> + <td> + <literal>./.</literal> + </td> + <td>y</td> + </tr> + <tr> + <td> + <literal>.\.</literal> + </td> + <td>z</td> + </tr> + <tr> + <td> + <literal>:</literal> + </td> + <td>b</td> + </tr> + <tr> + <td> + <literal>*.</literal> + </td> + <td>u</td> + </tr> + <tr> + <td> + <literal>/.</literal> + </td> + <td>v</td> + </tr> + <tr> + <td> + <literal>\.</literal> + </td> + <td>w</td> + </tr> + <tr> + <td> + <literal>[a,b]</literal> + </td> + <td>c</td> + </tr> + <tr> + <td> + <literal>[a;b]</literal> + </td> + <td>f</td> + </tr> + <tr> + <td> + <literal>() выделение</literal> + </td> + <td>e</td> + </tr> + <tr> + <td> + <literal>() вставка</literal> + </td> + <td>i</td> + </tr> + <tr> + <td> + <literal>==</literal> + </td> + <td>o</td> + </tr> + <tr> + <td> + <literal><></literal> + </td> + <td>n</td> + </tr> + <tr> + <td> + <literal>|</literal> + </td> + <td>g</td> + </tr> + <tr> + <td> + <literal>&</literal> + </td> + <td>h</td> + </tr> + <tr> + <td> + <literal>.^</literal> + </td> + <td>j</td> + </tr> + <tr> + <td> + <literal>.'</literal> + </td> + <td>0</td> + </tr> + <tr> + <td> + <literal><</literal> + </td> + <td>1</td> + </tr> + <tr> + <td> + <literal>></literal> + </td> + <td>2</td> + </tr> + <tr> + <td> + <literal><=</literal> + </td> + <td>3</td> + </tr> + <tr> + <td> + <literal>>=</literal> + </td> + <td>4</td> + </tr> + <tr> + <td> + <literal>~</literal> + </td> + <td>5</td> + </tr> + <tr> + <td> + <literal>iext</literal> + </td> + <td>6</td> + </tr> + </informaltable> + <para> + Функция перегрузки для синтаксиса выделения + <literal>b= a(i1, ..., in)</literal> + имеет следующую последовательность вызова: + <literal>b = %<тип_a>;_e_(i1, ..., in, a)</literal> + </para> + <para> + и синтаксис <literal>[x1, .., xm] = a(i1, ..., in)</literal> + имеет следующую последовательность вызова: + <literal>[x1, .., xm] = %<тип_a>;_e_(i1, ..., in, a)</literal>. + </para> + <para> + Функция перегрузки, связанная с синтаксисом вставки + <literal>a(i1, ..., in) = b</literal> имеет следующую + последовательность вызова: + <literal>a = %<тип_b>;_i_<тип_a>;(i1, ..., in, b, a)</literal>. + </para> + <para> + Символьный код <literal>6</literal> может использоваться в + некоторых сложных алгоритмах вставки, таких как <code>x.b(2) = 33</code>, + где поле <literal>b</literal> не определено в структуре + <literal>x</literal>. Вставка автоматически разлагается на + <code>temp = x.b</code>; <code>temp(2) = 33</code>; + <code>x.b = temp</code>. Символьный код <literal>6</literal> + используется для первого шага этого алгоритма. Функция + перегрузки <literal>6</literal> очень похожа на функцию + перегрузки <literal>e</literal>. + </para> + <variablelist> + <varlistentry> + <term>Функции:</term> + <listitem> + <para> + Некоторые основные функции-примитивы могут быть + также перегружены для новых типов данных. Когда + такая функция не определена для особого типа + данных, то вызывается функция + <literal>%<тип_аргумента>_<имя_функции></literal>. + Пользователь может добавить в этой вызываемой + функции определение, связанное с типами входных данных. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Примеры</title> + </refsection> + <refsection> + <programlisting role="example"> + //ВЫВОД НА ЭКРАН + var = tlist('tab', ['a', 'b'], ['x'; 'y'], rand(2, 2)) // у переменной var тип 'tab' + + typeof(var) + + function [] = %tab_p(l) + disp([[' '; l(3)] [l(2); string(l(4))]]) + endfunction + + var // после перегрузки + </programlisting> + </refsection> + <refsection> + <programlisting role="example"> + //ОПЕРАТОР + 's' + 1 // нельзя прибавить число к строке + + function x = %c_a_s(a, b) + x = a + string(b); + endfunction + + 's' + 1 // после перегрузки + </programlisting> + </refsection> + <refsection> + <programlisting role="example"> + //ФУНКЦИЯ + sin('2 * x') // sin не работает со строкой + + function x = %c_sin(a) + x = 'sin(' + a + ')' + endfunction + + sin('2 * x') // после перегрузки + </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="tlist">tlist</link> + </member> + <member> + <link linkend="disp">disp</link> + </member> + <member> + <link linkend="symbols">symbols</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typename">typename</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/sciargs.xml b/modules/functions/help/ru_RU/sciargs.xml new file mode 100755 index 000000000..684981e27 --- /dev/null +++ b/modules/functions/help/ru_RU/sciargs.xml @@ -0,0 +1,30 @@ +<?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="sciargs"> + <refnamediv> + <refname>sciargs</refname> + <refpurpose>аргументы командной строки Scilab'а</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>args = sciargs()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + Эта функция возвращает вектор-строку символьных строк, содержащую аргументы командной + строки Scilab'а. Первый элемент <literal>args</literal> содержит путь до запущенного + исполняемого файла. + </para> + <para> + Эта функция соответствует функции <literal>getarg</literal> в языке C. + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getenv">getenv</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/str2code.xml b/modules/functions/help/ru_RU/str2code.xml new file mode 100755 index 000000000..dfcf6d998 --- /dev/null +++ b/modules/functions/help/ru_RU/str2code.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) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="str2code" xml:lang="ru"> + <refnamediv> + <refname>str2code</refname> + <refpurpose> + возвращает целочисленные Scilab-коды, связанные с символьной строкой. + <emphasis role="bold">Эта функция устарела.</emphasis> + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>c = str2code(str)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>str</term> + <listitem> + <para>символьная строка.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para> + вектор-столбец целочисленных кодов символов. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>c = str2code(str)</code> возвращает такой вектор- + столбец <varname>c</varname>, что <literal>c(i)</literal> + является целочисленным Scilab-кодом символа + <literal>part(str,i)</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +str2code('Scilab')' +code2str([-28 12 18 21 10 11]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="code2str">code2str</link> + </member> + <member> + <link linkend="ascii">ascii</link> + </member> + <member> + <link linkend="part">part</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark> + Эта функция будет удалена в Scilab 6.0.0 + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/tree2code.xml b/modules/functions/help/ru_RU/tree2code.xml new file mode 100755 index 000000000..e90784e7a --- /dev/null +++ b/modules/functions/help/ru_RU/tree2code.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) INRIA - + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="tree2code"> + <refnamediv> + <refname>tree2code</refname> + <refpurpose> + формирует ASCII-определение Scilab-функции + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>txt = tree2code(tree, prettyprint)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>tree</term> + <listitem> + <para> + дерево функции (полученное с помощью <function>macr2tree</function>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>prettyprint</term> + <listitem> + <para>необязательное логическое значение:</para> + <variablelist> + <varlistentry> + <term>%T</term> + <listitem> + <para> + генерирует код, который имеет отступы и красивый вид; + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>%F</term> + <listitem> + <para> + генерируемый код не приукрашен (по умолчанию). + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para> + вектор-столбец строк, текст, предоставляющий Scilab-инструкции. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Задавая "дерево" загруженной в Scilab функции (полученное с + помощью функции <function>macr2tree</function>), + <function>tree2code</function> позволяет восстановить код. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +tree=macr2tree(cosh); +txt=tree2code(tree,%T); +write(%io(2),txt,'(a)'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="macr2tree">macr2tree</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/varargin.xml b/modules/functions/help/ru_RU/varargin.xml new file mode 100755 index 000000000..e802b5e45 --- /dev/null +++ b/modules/functions/help/ru_RU/varargin.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargin" xml:lang="ru"> + <refnamediv> + <refname>varargin</refname> + <refpurpose> + переменное число аргументов в списке входных аргументов + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Функция, чьим последним входным аргументом является + <literal>varargin</literal>, может быть вызвана с + бОльшим числом входных аргументов, чем указано в списке + входных аргументов. Аргументы вызова, переданные внутрь в форме ключевого слова <literal>varargin</literal> затем могут быть получены внутри функции в + списке с именем <literal>varargin</literal>. + </para> + <para> + Допустим, что ключевое слово <literal>varargin</literal> + является <literal>n</literal>-ным аргументом в списке + формальных входных аргументов, тогда, если функция + вызывается с меньшим числом, чем <literal>n-1</literal>, + входных аргументов, то список + <literal>varargin</literal> не будет определён. Если же + функция вызывается с <literal>n-1</literal> аргументами, + то список <literal>varargin</literal> будет пустым + списком. + </para> + <para> + <literal>function y = ex(varargin)</literal> может быть + вызвана с любым числом аргументов. Внутри функции + <literal>ex</literal> входные аргументы могут быть + получены в <literal>varargin(i)</literal>, + <literal>i=1:length(varargin)</literal>. + </para> + <para> + Если же это не последний аргумент функции, то + <literal>varargin</literal> будет обычным именем + входного аргумента без особого значения. + </para> + <para> + Общее число фактических входных аргументов даётся с + помощью <code>argn(2)</code>. + </para> + </refsection> + <refsection> + <title>Примечание</title> + <para> + Синтаксис именованных аргументов, такой как <literal>foo(...,key=value)</literal>, не совместим с использованием <literal>varargin</literal>. Причина в том, что имена (то есть ключи), связанные со значениями, не хранятся в списке <literal>varargin</literal>. Рассмотрим пример: + </para> + <programlisting role="no-scilab-exec"><![CDATA[ +function foo(varargin) + disp([varargin(1),varargin(2)]) +endfunction + ]]></programlisting> + <screen> + -->foo(a=1,b=2) + 1. 2. + -->foo(b=1,a=2) + 1. 2. + </screen> + <para> + Результат одинаковый, но аргументы были переставлены. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +function exampl(a,varargin) + [lhs,rhs]=argn(0) + if rhs>=1 then + disp(varargin) + end +endfunction + +exampl(1) +exampl() +exampl(1,2,3) +l=list('a',%s,%t); +exampl(1,l(2:3)) +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargout">varargout</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/functions/help/ru_RU/varargout.xml b/modules/functions/help/ru_RU/varargout.xml new file mode 100755 index 000000000..30132b0c3 --- /dev/null +++ b/modules/functions/help/ru_RU/varargout.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) ????-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="varargout" xml:lang="ru"> + <refnamediv> + <refname>varargout</refname> + <refpurpose> + переменное число аргументов в списке выходных аргументов + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Функция, чей список выходных аргументов содержит <literal>varargout</literal> должен вызываться с бОльшим числом аргументов, чем указано в списке выходных аргументов. Аргументы вызова, переданные внутрь в форме ключевого слова <literal>varargout</literal>, извлекаются из списка <literal>varargout</literal>, определённого внутри функции. + </para> + <para> + <literal>varargout = function ex()</literal> может вызываться с любым количеством выходных аргументов. Внутри функции <literal>ex</literal> выходные аргументы могут храниться в <literal>varargout(i)</literal>. + </para> + <para> + Может также использоваться <literal>[X1,...,Xn,varargout] = function ex()</literal>. В этом случае переменные <literal>Xi</literal> и <literal>varargout(i)</literal> должны быть определены в функции. + </para> + <para> + Фактическое общее количество выходных аргументов даётся с помощью <code>argn(1)</code>. + </para> + </refsection> + <refsection> + <title>Примечание</title> + <para> + Переменная <literal>varargout</literal> должна быть создана внутри функции и определена в виде <link linkend="list">списка</link>. Если <literal>varargout</literal> является единственной формальной выходной переменой, то список должен содержать хотя бы один элемент. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +function varargout=exampl() + varargout=list(1,2,3,4) +endfunction + +x=exampl() +[x,y]=exampl() +[x,y,z]=exampl() + +function [a,b,varargout]=exampl1() + a='first' + b='second' + varargout=list(1,2,3,4) +endfunction + +exampl1() +[a,b]=exampl1() +[a,b,c]=exampl1() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="argn">argn</link> + </member> + <member> + <link linkend="function">function</link> + </member> + <member> + <link linkend="list">list</link> + </member> + <member> + <link linkend="varargin">varargin</link> + </member> + </simplelist> + </refsection> +</refentry> |