22
22
* See the file ./license.txt
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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="SUMMATION">
26
<refname>SUMMATION</refname>
27
<refpurpose>Matrix Addition/Subtraction</refpurpose>
30
<title>Block Screenshot</title>
34
<imagedata align="center" fileref="../../../../images/palettes/SUMMATION.png" valign="middle"/>
39
<refsection id="Contents_SUMMATION">
40
<title>Contents</title>
44
<link linkend="SUMMATION">Matrix Summation</link>
51
<xref linkend="Palette_SUMMATION">Palette</xref>
56
<xref linkend="Description_SUMMATION">Description</xref>
61
<xref linkend="Dialogbox_SUMMATION">Dialog box</xref>
66
<xref linkend="Defaultproperties_SUMMATION">Default properties</xref>
71
<xref linkend="Interfacingfunction_SUMMATION">Interfacing function</xref>
76
<xref linkend="Computationalfunction_SUMMATION">Computational function</xref>
81
<xref linkend="Seealso_SUMMATION">See also</xref>
88
<refsection id="Palette_SUMMATION">
89
<title>Palette</title>
93
<link linkend="Mathoperations_pal">Math operations palette</link>
98
<refsection id="Description_SUMMATION">
99
<title>Description</title>
101
This block performs addition or subtraction on scalar, vector or matrix inputs. The input datatype
102
is set with the <emphasis role="bold">Datatype</emphasis> parameter. The <emphasis role="bold">
103
Number of inputs or sign vector
105
parameter defines the number of inputs and operation. For
106
a single vector's input the block collapse the elements of the vector. Vectors/matrices inputs
107
must have the same size.
109
<para>The behavior of the block is summarized in the following table :</para>
111
<informaltable border="1" cellpadding="2">
113
<td align="left" width="18%">
114
<emphasis role="bold">Number of inputs</emphasis>
116
<td align="left" width="20%">
117
<emphasis role="bold">Operation</emphasis>
120
<emphasis role="bold">Remarks</emphasis>
124
<td align="left">One</td>
125
<td align="left">y = (+/-)u</td>
127
<emphasis>u</emphasis> is a scalar value and the block has the behavior of a unitary gain.
131
<td align="left">One</td>
132
<td align="left">y = u[1]+u[2]+...+u[N]</td>
134
<emphasis>u</emphasis> is a vector or a matrix and the block output is the sum of the elements of the input
139
<td align="left">Two or more</td>
140
<td align="left">y = k[1]*u1+k[2]*u2+...+k[N]*uN</td>
142
<emphasis>k</emphasis> is the scalar or vector value write in the <emphasis role="bold">
143
Number of inputs or sign vector
145
parameter. For the addition of all inputs, simply set this
146
parameter to the number of inputs. To add/subtract the input <emphasis>ui</emphasis>, set in this
147
parameter a vector k with <emphasis>k[i]</emphasis> = +1 (addition) or -1 (subtraction)
148
for the input <emphasis>ui</emphasis>.
152
<para>With integer input, on overflow the result can take different forms:</para>
154
1- A normal non saturated result. By example, if type is int8 and the result 128, the block output
157
<para>2- A saturated result. For the previous example the block output value will be 127.</para>
158
<para>3- An error message warning the user about the overflow.</para>
160
The user can select one of these three forms by setting the
161
<emphasis role="bold">Do on Overflow</emphasis> field to 0,1 or 2.
165
<refsection id="Dialogbox_SUMMATION">
166
<title>Dialog box</title>
170
<imagedata align="center" fileref="../../../../images/gui/SUMMATION_gui.gif" valign="middle"/>
178
<emphasis role="bold">Datatype (1=real double 2=complex 3=int32 ...)</emphasis>
181
It indicates the type of the input/output data. It support all datatype, number must be between 1 and 8.
183
<para>Properties : Type 'vec' of size 1.</para>
187
<emphasis role="bold">Number of inputs or sign vector (of +1,-1)</emphasis>
190
It indicates the number of inputs and the operation see the description for more detail. If you set a value
191
other of -1 or +1, you get an error message box.
193
<para>Properties : Type 'vec' of size -1.</para>
197
<emphasis role="bold">Do on Overflow(0=Nothing 1=Saturate 2=Error)</emphasis>
199
<para>When this parameter is set to zero the result is similar to a
200
normal summation of two integer matrix. When it is set to 1, on
201
overflow the block saturate the result. When it is set to 2, on
202
overflow an error message box appears. If the Data type is double or
203
complex this parameter is not used.
205
<para>Properties : Type 'vec' of size 1.</para>
209
<refsection id="Defaultproperties_SUMMATION">
210
<title>Default properties</title>
214
<emphasis role="bold">always active:</emphasis> no
219
<emphasis role="bold">direct-feedthrough:</emphasis> yes
224
<emphasis role="bold">zero-crossing:</emphasis> no
229
<emphasis role="bold">mode:</emphasis> no
234
<emphasis role="bold">regular inputs:</emphasis>
237
<emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
240
<emphasis role="bold">- port 2 : size [-1,-2] / type 1</emphasis>
245
<emphasis role="bold">regular outputs:</emphasis>
248
<emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
253
<emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
258
<emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
263
<emphasis role="bold">continuous-time state:</emphasis> no
268
<emphasis role="bold">discrete-time state:</emphasis> no
273
<emphasis role="bold">object discrete-time state:</emphasis> no
278
<emphasis role="bold">name of computational function:</emphasis>
279
<emphasis role="italic">summation</emphasis>
284
<refsection id="Interfacingfunction_SUMMATION">
285
<title>Interfacing function</title>
288
<para>SCI/modules/scicos_blocks/macros/Linear/SUMMATION.sci</para>
292
<refsection id="Computationalfunction_SUMMATION">
293
<title>Computational function</title>
296
<para>SCI/modules/scicos_blocks/src/c/summation.c</para>
299
<para>SCI/modules/scicos_blocks/src/c/summation_z.c</para>
302
<para>SCI/modules/scicos_blocks/src/c/summation_i32n.c</para>
305
<para>SCI/modules/scicos_blocks/src/c/summation_i16n.c</para>
308
<para>SCI/modules/scicos_blocks/src/c/summation_i8n.c</para>
311
<para>SCI/modules/scicos_blocks/src/c/summation_ui32n.c</para>
314
<para>SCI/modules/scicos_blocks/src/c/summation_ui16n.c</para>
317
<para>SCI/modules/scicos_blocks/src/c/summation_ui8n.c</para>
320
<para>SCI/modules/scicos_blocks/src/c/summation_i32s.c</para>
323
<para>SCI/modules/scicos_blocks/src/c/summation_i16s.c</para>
326
<para>SCI/modules/scicos_blocks/src/c/summation_i8s.c</para>
329
<para>SCI/modules/scicos_blocks/src/c/summation_ui32s.c</para>
332
<para>SCI/modules/scicos_blocks/src/c/summation_ui16s.c</para>
335
<para>SCI/modules/scicos_blocks/src/c/summation_ui8s.c</para>
338
<para>SCI/modules/scicos_blocks/src/c/summation_i32e.c</para>
341
<para>SCI/modules/scicos_blocks/src/c/summation_i16e.c</para>
344
<para>SCI/modules/scicos_blocks/src/c/summation_i8e.c</para>
347
<para>SCI/modules/scicos_blocks/src/c/summation_ui32e.c</para>
350
<para>SCI/modules/scicos_blocks/src/c/summation_ui16e.c</para>
353
<para>SCI/modules/scicos_blocks/src/c/summation_ui8e.c</para>
357
<refsection id="Seealso_SUMMATION">
358
<title>See also</title>
362
<link linkend="BIGSOM_f">BIGSOM_f - Sclar/Vector Addition/Soustraction (Xcos block)</link>
367
<link linkend="SUM_f">SUM_f - Addition (Xcos block)</link>
26
<refname>SUMMATION</refname>
27
<refpurpose>Matrix Addition/Subtraction</refpurpose>
30
<title>Block Screenshot</title>
34
<imagedata align="center" fileref="../../../../images/palettes/SUMMATION.png" valign="middle"/>
39
<refsection id="Contents_SUMMATION">
40
<title>Contents</title>
44
<link linkend="SUMMATION">Matrix Summation</link>
51
<xref linkend="Palette_SUMMATION">Palette</xref>
56
<xref linkend="Description_SUMMATION">Description</xref>
61
<xref linkend="Dialogbox_SUMMATION">Dialog box</xref>
66
<xref linkend="Defaultproperties_SUMMATION">Default properties</xref>
71
<xref linkend="Interfacingfunction_SUMMATION">Interfacing function</xref>
76
<xref linkend="Computationalfunction_SUMMATION">Computational function</xref>
81
<xref linkend="Seealso_SUMMATION">See also</xref>
88
<refsection id="Palette_SUMMATION">
89
<title>Palette</title>
93
<link linkend="Mathoperations_pal">Math operations palette</link>
98
<refsection id="Description_SUMMATION">
99
<title>Description</title>
101
This block performs addition or subtraction on scalar, vector or matrix inputs. The input datatype
102
is set with the <emphasis role="bold">Datatype</emphasis> parameter. The <emphasis role="bold">
103
Number of inputs or sign vector
105
parameter defines the number of inputs and operation. For
106
a single vector's input the block collapse the elements of the vector. Vectors/matrices inputs
107
must have the same size.
109
<para>The behavior of the block is summarized in the following table :</para>
111
<informaltable border="1" cellpadding="2">
113
<td align="left" width="18%">
114
<emphasis role="bold">Number of inputs</emphasis>
116
<td align="left" width="20%">
117
<emphasis role="bold">Operation</emphasis>
120
<emphasis role="bold">Remarks</emphasis>
124
<td align="left">One</td>
125
<td align="left">y = (+/-)u</td>
127
<emphasis>u</emphasis> is a scalar value and the block has the behavior of a unitary gain.
131
<td align="left">One</td>
132
<td align="left">y = u[1]+u[2]+...+u[N]</td>
134
<emphasis>u</emphasis> is a vector or a matrix and the block output is the sum of the elements of the input
139
<td align="left">Two or more</td>
140
<td align="left">y = k[1]*u1+k[2]*u2+...+k[N]*uN</td>
142
<emphasis>k</emphasis> is the scalar or vector value write in the <emphasis role="bold">
143
Number of inputs or sign vector
145
parameter. For the addition of all inputs, simply set this
146
parameter to the number of inputs. To add/subtract the input <emphasis>ui</emphasis>, set in this
147
parameter a vector k with <emphasis>k[i]</emphasis> = +1 (addition) or -1 (subtraction)
148
for the input <emphasis>ui</emphasis>.
152
<para>With integer input, on overflow the result can take different forms:</para>
154
1- A normal non saturated result. By example, if type is int8 and the result 128, the block output
157
<para>2- A saturated result. For the previous example the block output value will be 127.</para>
158
<para>3- An error message warning the user about the overflow.</para>
160
The user can select one of these three forms by setting the
161
<emphasis role="bold">Do on Overflow</emphasis> field to 0,1 or 2.
165
<refsection id="Dialogbox_SUMMATION">
166
<title>Dialog box</title>
170
<imagedata align="center" fileref="../../../../images/gui/SUMMATION_gui.gif" valign="middle"/>
178
<emphasis role="bold">Datatype (1=real double 2=complex 3=int32 ...)</emphasis>
181
It indicates the type of the input/output data. It support all datatype, number must be between 1 and 8.
183
<para>Properties : Type 'vec' of size 1.</para>
187
<emphasis role="bold">Number of inputs or sign vector (of +1,-1)</emphasis>
190
It indicates the number of inputs and the operation see the description for more detail. If you set a value
191
other of -1 or +1, you get an error message box.
193
<para>Properties : Type 'vec' of size -1.</para>
197
<emphasis role="bold">Do on Overflow(0=Nothing 1=Saturate 2=Error)</emphasis>
199
<para>When this parameter is set to zero the result is similar to a
200
normal summation of two integer matrix. When it is set to 1, on
201
overflow the block saturate the result. When it is set to 2, on
202
overflow an error message box appears. If the Data type is double or
203
complex this parameter is not used.
205
<para>Properties : Type 'vec' of size 1.</para>
209
<refsection id="Defaultproperties_SUMMATION">
210
<title>Default properties</title>
214
<emphasis role="bold">always active:</emphasis> no
219
<emphasis role="bold">direct-feedthrough:</emphasis> yes
224
<emphasis role="bold">zero-crossing:</emphasis> no
229
<emphasis role="bold">mode:</emphasis> no
234
<emphasis role="bold">regular inputs:</emphasis>
237
<emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
240
<emphasis role="bold">- port 2 : size [-1,-2] / type 1</emphasis>
245
<emphasis role="bold">regular outputs:</emphasis>
248
<emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
253
<emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
258
<emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
263
<emphasis role="bold">continuous-time state:</emphasis> no
268
<emphasis role="bold">discrete-time state:</emphasis> no
273
<emphasis role="bold">object discrete-time state:</emphasis> no
278
<emphasis role="bold">name of computational function:</emphasis>
279
<emphasis role="italic">summation</emphasis>
284
<refsection id="Interfacingfunction_SUMMATION">
285
<title>Interfacing function</title>
288
<para>SCI/modules/scicos_blocks/macros/Linear/SUMMATION.sci</para>
292
<refsection id="Computationalfunction_SUMMATION">
293
<title>Computational function</title>
296
<para>SCI/modules/scicos_blocks/src/c/summation.c</para>
299
<para>SCI/modules/scicos_blocks/src/c/summation_z.c</para>
302
<para>SCI/modules/scicos_blocks/src/c/summation_i32n.c</para>
305
<para>SCI/modules/scicos_blocks/src/c/summation_i16n.c</para>
308
<para>SCI/modules/scicos_blocks/src/c/summation_i8n.c</para>
311
<para>SCI/modules/scicos_blocks/src/c/summation_ui32n.c</para>
314
<para>SCI/modules/scicos_blocks/src/c/summation_ui16n.c</para>
317
<para>SCI/modules/scicos_blocks/src/c/summation_ui8n.c</para>
320
<para>SCI/modules/scicos_blocks/src/c/summation_i32s.c</para>
323
<para>SCI/modules/scicos_blocks/src/c/summation_i16s.c</para>
326
<para>SCI/modules/scicos_blocks/src/c/summation_i8s.c</para>
329
<para>SCI/modules/scicos_blocks/src/c/summation_ui32s.c</para>
332
<para>SCI/modules/scicos_blocks/src/c/summation_ui16s.c</para>
335
<para>SCI/modules/scicos_blocks/src/c/summation_ui8s.c</para>
338
<para>SCI/modules/scicos_blocks/src/c/summation_i32e.c</para>
341
<para>SCI/modules/scicos_blocks/src/c/summation_i16e.c</para>
344
<para>SCI/modules/scicos_blocks/src/c/summation_i8e.c</para>
347
<para>SCI/modules/scicos_blocks/src/c/summation_ui32e.c</para>
350
<para>SCI/modules/scicos_blocks/src/c/summation_ui16e.c</para>
353
<para>SCI/modules/scicos_blocks/src/c/summation_ui8e.c</para>
357
<refsection id="Seealso_SUMMATION">
358
<title>See also</title>
362
<link linkend="BIGSOM_f">BIGSOM_f - Sclar/Vector Addition/Soustraction (Xcos block)</link>
367
<link linkend="SUM_f">SUM_f - Addition (Xcos block)</link>