← 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/LOGBLK_f.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/LOGBLK_f.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="LOGBLK_f">
25
 
  <refnamediv>
26
 
    <refname>LOGBLK_f</refname>
27
 
    <refpurpose>Logarithm</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/LOGBLK_f.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_LOGBLK_f">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="LOGBLK_f">Logarithm</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_LOGBLK_f">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_LOGBLK_f">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_LOGBLK_f">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_LOGBLK_f">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_LOGBLK_f">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_LOGBLK_f">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Seealso_LOGBLK_f">See also</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_LOGBLK_f">
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_LOGBLK_f">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      This block computes the logarithm of the elements of the input vector. The user can fix the base
102
 
      with the parameter <emphasis role="bold">Basis</emphasis>. By default the block computes the
103
 
      natural logarithm. The input and output port sizes are determined by the context.
104
 
    </para>
105
 
  </refsection>
106
 
  <refsection id="Dialogbox_LOGBLK_f">
107
 
    <title>Dialog box</title>
108
 
    <para>
109
 
      <inlinemediaobject>
110
 
        <imageobject>
111
 
          <imagedata fileref="../../../../images/gui/LOGBLK_f_gui.gif" align="center" valign="middle"/>
112
 
        </imageobject>
113
 
      </inlinemediaobject>
114
 
    </para>
115
 
    <para>
116
 
    </para>
117
 
    <itemizedlist>
118
 
      <listitem>
119
 
        <para>
120
 
          <emphasis role="bold">Basis</emphasis>
121
 
        </para>
122
 
        <para> A real scalar greater than 1.</para>
123
 
        <para> Properties : Type 'vec' of size 1. </para>
124
 
      </listitem>
125
 
    </itemizedlist>
126
 
  </refsection>
127
 
  <refsection id="Defaultproperties_LOGBLK_f">
128
 
    <title>Default properties</title>
129
 
    <itemizedlist>
130
 
      <listitem>
131
 
        <para>
132
 
          <emphasis role="bold">always active:</emphasis> no
133
 
        </para>
134
 
      </listitem>
135
 
      <listitem>
136
 
        <para>
137
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
138
 
        </para>
139
 
      </listitem>
140
 
      <listitem>
141
 
        <para>
142
 
          <emphasis role="bold">zero-crossing:</emphasis> no
143
 
        </para>
144
 
      </listitem>
145
 
      <listitem>
146
 
        <para>
147
 
          <emphasis role="bold">mode:</emphasis> no
148
 
        </para>
149
 
      </listitem>
150
 
      <listitem>
151
 
        <para>
152
 
          <emphasis role="bold">regular inputs:</emphasis>
153
 
        </para>
154
 
        <para>
155
 
          <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
156
 
        </para>
157
 
      </listitem>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">regular outputs:</emphasis>
161
 
        </para>
162
 
        <para>
163
 
          <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
164
 
        </para>
165
 
      </listitem>
166
 
      <listitem>
167
 
        <para>
168
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
169
 
        </para>
170
 
      </listitem>
171
 
      <listitem>
172
 
        <para>
173
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
174
 
        </para>
175
 
      </listitem>
176
 
      <listitem>
177
 
        <para>
178
 
          <emphasis role="bold">continuous-time state:</emphasis> no
179
 
        </para>
180
 
      </listitem>
181
 
      <listitem>
182
 
        <para>
183
 
          <emphasis role="bold">discrete-time state:</emphasis> no
184
 
        </para>
185
 
      </listitem>
186
 
      <listitem>
187
 
        <para>
188
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
189
 
        </para>
190
 
      </listitem>
191
 
      <listitem>
192
 
        <para>
193
 
          <emphasis role="bold">name of computational function:</emphasis>
194
 
          <emphasis role="italic">logblk</emphasis>
195
 
        </para>
196
 
      </listitem>
197
 
    </itemizedlist>
198
 
  </refsection>
199
 
  <refsection id="Interfacingfunction_LOGBLK_f">
200
 
    <title>Interfacing function</title>
201
 
    <itemizedlist>
202
 
      <listitem>
203
 
        <para> SCI/modules/scicos_blocks/macros/NonLinear/LOGBLK_f.sci</para>
204
 
      </listitem>
205
 
    </itemizedlist>
206
 
  </refsection>
207
 
  <refsection id="Computationalfunction_LOGBLK_f">
208
 
    <title>Computational function</title>
209
 
    <itemizedlist>
210
 
      <listitem>
211
 
        <para> SCI/modules/scicos_blocks/src/fortran/logblk.f (Type 0)</para>
212
 
      </listitem>
213
 
    </itemizedlist>
214
 
  </refsection>
215
 
  <refsection id="Seealso_LOGBLK_f">
216
 
    <title>See also</title>
217
 
    <itemizedlist>
218
 
      <listitem>
219
 
        <para>
220
 
          <link linkend="POWBLK_f">POWBLK_f - Array power (Bloc Xcos)</link>
221
 
        </para>
222
 
      </listitem>
223
 
      <listitem>
224
 
        <para>
225
 
          <link linkend="EXPBLK_m">EXPBLK_m - Exponential of a scalar (Bloc Xcos)</link>
226
 
        </para>
227
 
      </listitem>
228
 
      <listitem>
229
 
        <para>
230
 
          <link linkend="SQRT">SQRT - Square root (Bloc Xcos)</link>
231
 
        </para>
232
 
      </listitem>
233
 
    </itemizedlist>
234
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>LOGBLK_f</refname>
 
27
        <refpurpose>Logarithm</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/LOGBLK_f.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_LOGBLK_f">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="LOGBLK_f">Logarithm</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_LOGBLK_f">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_LOGBLK_f">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_LOGBLK_f">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_LOGBLK_f">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_LOGBLK_f">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_LOGBLK_f">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Seealso_LOGBLK_f">See also</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_LOGBLK_f">
 
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_LOGBLK_f">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            This block computes the logarithm of the elements of the input vector. The user can fix the base
 
102
            with the parameter <emphasis role="bold">Basis</emphasis>. By default the block computes the
 
103
            natural logarithm. The input and output port sizes are determined by the context.
 
104
        </para>
 
105
    </refsection>
 
106
    <refsection id="Dialogbox_LOGBLK_f">
 
107
        <title>Dialog box</title>
 
108
        <para>
 
109
            <inlinemediaobject>
 
110
                <imageobject>
 
111
                    <imagedata fileref="../../../../images/gui/LOGBLK_f_gui.gif" align="center" valign="middle"/>
 
112
                </imageobject>
 
113
            </inlinemediaobject>
 
114
        </para>
 
115
        <para>
 
116
        </para>
 
117
        <itemizedlist>
 
118
            <listitem>
 
119
                <para>
 
120
                    <emphasis role="bold">Basis</emphasis>
 
121
                </para>
 
122
                <para> A real scalar greater than 1.</para>
 
123
                <para> Properties : Type 'vec' of size 1. </para>
 
124
            </listitem>
 
125
        </itemizedlist>
 
126
    </refsection>
 
127
    <refsection id="Defaultproperties_LOGBLK_f">
 
128
        <title>Default properties</title>
 
129
        <itemizedlist>
 
130
            <listitem>
 
131
                <para>
 
132
                    <emphasis role="bold">always active:</emphasis> no
 
133
                </para>
 
134
            </listitem>
 
135
            <listitem>
 
136
                <para>
 
137
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
138
                </para>
 
139
            </listitem>
 
140
            <listitem>
 
141
                <para>
 
142
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
143
                </para>
 
144
            </listitem>
 
145
            <listitem>
 
146
                <para>
 
147
                    <emphasis role="bold">mode:</emphasis> no
 
148
                </para>
 
149
            </listitem>
 
150
            <listitem>
 
151
                <para>
 
152
                    <emphasis role="bold">regular inputs:</emphasis>
 
153
                </para>
 
154
                <para>
 
155
                    <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
 
156
                </para>
 
157
            </listitem>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">regular outputs:</emphasis>
 
161
                </para>
 
162
                <para>
 
163
                    <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
 
164
                </para>
 
165
            </listitem>
 
166
            <listitem>
 
167
                <para>
 
168
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
169
                </para>
 
170
            </listitem>
 
171
            <listitem>
 
172
                <para>
 
173
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
174
                </para>
 
175
            </listitem>
 
176
            <listitem>
 
177
                <para>
 
178
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
179
                </para>
 
180
            </listitem>
 
181
            <listitem>
 
182
                <para>
 
183
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
184
                </para>
 
185
            </listitem>
 
186
            <listitem>
 
187
                <para>
 
188
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
189
                </para>
 
190
            </listitem>
 
191
            <listitem>
 
192
                <para>
 
193
                    <emphasis role="bold">name of computational function:</emphasis>
 
194
                    <emphasis role="italic">logblk</emphasis>
 
195
                </para>
 
196
            </listitem>
 
197
        </itemizedlist>
 
198
    </refsection>
 
199
    <refsection id="Interfacingfunction_LOGBLK_f">
 
200
        <title>Interfacing function</title>
 
201
        <itemizedlist>
 
202
            <listitem>
 
203
                <para> SCI/modules/scicos_blocks/macros/NonLinear/LOGBLK_f.sci</para>
 
204
            </listitem>
 
205
        </itemizedlist>
 
206
    </refsection>
 
207
    <refsection id="Computationalfunction_LOGBLK_f">
 
208
        <title>Computational function</title>
 
209
        <itemizedlist>
 
210
            <listitem>
 
211
                <para> SCI/modules/scicos_blocks/src/fortran/logblk.f (Type 0)</para>
 
212
            </listitem>
 
213
        </itemizedlist>
 
214
    </refsection>
 
215
    <refsection id="Seealso_LOGBLK_f">
 
216
        <title>See also</title>
 
217
        <itemizedlist>
 
218
            <listitem>
 
219
                <para>
 
220
                    <link linkend="POWBLK_f">POWBLK_f - Array power (Bloc Xcos)</link>
 
221
                </para>
 
222
            </listitem>
 
223
            <listitem>
 
224
                <para>
 
225
                    <link linkend="EXPBLK_m">EXPBLK_m - Exponential of a scalar (Bloc Xcos)</link>
 
226
                </para>
 
227
            </listitem>
 
228
            <listitem>
 
229
                <para>
 
230
                    <link linkend="SQRT">SQRT - Square root (Bloc Xcos)</link>
 
231
                </para>
 
232
            </listitem>
 
233
        </itemizedlist>
 
234
    </refsection>
235
235
</refentry>