← 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/Mathoperations_pal/MAXMIN.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/Mathoperations_pal/MAXMIN.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="MAXMIN">
25
 
  <refnamediv>
26
 
    <refname>MAXMIN</refname>
27
 
    <refpurpose>Maximum or minimum value of vectors's elements</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/MAXMIN.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_MAXMIN">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="MAXMIN">Maximum or minimum value of vectors's elements</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_MAXMIN">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_MAXMIN">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_MAXMIN">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_MAXMIN">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_MAXMIN">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_MAXMIN">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Seealso_MAXMIN">See also</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_MAXMIN">
89
 
    <title>Palette</title>
90
 
    <itemizedlist>
91
 
      <listitem>
92
 
        <para>
93
 
          <link linkend="Mathoperations_pal">Math operations palette</link>
94
 
        </para>
95
 
      </listitem>
96
 
    </itemizedlist>
97
 
  </refsection>
98
 
  <refsection id="Description_MAXMIN">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      This block finds the minimum/maximum values (parameter <emphasis role="bold">Min or Max</emphasis>) and accepts one or two inputs depending on the parameter <emphasis role="bold">Number of input vectors</emphasis> :
102
 
    </para>
103
 
    <para/>
104
 
    <informaltable border="1" cellpadding="2">
105
 
      <tr>
106
 
        <td align="left">
107
 
          <emphasis role="bold">Number of input vectors</emphasis>
108
 
        </td>
109
 
        <td align="left">
110
 
          <emphasis role="bold">Input</emphasis>
111
 
        </td>
112
 
        <td align="left">
113
 
          <emphasis role="bold">Operation</emphasis>
114
 
        </td>
115
 
      </tr>
116
 
      <tr>
117
 
        <td align="left">
118
 
          <emphasis role="bold">1</emphasis>
119
 
        </td>
120
 
        <td align="left">Vector</td>
121
 
        <td align="left">
122
 
          The input must be a vector and the bloc output is the minimum/maximum value of the elements of its input vector.
123
 
        </td>
124
 
      </tr>
125
 
      <tr>
126
 
        <td align="left">
127
 
          <emphasis role="bold">2</emphasis>
128
 
        </td>
129
 
        <td align="left">Scalar</td>
130
 
        <td align="left">The block output is the minimal or maximal scalar.</td>
131
 
      </tr>
132
 
      <tr>
133
 
        <td align="left">
134
 
          <emphasis role="bold">2</emphasis>
135
 
        </td>
136
 
        <td align="left">Vector</td>
137
 
        <td align="left">
138
 
          The input vectors must have the same size. The block output is a vector with the same size as
139
 
          inputs.The elements of the output vector are the minimum/maximum elements of the corresponding
140
 
          elements of the inputs.
141
 
        </td>
142
 
      </tr>
143
 
    </informaltable>
144
 
  </refsection>
145
 
  <refsection id="Dialogbox_MAXMIN">
146
 
    <title>Dialog box</title>
147
 
    <para>
148
 
      <inlinemediaobject>
149
 
        <imageobject>
150
 
          <imagedata fileref="../../../../images/gui/MAXMIN_gui.gif" align="center" valign="middle"/>
151
 
        </imageobject>
152
 
      </inlinemediaobject>
153
 
    </para>
154
 
    <para>
155
 
      
156
 
    </para>
157
 
    <itemizedlist>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">Min or Max</emphasis>
161
 
        </para>
162
 
        <para> The function (min or max) to apply to the input.</para>
163
 
        <para> Properties : Type 'vec' of size 1. </para>
164
 
      </listitem>
165
 
      <listitem>
166
 
        <para>
167
 
          <emphasis role="bold">Number of input vectors</emphasis>
168
 
        </para>
169
 
        <para> The number of inputs to the block.</para>
170
 
        <para> Properties : Type 'vec' of size 1. </para>
171
 
      </listitem>
172
 
      <listitem>
173
 
        <para>
174
 
          <emphasis role="bold">zero-crossing</emphasis>
175
 
        </para>
176
 
        <para> Select to enable zero crossing detection to detect minimum and maximum values.</para>
177
 
        <para> Properties : Type 'vec' of size 1. </para>
178
 
      </listitem>
179
 
    </itemizedlist>
180
 
  </refsection>
181
 
  <refsection id="Defaultproperties_MAXMIN">
182
 
    <title>Default properties</title>
183
 
    <itemizedlist>
184
 
      <listitem>
185
 
        <para>
186
 
          <emphasis role="bold">always active:</emphasis> no
187
 
        </para>
188
 
      </listitem>
189
 
      <listitem>
190
 
        <para>
191
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
192
 
        </para>
193
 
      </listitem>
194
 
      <listitem>
195
 
        <para>
196
 
          <emphasis role="bold">zero-crossing:</emphasis> no
197
 
        </para>
198
 
      </listitem>
199
 
      <listitem>
200
 
        <para>
201
 
          <emphasis role="bold">mode:</emphasis> no
202
 
        </para>
203
 
      </listitem>
204
 
      <listitem>
205
 
        <para>
206
 
          <emphasis role="bold">regular inputs:</emphasis>
207
 
        </para>
208
 
        <para>
209
 
          <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
210
 
        </para>
211
 
      </listitem>
212
 
      <listitem>
213
 
        <para>
214
 
          <emphasis role="bold">regular outputs:</emphasis>
215
 
        </para>
216
 
        <para>
217
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
218
 
        </para>
219
 
      </listitem>
220
 
      <listitem>
221
 
        <para>
222
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
223
 
        </para>
224
 
      </listitem>
225
 
      <listitem>
226
 
        <para>
227
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
228
 
        </para>
229
 
      </listitem>
230
 
      <listitem>
231
 
        <para>
232
 
          <emphasis role="bold">continuous-time state:</emphasis> no
233
 
        </para>
234
 
      </listitem>
235
 
      <listitem>
236
 
        <para>
237
 
          <emphasis role="bold">discrete-time state:</emphasis> no
238
 
        </para>
239
 
      </listitem>
240
 
      <listitem>
241
 
        <para>
242
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
243
 
        </para>
244
 
      </listitem>
245
 
      <listitem>
246
 
        <para>
247
 
          <emphasis role="bold">name of computational function:</emphasis>
248
 
          <emphasis role="italic">minmax</emphasis>
249
 
        </para>
250
 
      </listitem>
251
 
    </itemizedlist>
252
 
  </refsection>
253
 
  <refsection id="Interfacingfunction_MAXMIN">
254
 
    <title>Interfacing function</title>
255
 
    <itemizedlist>
256
 
      <listitem>
257
 
        <para> SCI/modules/scicos_blocks/macros/NonLinear/MAXMIN.sci</para>
258
 
      </listitem>
259
 
    </itemizedlist>
260
 
  </refsection>
261
 
  <refsection id="Computationalfunction_MAXMIN">
262
 
    <title>Computational function</title>
263
 
    <itemizedlist>
264
 
      <listitem>
265
 
        <para> SCI/modules/scicos_blocks/src/c/minmax.c (Type 4)</para>
266
 
      </listitem>
267
 
    </itemizedlist>
268
 
  </refsection>
269
 
  <refsection id="Seealso_MAXMIN">
270
 
    <title>See also</title>
271
 
    <itemizedlist>
272
 
      <listitem>
273
 
        <para>
274
 
          <link linkend="MIN_f">MIN_f - Minimum value of vector's element (Xcos block)</link>
275
 
        </para>
276
 
      </listitem>
277
 
      <listitem>
278
 
        <para>
279
 
          <link linkend="MAX_f">MAX_f - Maximum value of vector's elements (Xcos block)</link>
280
 
        </para>
281
 
      </listitem>
282
 
    </itemizedlist>
283
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>MAXMIN</refname>
 
27
        <refpurpose>Maximum or minimum value of vectors's elements</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/MAXMIN.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_MAXMIN">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="MAXMIN">Maximum or minimum value of vectors's elements</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_MAXMIN">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_MAXMIN">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_MAXMIN">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_MAXMIN">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_MAXMIN">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_MAXMIN">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Seealso_MAXMIN">See also</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_MAXMIN">
 
89
        <title>Palette</title>
 
90
        <itemizedlist>
 
91
            <listitem>
 
92
                <para>
 
93
                    <link linkend="Mathoperations_pal">Math operations palette</link>
 
94
                </para>
 
95
            </listitem>
 
96
        </itemizedlist>
 
97
    </refsection>
 
98
    <refsection id="Description_MAXMIN">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            This block finds the minimum/maximum values (parameter <emphasis role="bold">Min or Max</emphasis>) and accepts one or two inputs depending on the parameter <emphasis role="bold">Number of input vectors</emphasis> :
 
102
        </para>
 
103
        <para/>
 
104
        <informaltable border="1" cellpadding="2">
 
105
            <tr>
 
106
                <td align="left">
 
107
                    <emphasis role="bold">Number of input vectors</emphasis>
 
108
                </td>
 
109
                <td align="left">
 
110
                    <emphasis role="bold">Input</emphasis>
 
111
                </td>
 
112
                <td align="left">
 
113
                    <emphasis role="bold">Operation</emphasis>
 
114
                </td>
 
115
            </tr>
 
116
            <tr>
 
117
                <td align="left">
 
118
                    <emphasis role="bold">1</emphasis>
 
119
                </td>
 
120
                <td align="left">Vector</td>
 
121
                <td align="left">
 
122
                    The input must be a vector and the bloc output is the minimum/maximum value of the elements of its input vector.
 
123
                </td>
 
124
            </tr>
 
125
            <tr>
 
126
                <td align="left">
 
127
                    <emphasis role="bold">2</emphasis>
 
128
                </td>
 
129
                <td align="left">Scalar</td>
 
130
                <td align="left">The block output is the minimal or maximal scalar.</td>
 
131
            </tr>
 
132
            <tr>
 
133
                <td align="left">
 
134
                    <emphasis role="bold">2</emphasis>
 
135
                </td>
 
136
                <td align="left">Vector</td>
 
137
                <td align="left">
 
138
                    The input vectors must have the same size. The block output is a vector with the same size as
 
139
                    inputs.The elements of the output vector are the minimum/maximum elements of the corresponding
 
140
                    elements of the inputs.
 
141
                </td>
 
142
            </tr>
 
143
        </informaltable>
 
144
    </refsection>
 
145
    <refsection id="Dialogbox_MAXMIN">
 
146
        <title>Dialog box</title>
 
147
        <para>
 
148
            <inlinemediaobject>
 
149
                <imageobject>
 
150
                    <imagedata fileref="../../../../images/gui/MAXMIN_gui.gif" align="center" valign="middle"/>
 
151
                </imageobject>
 
152
            </inlinemediaobject>
 
153
        </para>
 
154
        <para>
 
155
            
 
156
        </para>
 
157
        <itemizedlist>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">Min or Max</emphasis>
 
161
                </para>
 
162
                <para> The function (min or max) to apply to the input.</para>
 
163
                <para> Properties : Type 'vec' of size 1. </para>
 
164
            </listitem>
 
165
            <listitem>
 
166
                <para>
 
167
                    <emphasis role="bold">Number of input vectors</emphasis>
 
168
                </para>
 
169
                <para> The number of inputs to the block.</para>
 
170
                <para> Properties : Type 'vec' of size 1. </para>
 
171
            </listitem>
 
172
            <listitem>
 
173
                <para>
 
174
                    <emphasis role="bold">zero-crossing</emphasis>
 
175
                </para>
 
176
                <para> Select to enable zero crossing detection to detect minimum and maximum values.</para>
 
177
                <para> Properties : Type 'vec' of size 1. </para>
 
178
            </listitem>
 
179
        </itemizedlist>
 
180
    </refsection>
 
181
    <refsection id="Defaultproperties_MAXMIN">
 
182
        <title>Default properties</title>
 
183
        <itemizedlist>
 
184
            <listitem>
 
185
                <para>
 
186
                    <emphasis role="bold">always active:</emphasis> no
 
187
                </para>
 
188
            </listitem>
 
189
            <listitem>
 
190
                <para>
 
191
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
192
                </para>
 
193
            </listitem>
 
194
            <listitem>
 
195
                <para>
 
196
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
197
                </para>
 
198
            </listitem>
 
199
            <listitem>
 
200
                <para>
 
201
                    <emphasis role="bold">mode:</emphasis> no
 
202
                </para>
 
203
            </listitem>
 
204
            <listitem>
 
205
                <para>
 
206
                    <emphasis role="bold">regular inputs:</emphasis>
 
207
                </para>
 
208
                <para>
 
209
                    <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
 
210
                </para>
 
211
            </listitem>
 
212
            <listitem>
 
213
                <para>
 
214
                    <emphasis role="bold">regular outputs:</emphasis>
 
215
                </para>
 
216
                <para>
 
217
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
218
                </para>
 
219
            </listitem>
 
220
            <listitem>
 
221
                <para>
 
222
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
223
                </para>
 
224
            </listitem>
 
225
            <listitem>
 
226
                <para>
 
227
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
228
                </para>
 
229
            </listitem>
 
230
            <listitem>
 
231
                <para>
 
232
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
233
                </para>
 
234
            </listitem>
 
235
            <listitem>
 
236
                <para>
 
237
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
238
                </para>
 
239
            </listitem>
 
240
            <listitem>
 
241
                <para>
 
242
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
243
                </para>
 
244
            </listitem>
 
245
            <listitem>
 
246
                <para>
 
247
                    <emphasis role="bold">name of computational function:</emphasis>
 
248
                    <emphasis role="italic">minmax</emphasis>
 
249
                </para>
 
250
            </listitem>
 
251
        </itemizedlist>
 
252
    </refsection>
 
253
    <refsection id="Interfacingfunction_MAXMIN">
 
254
        <title>Interfacing function</title>
 
255
        <itemizedlist>
 
256
            <listitem>
 
257
                <para> SCI/modules/scicos_blocks/macros/NonLinear/MAXMIN.sci</para>
 
258
            </listitem>
 
259
        </itemizedlist>
 
260
    </refsection>
 
261
    <refsection id="Computationalfunction_MAXMIN">
 
262
        <title>Computational function</title>
 
263
        <itemizedlist>
 
264
            <listitem>
 
265
                <para> SCI/modules/scicos_blocks/src/c/minmax.c (Type 4)</para>
 
266
            </listitem>
 
267
        </itemizedlist>
 
268
    </refsection>
 
269
    <refsection id="Seealso_MAXMIN">
 
270
        <title>See also</title>
 
271
        <itemizedlist>
 
272
            <listitem>
 
273
                <para>
 
274
                    <link linkend="MIN_f">MIN_f - Minimum value of vector's element (Xcos block)</link>
 
275
                </para>
 
276
            </listitem>
 
277
            <listitem>
 
278
                <para>
 
279
                    <link linkend="MAX_f">MAX_f - Maximum value of vector's elements (Xcos block)</link>
 
280
                </para>
 
281
            </listitem>
 
282
        </itemizedlist>
 
283
    </refsection>
284
284
</refentry>