File: format.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (134 lines) | stat: -rw-r--r-- 3,397 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="windows-1251"?>
<refentry version="5.0-subset Scilab" xml:id="format" xml:lang="en"
          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">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>

  <refnamediv>
    <refname>format</refname>

    <refpurpose>number printing and display format</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>format([type],[long])
v = format()
format(m)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>type</term>

        <listitem>
          <para>character string</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>long</term>

        <listitem>
          <para>integer ( max number of digits (default 10))</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>v</term>

        <listitem>
          <para>a vector for the current format v(1) type format : 0 for 'e'
          and 1 for 'v' v(2) number of digits</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>m</term>

        <listitem>
          <para>a vector to set new format </para>

          <para>m(1) number of digits </para>

          <para>m(2) type format : 0 for 'e' and 1 for 'v'</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>

    <para>Sets the current printing format with the parameter
    <literal>type</literal> ; it is one of the following :</para>

    <variablelist>
      <varlistentry>
        <term>"v"</term>

        <listitem>
          <para>for a variable format (default)</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"e"</term>

        <listitem>
          <para>for the e-format.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para><literal>long</literal> defines the max number of digits (default
    10). <literal>format()</literal> returns a vector for the current format:
    first component is the type of format (1 if <literal>v</literal> ; 0 if
    <literal>e</literal> ); second component is the number of digits.</para>

    <para>In the old Scilab versions, in "variable format" mode, vectors
    entries which are less than %eps times the maximum absolute value of the
    entries were displayed as "0". It is no more the case, the clean function
    can be used to set neglitible entries to zeros.</para>
  </refsection>

  <refsection>
    <title>Examples</title>

    <programlisting role="example"><![CDATA[ 
x=rand(1,5);
format('v',10);x
format(20);x
format('e',10);x
format(20);x

x=[100 %eps];
format('e',10);x
format('v',10);x

format("v")
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="write">write</link></member>

      <member><link linkend="disp">disp</link></member>

      <member><link linkend="print">print</link></member>
    </simplelist>
  </refsection>
</refentry>