← 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/scilab_utilities_functions/var2vec.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/scilab_utilities_functions/var2vec.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="var2vec">
25
 
  <refnamediv>
26
 
    <refname>var2vec</refname>
27
 
    <refpurpose>Transform a scilab variable in a vector of double</refpurpose>
28
 
  </refnamediv>
29
 
  <refsynopsisdiv>
30
 
    <title>Calling Sequence</title>
31
 
    <synopsis>[vec]=var2vec(var)</synopsis>
32
 
  </refsynopsisdiv>
33
 
  <refsection id="Module_var2vec">
34
 
    <title>Module</title>
35
 
    <itemizedlist>
36
 
      <listitem>
37
 
        <para>
38
 
          <link linkend="xcos">xcos</link>
39
 
        </para>
40
 
      </listitem>
41
 
    </itemizedlist>
42
 
  </refsection>
43
 
  <refsection id="Description_var2vec">
44
 
    <title>Description</title>
45
 
    <para>
46
 
var2vec / vec2var functions are used inside the interfacing functions of Scilab blocks to give the possibility to the user to handle Scilab objects with the real parameter (rpar) and with the discrete state register (z).  
47
 
</para>
48
 
    <para>
49
 
</para>
50
 
    <programlisting role="example"><![CDATA[ 
 
25
    <refnamediv>
 
26
        <refname>var2vec</refname>
 
27
        <refpurpose>Transform a scilab variable in a vector of double</refpurpose>
 
28
    </refnamediv>
 
29
    <refsynopsisdiv>
 
30
        <title>Calling Sequence</title>
 
31
        <synopsis>[vec]=var2vec(var)</synopsis>
 
32
    </refsynopsisdiv>
 
33
    <refsection id="Module_var2vec">
 
34
        <title>Module</title>
 
35
        <itemizedlist>
 
36
            <listitem>
 
37
                <para>
 
38
                    <link linkend="xcos">xcos</link>
 
39
                </para>
 
40
            </listitem>
 
41
        </itemizedlist>
 
42
    </refsection>
 
43
    <refsection id="Description_var2vec">
 
44
        <title>Description</title>
 
45
        <para>
 
46
            var2vec / vec2var functions are used inside the interfacing functions of Scilab blocks to give the possibility to the user to handle Scilab objects with the real parameter (rpar) and with the discrete state register (z).  
 
47
        </para>
 
48
        <para>
 
49
        </para>
 
50
        <programlisting role="example"><![CDATA[ 
51
51
[vec]=var2vec(var)
52
52
 ]]></programlisting>
53
 
  </refsection>
54
 
  <refsection id="Parameters_var2vec">
55
 
    <title>Arguments</title>
56
 
    <itemizedlist>
57
 
      <listitem>
58
 
        <para><emphasis role="bold">var :</emphasis> Input parameter. Can be any types of Scilab objects.</para>
59
 
      </listitem>
60
 
      <listitem>
61
 
        <para><emphasis role="bold">vec :</emphasis> Output parameter. A vector of real numbers.</para>
62
 
      </listitem>
63
 
    </itemizedlist>
64
 
  </refsection>
65
 
  <refsection id="Example_var2vec">
66
 
    <title>Example</title>
67
 
    <programlisting role="example"><![CDATA[ 
 
53
    </refsection>
 
54
    <refsection id="Parameters_var2vec">
 
55
        <title>Arguments</title>
 
56
        <itemizedlist>
 
57
            <listitem>
 
58
                <para>
 
59
                    <emphasis role="bold">var :</emphasis> Input parameter. Can be any types of Scilab objects.
 
60
                </para>
 
61
            </listitem>
 
62
            <listitem>
 
63
                <para>
 
64
                    <emphasis role="bold">vec :</emphasis> Output parameter. A vector of real numbers.
 
65
                </para>
 
66
            </listitem>
 
67
        </itemizedlist>
 
68
    </refsection>
 
69
    <refsection id="Example_var2vec">
 
70
        <title>Example</title>
 
71
        <programlisting role="example"><![CDATA[ 
68
72
-->a=list("cos",[1.1,2])
69
73
a  = 
70
74
a(1)
86
90
1.1        
87
91
2.
88
92
 ]]></programlisting>
89
 
  </refsection>
90
 
  <refsection id="SeeAlso_var2vec">
91
 
    <title>See Also</title>
92
 
    <itemizedlist>
93
 
      <listitem>
94
 
        <para>
95
 
          <link linkend="vec2var">vec2var - Transform a vector of double in a scilab variable (Scilab Function)</link>
96
 
        </para>
97
 
      </listitem>
98
 
    </itemizedlist>
99
 
  </refsection>
 
93
    </refsection>
 
94
    <refsection id="SeeAlso_var2vec">
 
95
        <title>See Also</title>
 
96
        <itemizedlist>
 
97
            <listitem>
 
98
                <para>
 
99
                    <link linkend="vec2var">vec2var - Transform a vector of double in a scilab variable (Scilab Function)</link>
 
100
                </para>
 
101
            </listitem>
 
102
        </itemizedlist>
 
103
    </refsection>
100
104
</refentry>