File: function.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (167 lines) | stat: -rw-r--r-- 5,003 bytes parent folder | download
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?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-en.txt
 *
 -->
<refentry version="5.0-subset Scilab" xml:id="function" xml:lang="en"
          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">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>

  <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 = ""><![CDATA[ 
function <lhs_arguments>=<function_name><rhs_arguments>
<statements>
endfunction
 ]]></programlisting>

    <para>Onde</para>

    <variablelist>
      <varlistentry>
        <term>&lt;function_name&gt;</term>

        <listitem>
          <para> o nome da funo</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>&lt;rhs_arguments&gt;</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 varargin)</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>&lt;lhs_arguments&gt;</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 varargout)</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
              &lt;function_name&gt;&lt;rhs_arguments&gt;</literal></para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>&lt;statements&gt;</term>

        <listitem>
          <para>conjunto de instrues Scilab (declaraes). Esta sintaxe pode
          ser usada para definir funes (ver functions) inline ou em arquivo
          script (ver exec). 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 <literal>exec</literal>.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>A seqncia <literal>function
    &lt;lhs_arguments&gt;=&lt;function_name&gt;&lt;rhs_arguments&gt;</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>

    <para>Definies de funes podem ser aninhadas.</para>
  </refsection>

  <refsection>
    <title>Exemplos</title>

    <programlisting role="example"><![CDATA[ 
//definio inline (ver functions)
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>
    <title>Ver Tambm</title>

    <simplelist type="inline">
      <member><link linkend="functions">functions</link></member>

      <member><link linkend="exec">exec</link></member>

      <member><link linkend="exec">exec</link></member>
    </simplelist>
  </refsection>
</refentry>