summaryrefslogtreecommitdiff
path: root/modules/m2sci/help/en_US/Operation.xml
blob: 5f528f4add08b9e4845ab5c658e7cf7544f1cf35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) 2002-2004 - INRIA - Vincent COUVERT 
    * 
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at    
    * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
    *
    -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="Operation">
    <refnamediv>
        <refname>Operation</refname>
        <refpurpose>Create a tree representing an operation</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>op=Operation(operator,operands,out)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>operator</term>
                <listitem>
                    <para>operator symbol (character string)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>operands</term>
                <listitem>
                    <para>list of operands (list of "M2SCI tlists")</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>out</term>
                <listitem>
                    <para>list of outputs (list of "M2SCI tlists")</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>op</term>
                <listitem>
                    <para>an "operation" tlist</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            This function create a <literal>tlist</literal> representing an operation when using M2SCI.
            All input parameters values are verified to be compatible with "M2SCI tlists".
        </para>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="Funcall">Funcall</link>
            </member>
            <member>
                <link linkend="Variable">Variable</link>
            </member>
            <member>
                <link linkend="Cste">Cste</link>
            </member>
            <member>
                <link linkend="Infer">Infer</link>
            </member>
            <member>
                <link linkend="Contents">Contents</link>
            </member>
            <member>
                <link linkend="Type">Type</link>
            </member>
            <member>
                <link linkend="Equal">Equal</link>
            </member>
        </simplelist>
    </refsection>
</refentry>