← 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/SQRT.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/SQRT.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:ns5="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="SQRT">
25
 
  <refnamediv>
26
 
    <refname>SQRT</refname>
27
 
    <refpurpose>Square root</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata align="center" fileref="../../../../images/palettes/SQRT.png" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_SQRT">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="SQRT">Square root</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_SQRT">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_SQRT">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_SQRT">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_SQRT">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_SQRT">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_SQRT">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Seealso_SQRT">See also</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_SQRT">
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_SQRT">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      This block computes the square root of each element of the input matrix. It support double
102
 
      and complex data types (<emphasis role="bold">Datatype</emphasis> parameter).
103
 
    </para>
104
 
  </refsection>
105
 
  <refsection id="Dialogbox_SQRT">
106
 
    <title>Dialog box</title>
107
 
    <para>
108
 
      <inlinemediaobject>
109
 
        <imageobject>
110
 
          <imagedata align="center" fileref="../../../../images/gui/SQRT_gui.gif" valign="middle"/>
111
 
        </imageobject>
112
 
      </inlinemediaobject>
113
 
    </para>
114
 
    <para/>
115
 
    <itemizedlist>
116
 
      <listitem>
117
 
        <para>
118
 
          <emphasis role="bold">Datatype (1=real double 2=Complex)</emphasis>
119
 
        </para>
120
 
        <para>
121
 
          It indicates the type of the output. It support only the two
122
 
          types double (1) and complex (2). If we input another entry in this
123
 
          label Xcos will print the message "Datatype is not supported".
124
 
        </para>
125
 
        <para>Properties : Type 'vec' of size 1.</para>
126
 
      </listitem>
127
 
    </itemizedlist>
128
 
  </refsection>
129
 
  <refsection id="Defaultproperties_SQRT">
130
 
    <title>Default properties</title>
131
 
    <itemizedlist>
132
 
      <listitem>
133
 
        <para>
134
 
          <emphasis role="bold">always active:</emphasis> no
135
 
        </para>
136
 
      </listitem>
137
 
      <listitem>
138
 
        <para>
139
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
140
 
        </para>
141
 
      </listitem>
142
 
      <listitem>
143
 
        <para>
144
 
          <emphasis role="bold">zero-crossing:</emphasis> no
145
 
        </para>
146
 
      </listitem>
147
 
      <listitem>
148
 
        <para>
149
 
          <emphasis role="bold">mode:</emphasis> no
150
 
        </para>
151
 
      </listitem>
152
 
      <listitem>
153
 
        <para>
154
 
          <emphasis role="bold">regular inputs:</emphasis>
155
 
        </para>
156
 
        <para>
157
 
          <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
158
 
        </para>
159
 
      </listitem>
160
 
      <listitem>
161
 
        <para>
162
 
          <emphasis role="bold">regular outputs:</emphasis>
163
 
        </para>
164
 
        <para>
165
 
          <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
166
 
        </para>
167
 
      </listitem>
168
 
      <listitem>
169
 
        <para>
170
 
          <emphasis role="bold">number/sizes of activation
171
 
            inputs:
172
 
          </emphasis>
173
 
          0
174
 
        </para>
175
 
      </listitem>
176
 
      <listitem>
177
 
        <para>
178
 
          <emphasis role="bold">number/sizes of activation
179
 
            outputs:
180
 
          </emphasis>
181
 
          0
182
 
        </para>
183
 
      </listitem>
184
 
      <listitem>
185
 
        <para>
186
 
          <emphasis role="bold">continuous-time state:</emphasis>
187
 
          no
188
 
        </para>
189
 
      </listitem>
190
 
      <listitem>
191
 
        <para>
192
 
          <emphasis role="bold">discrete-time state:</emphasis> no
193
 
        </para>
194
 
      </listitem>
195
 
      <listitem>
196
 
        <para>
197
 
          <emphasis role="bold">object discrete-time state:</emphasis>
198
 
          no
199
 
        </para>
200
 
      </listitem>
201
 
      <listitem>
202
 
        <para>
203
 
          <emphasis role="bold">name of computational function:</emphasis>
204
 
          <emphasis role="italic">mat_sqrt</emphasis>
205
 
        </para>
206
 
      </listitem>
207
 
    </itemizedlist>
208
 
  </refsection>
209
 
  <refsection id="Interfacingfunction_SQRT">
210
 
    <title>Interfacing function</title>
211
 
    <itemizedlist>
212
 
      <listitem>
213
 
        <para>SCI/modules/scicos_blocks/macros/MatrixOp/SQRT.sci</para>
214
 
      </listitem>
215
 
    </itemizedlist>
216
 
  </refsection>
217
 
  <refsection id="Computationalfunction_SQRT">
218
 
    <title>Computational function</title>
219
 
    <itemizedlist>
220
 
      <listitem>
221
 
        <para>SCI/modules/scicos_blocks/src/c/mat_sqrt.c</para>
222
 
      </listitem>
223
 
      <listitem>
224
 
        <para>SCI/modules/scicos_blocks/src/c/matz_sqrt.c</para>
225
 
      </listitem>
226
 
    </itemizedlist>
227
 
  </refsection>
228
 
  <refsection id="Seealso_SQRT">
229
 
    <title>See also</title>
230
 
    <itemizedlist>
231
 
      <listitem>
232
 
        <para>
233
 
          <link linkend="POWBLK_f">POWBLK_f - Array power</link>
234
 
        </para>
235
 
      </listitem>
236
 
      <listitem>
237
 
        <para>
238
 
          <link linkend="EXPBLK_m">EXPBLK_m - Exponential of a scalar (Bloc Xcos)</link>
239
 
        </para>
240
 
      </listitem>
241
 
      <listitem>
242
 
        <para>
243
 
          <link linkend="LOGBLK_f">LOGBLK_m - Logarithm (Bloc Xcos)</link>
244
 
        </para>
245
 
      </listitem>
246
 
    </itemizedlist>
247
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>SQRT</refname>
 
27
        <refpurpose>Square root</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata align="center" fileref="../../../../images/palettes/SQRT.png" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_SQRT">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="SQRT">Square root</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_SQRT">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_SQRT">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_SQRT">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_SQRT">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_SQRT">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_SQRT">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Seealso_SQRT">See also</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_SQRT">
 
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_SQRT">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            This block computes the square root of each element of the input matrix. It support double
 
102
            and complex data types (<emphasis role="bold">Datatype</emphasis> parameter).
 
103
        </para>
 
104
    </refsection>
 
105
    <refsection id="Dialogbox_SQRT">
 
106
        <title>Dialog box</title>
 
107
        <para>
 
108
            <inlinemediaobject>
 
109
                <imageobject>
 
110
                    <imagedata align="center" fileref="../../../../images/gui/SQRT_gui.gif" valign="middle"/>
 
111
                </imageobject>
 
112
            </inlinemediaobject>
 
113
        </para>
 
114
        <para/>
 
115
        <itemizedlist>
 
116
            <listitem>
 
117
                <para>
 
118
                    <emphasis role="bold">Datatype (1=real double 2=Complex)</emphasis>
 
119
                </para>
 
120
                <para>
 
121
                    It indicates the type of the output. It support only the two
 
122
                    types double (1) and complex (2). If we input another entry in this
 
123
                    label Xcos will print the message "Datatype is not supported".
 
124
                </para>
 
125
                <para>Properties : Type 'vec' of size 1.</para>
 
126
            </listitem>
 
127
        </itemizedlist>
 
128
    </refsection>
 
129
    <refsection id="Defaultproperties_SQRT">
 
130
        <title>Default properties</title>
 
131
        <itemizedlist>
 
132
            <listitem>
 
133
                <para>
 
134
                    <emphasis role="bold">always active:</emphasis> no
 
135
                </para>
 
136
            </listitem>
 
137
            <listitem>
 
138
                <para>
 
139
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
140
                </para>
 
141
            </listitem>
 
142
            <listitem>
 
143
                <para>
 
144
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
145
                </para>
 
146
            </listitem>
 
147
            <listitem>
 
148
                <para>
 
149
                    <emphasis role="bold">mode:</emphasis> no
 
150
                </para>
 
151
            </listitem>
 
152
            <listitem>
 
153
                <para>
 
154
                    <emphasis role="bold">regular inputs:</emphasis>
 
155
                </para>
 
156
                <para>
 
157
                    <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
 
158
                </para>
 
159
            </listitem>
 
160
            <listitem>
 
161
                <para>
 
162
                    <emphasis role="bold">regular outputs:</emphasis>
 
163
                </para>
 
164
                <para>
 
165
                    <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
 
166
                </para>
 
167
            </listitem>
 
168
            <listitem>
 
169
                <para>
 
170
                    <emphasis role="bold">number/sizes of activation
 
171
                        inputs:
 
172
                    </emphasis>
 
173
                    0
 
174
                </para>
 
175
            </listitem>
 
176
            <listitem>
 
177
                <para>
 
178
                    <emphasis role="bold">number/sizes of activation
 
179
                        outputs:
 
180
                    </emphasis>
 
181
                    0
 
182
                </para>
 
183
            </listitem>
 
184
            <listitem>
 
185
                <para>
 
186
                    <emphasis role="bold">continuous-time state:</emphasis>
 
187
                    no
 
188
                </para>
 
189
            </listitem>
 
190
            <listitem>
 
191
                <para>
 
192
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
193
                </para>
 
194
            </listitem>
 
195
            <listitem>
 
196
                <para>
 
197
                    <emphasis role="bold">object discrete-time state:</emphasis>
 
198
                    no
 
199
                </para>
 
200
            </listitem>
 
201
            <listitem>
 
202
                <para>
 
203
                    <emphasis role="bold">name of computational function:</emphasis>
 
204
                    <emphasis role="italic">mat_sqrt</emphasis>
 
205
                </para>
 
206
            </listitem>
 
207
        </itemizedlist>
 
208
    </refsection>
 
209
    <refsection id="Interfacingfunction_SQRT">
 
210
        <title>Interfacing function</title>
 
211
        <itemizedlist>
 
212
            <listitem>
 
213
                <para>SCI/modules/scicos_blocks/macros/MatrixOp/SQRT.sci</para>
 
214
            </listitem>
 
215
        </itemizedlist>
 
216
    </refsection>
 
217
    <refsection id="Computationalfunction_SQRT">
 
218
        <title>Computational function</title>
 
219
        <itemizedlist>
 
220
            <listitem>
 
221
                <para>SCI/modules/scicos_blocks/src/c/mat_sqrt.c</para>
 
222
            </listitem>
 
223
            <listitem>
 
224
                <para>SCI/modules/scicos_blocks/src/c/matz_sqrt.c</para>
 
225
            </listitem>
 
226
        </itemizedlist>
 
227
    </refsection>
 
228
    <refsection id="Seealso_SQRT">
 
229
        <title>See also</title>
 
230
        <itemizedlist>
 
231
            <listitem>
 
232
                <para>
 
233
                    <link linkend="POWBLK_f">POWBLK_f - Array power</link>
 
234
                </para>
 
235
            </listitem>
 
236
            <listitem>
 
237
                <para>
 
238
                    <link linkend="EXPBLK_m">EXPBLK_m - Exponential of a scalar (Bloc Xcos)</link>
 
239
                </para>
 
240
            </listitem>
 
241
            <listitem>
 
242
                <para>
 
243
                    <link linkend="LOGBLK_f">LOGBLK_m - Logarithm (Bloc Xcos)</link>
 
244
                </para>
 
245
            </listitem>
 
246
        </itemizedlist>
 
247
    </refsection>
248
248
</refentry>