← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/palettes/Userdefinedfunctions_pal/EXPRESSION.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/palettes/Userdefinedfunctions_pal/EXPRESSION.xml
22
22
 * See the file ./license.txt
23
23
 -->
24
24
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="EXPRESSION">
25
 
  <refnamediv>
26
 
    <refname>EXPRESSION</refname>
27
 
    <refpurpose>Mathematical expression</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/EXPRESSION.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_EXPRESSION">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="EXPRESSION">Mathematical expression</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_EXPRESSION">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_EXPRESSION">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_EXPRESSION">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_EXPRESSION">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Example_EXPRESSION">Example</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Interfacingfunction_EXPRESSION">Interfacing function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
        </itemizedlist>
80
 
      </listitem>
81
 
    </itemizedlist>
82
 
  </refsection>
83
 
  <refsection id="Palette_EXPRESSION">
84
 
    <title>Palette</title>
85
 
    <itemizedlist>
86
 
      <listitem>
87
 
        <para>
88
 
          <link linkend="Userdefinedfunctions_pal">User defined functions palette</link>
89
 
        </para>
90
 
      </listitem>
91
 
    </itemizedlist>
92
 
  </refsection>
93
 
  <refsection id="Description_EXPRESSION">
94
 
    <title>Description</title>
95
 
    <para>
96
 
      The Expression block applies the specified Scilab expressions to its input.
97
 
    </para>
98
 
  </refsection>
99
 
  <refsection id="Dialogbox_EXPRESSION">
100
 
    <title>Dialog box</title>
101
 
    <para>
102
 
      <inlinemediaobject>
103
 
        <imageobject>
104
 
          <imagedata fileref="../../../gui/userdefinedfunctions_pal/en_US/EXPRESSION_gui.png" align="center" valign="middle"/>
105
 
        </imageobject>
106
 
      </inlinemediaobject>
107
 
    </para>
108
 
    <para>
109
 
      
110
 
    </para>
111
 
    <itemizedlist>
112
 
      <listitem>
113
 
        <para>
114
 
          <emphasis role="bold">number of inputs</emphasis>
115
 
        </para>
116
 
        <para> Block input can be a scalar or vector.</para>
117
 
        <para> Properties : Type 'vec' of size 1 </para>
118
 
      </listitem>
119
 
      <listitem>
120
 
        <para>
121
 
          <emphasis role="bold">scilab expression</emphasis>
122
 
        </para>
123
 
        <para> The Scilab expression applied to the input.</para>
124
 
        <para> Properties : Type 'vec' of size 1 </para>
125
 
      </listitem>
126
 
      <listitem>
127
 
        <para>
128
 
          <emphasis role="bold">use zero-crossing</emphasis>
129
 
        </para>
130
 
        <para> Select to enable zero crossing detection.</para>
131
 
        <para> Properties : Type 'vec' of size 1</para>
132
 
      </listitem>
133
 
    </itemizedlist>
134
 
  </refsection>
135
 
  <refsection id="Defaultproperties_EXPRESSION">
136
 
    <title>Default properties</title>
137
 
    <itemizedlist>
138
 
      <listitem>
139
 
        <para>
140
 
          <emphasis role="bold">always active:</emphasis> no
141
 
        </para>
142
 
      </listitem>
143
 
      <listitem>
144
 
        <para>
145
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
146
 
        </para>
147
 
      </listitem>
148
 
      <listitem>
149
 
        <para>
150
 
          <emphasis role="bold">zero-crossing:</emphasis> yes
151
 
        </para>
152
 
      </listitem>
153
 
      <listitem>
154
 
        <para>
155
 
          <emphasis role="bold">mode:</emphasis> yes
156
 
        </para>
157
 
      </listitem>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">regular inputs:</emphasis>
161
 
        </para>
162
 
        <para>
163
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
164
 
        </para>
165
 
        <para>
166
 
          <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
167
 
        </para>
168
 
      </listitem>
169
 
      <listitem>
170
 
        <para>
171
 
          <emphasis role="bold">regular outputs:</emphasis>
172
 
        </para>
173
 
        <para>
174
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
175
 
        </para>
176
 
      </listitem>
177
 
      <listitem>
178
 
        <para>
179
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
180
 
        </para>
181
 
      </listitem>
182
 
      <listitem>
183
 
        <para>
184
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
185
 
        </para>
186
 
      </listitem>
187
 
      <listitem>
188
 
        <para>
189
 
          <emphasis role="bold">continuous-time state:</emphasis> no
190
 
        </para>
191
 
      </listitem>
192
 
      <listitem>
193
 
        <para>
194
 
          <emphasis role="bold">discrete-time state:</emphasis> no
195
 
        </para>
196
 
      </listitem>
197
 
      <listitem>
198
 
        <para>
199
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
200
 
        </para>
201
 
      </listitem>
202
 
      <listitem>
203
 
        <para>
204
 
          <emphasis role="bold">name of computational function:</emphasis>
205
 
          <emphasis role="italic">evaluate_expr</emphasis>
206
 
        </para>
207
 
      </listitem>
208
 
    </itemizedlist>
209
 
  </refsection>
210
 
  <refsection id="Example_EXPRESSION">
211
 
    <title>Example</title>
212
 
    <para>
213
 
      The following example calculate an arbitrary expression with multiple different configuration or blocks.
214
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/userdefinedfunctions_pal/en_US/EXPRESSION_en_US.xcos">
215
 
        Open this example in Xcos
216
 
      </link>
217
 
    </para>
218
 
    <para>
219
 
      <latex>y=u(1) - u(2) - u(3)</latex>
220
 
    </para>
221
 
    <para/>
222
 
    <mediaobject>
223
 
      <imageobject>
224
 
        <imagedata fileref="../../../examples/userdefinedfunctions_pal/en_US/EXPRESSION_diagram_en_US.png" align="center"/>
225
 
      </imageobject>
226
 
    </mediaobject>
227
 
    <mediaobject>
228
 
      <imageobject>
229
 
        <imagedata fileref="../../../examples/userdefinedfunctions_pal/en_US/EXPRESSION_scope_en_US.png" align="center"/>
230
 
      </imageobject>
231
 
    </mediaobject>
232
 
  </refsection>
233
 
  <refsection id="Interfacingfunction_EXPRESSION">
234
 
    <title>Interfacing function</title>
235
 
    <itemizedlist>
236
 
      <listitem>
237
 
        <para> SCI/modules/scicos_blocks/macros/Misc/EXPRESSION.sci</para>
238
 
      </listitem>
239
 
    </itemizedlist>
240
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>EXPRESSION</refname>
 
27
        <refpurpose>Mathematical expression</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/EXPRESSION.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_EXPRESSION">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="EXPRESSION">Mathematical expression</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_EXPRESSION">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_EXPRESSION">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_EXPRESSION">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_EXPRESSION">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Example_EXPRESSION">Example</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Interfacingfunction_EXPRESSION">Interfacing function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                </itemizedlist>
 
80
            </listitem>
 
81
        </itemizedlist>
 
82
    </refsection>
 
83
    <refsection id="Palette_EXPRESSION">
 
84
        <title>Palette</title>
 
85
        <itemizedlist>
 
86
            <listitem>
 
87
                <para>
 
88
                    <link linkend="Userdefinedfunctions_pal">User defined functions palette</link>
 
89
                </para>
 
90
            </listitem>
 
91
        </itemizedlist>
 
92
    </refsection>
 
93
    <refsection id="Description_EXPRESSION">
 
94
        <title>Description</title>
 
95
        <para>
 
96
            The Expression block applies the specified Scilab expressions to its input.
 
97
        </para>
 
98
    </refsection>
 
99
    <refsection id="Dialogbox_EXPRESSION">
 
100
        <title>Dialog box</title>
 
101
        <para>
 
102
            <inlinemediaobject>
 
103
                <imageobject>
 
104
                    <imagedata fileref="../../../gui/userdefinedfunctions_pal/en_US/EXPRESSION_gui.png" align="center" valign="middle"/>
 
105
                </imageobject>
 
106
            </inlinemediaobject>
 
107
        </para>
 
108
        <para>
 
109
            
 
110
        </para>
 
111
        <itemizedlist>
 
112
            <listitem>
 
113
                <para>
 
114
                    <emphasis role="bold">number of inputs</emphasis>
 
115
                </para>
 
116
                <para> Block input can be a scalar or vector.</para>
 
117
                <para> Properties : Type 'vec' of size 1 </para>
 
118
            </listitem>
 
119
            <listitem>
 
120
                <para>
 
121
                    <emphasis role="bold">scilab expression</emphasis>
 
122
                </para>
 
123
                <para> The Scilab expression applied to the input.</para>
 
124
                <para> Properties : Type 'vec' of size 1 </para>
 
125
            </listitem>
 
126
            <listitem>
 
127
                <para>
 
128
                    <emphasis role="bold">use zero-crossing</emphasis>
 
129
                </para>
 
130
                <para> Select to enable zero crossing detection.</para>
 
131
                <para> Properties : Type 'vec' of size 1</para>
 
132
            </listitem>
 
133
        </itemizedlist>
 
134
    </refsection>
 
135
    <refsection id="Defaultproperties_EXPRESSION">
 
136
        <title>Default properties</title>
 
137
        <itemizedlist>
 
138
            <listitem>
 
139
                <para>
 
140
                    <emphasis role="bold">always active:</emphasis> no
 
141
                </para>
 
142
            </listitem>
 
143
            <listitem>
 
144
                <para>
 
145
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
146
                </para>
 
147
            </listitem>
 
148
            <listitem>
 
149
                <para>
 
150
                    <emphasis role="bold">zero-crossing:</emphasis> yes
 
151
                </para>
 
152
            </listitem>
 
153
            <listitem>
 
154
                <para>
 
155
                    <emphasis role="bold">mode:</emphasis> yes
 
156
                </para>
 
157
            </listitem>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">regular inputs:</emphasis>
 
161
                </para>
 
162
                <para>
 
163
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
164
                </para>
 
165
                <para>
 
166
                    <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
 
167
                </para>
 
168
            </listitem>
 
169
            <listitem>
 
170
                <para>
 
171
                    <emphasis role="bold">regular outputs:</emphasis>
 
172
                </para>
 
173
                <para>
 
174
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
175
                </para>
 
176
            </listitem>
 
177
            <listitem>
 
178
                <para>
 
179
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
180
                </para>
 
181
            </listitem>
 
182
            <listitem>
 
183
                <para>
 
184
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
185
                </para>
 
186
            </listitem>
 
187
            <listitem>
 
188
                <para>
 
189
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
190
                </para>
 
191
            </listitem>
 
192
            <listitem>
 
193
                <para>
 
194
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
195
                </para>
 
196
            </listitem>
 
197
            <listitem>
 
198
                <para>
 
199
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
200
                </para>
 
201
            </listitem>
 
202
            <listitem>
 
203
                <para>
 
204
                    <emphasis role="bold">name of computational function:</emphasis>
 
205
                    <emphasis role="italic">evaluate_expr</emphasis>
 
206
                </para>
 
207
            </listitem>
 
208
        </itemizedlist>
 
209
    </refsection>
 
210
    <refsection id="Example_EXPRESSION">
 
211
        <title>Example</title>
 
212
        <para>
 
213
            The following example calculate an arbitrary expression with multiple different configuration or blocks.
 
214
            <link type="scilab" linkend="scilab.xcos/xcos/examples/userdefinedfunctions_pal/en_US/EXPRESSION_en_US.xcos">
 
215
                Open this example in Xcos
 
216
            </link>
 
217
        </para>
 
218
        <para>
 
219
            <latex>y=u(1) - u(2) - u(3)</latex>
 
220
        </para>
 
221
        <para/>
 
222
        <mediaobject>
 
223
            <imageobject>
 
224
                <imagedata fileref="../../../examples/userdefinedfunctions_pal/en_US/EXPRESSION_diagram_en_US.png" align="center"/>
 
225
            </imageobject>
 
226
        </mediaobject>
 
227
        <mediaobject>
 
228
            <imageobject>
 
229
                <imagedata fileref="../../../examples/userdefinedfunctions_pal/en_US/EXPRESSION_scope_en_US.png" align="center"/>
 
230
            </imageobject>
 
231
        </mediaobject>
 
232
    </refsection>
 
233
    <refsection id="Interfacingfunction_EXPRESSION">
 
234
        <title>Interfacing function</title>
 
235
        <itemizedlist>
 
236
            <listitem>
 
237
                <para> SCI/modules/scicos_blocks/macros/Misc/EXPRESSION.sci</para>
 
238
            </listitem>
 
239
        </itemizedlist>
 
240
    </refsection>
241
241
</refentry>