← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/compatibility_functions/help/en_US/mtlb_realmin.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/compatibility_functions/help/en_US/mtlb_realmin.xml
11
11
    *
12
12
    -->
13
13
<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:lang="en" xml:id="mtlb_realmin">
14
 
  <refnamediv>
15
 
    <refname>mtlb_realmin</refname>
16
 
    <refpurpose>Matlab realmin emulation function</refpurpose>
17
 
  </refnamediv>
18
 
  <refsection>
19
 
    <title>Description</title>
20
 
    <para>
21
 
      Scilab equivalent for Matlab <literal>realmin</literal> is
22
 
      <literal>number_properties</literal> but not all cases are implemented:
23
 
    </para>
24
 
    <itemizedlist>
25
 
      <listitem>
26
 
        <para>
27
 
          Scilab equivalent for Matlab <literal>realmin</literal> or
28
 
          <literal>realmin('double')</literal> is <literal>number_properties("tiny")</literal>.
29
 
        </para>
30
 
      </listitem>
31
 
      <listitem>
32
 
        <para>
33
 
          There is no Scilab equivalent for Matlab <literal>realmin('single')</literal>
34
 
        </para>
35
 
      </listitem>
36
 
    </itemizedlist>
37
 
    <para>
38
 
      The function <literal>mtlb_realmin(prec)</literal> is used by
39
 
      <literal>mfile2sci</literal> to replace <literal>realmin(prec)</literal> when it was not
40
 
      possible to know what was the input while porting Matlab code to Scilab. This function will
41
 
      determine the correct semantic at run time. If you want to have a
42
 
      more efficient code it is possible to replace <literal>mtlb_realmin</literal> calls:
43
 
    </para>
44
 
    <itemizedlist>
45
 
      <listitem>
46
 
        <para>
47
 
          If <literal>prec</literal> is equal to <literal>"double"</literal>
48
 
          <literal>mtlb_realmin(prec)</literal> may be replaced by <literal>number_properties("tiny")</literal>
49
 
        </para>
50
 
      </listitem>
51
 
    </itemizedlist>
52
 
    <para>
53
 
      Caution: <literal>mtlb_realmin</literal> has not to be used for hand coded functions.
54
 
    </para>
55
 
  </refsection>
56
 
  <refsection role="see also">
57
 
    <title>See Also</title>
58
 
    <simplelist type="inline">
59
 
      <member>
60
 
        <link linkend="number_properties">number_properties</link>
61
 
      </member>
62
 
    </simplelist>
63
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>mtlb_realmin</refname>
 
16
        <refpurpose>Matlab realmin emulation function</refpurpose>
 
17
    </refnamediv>
 
18
    <refsection>
 
19
        <title>Description</title>
 
20
        <para>
 
21
            Scilab equivalent for Matlab <literal>realmin</literal> is
 
22
            <literal>number_properties</literal> but not all cases are implemented:
 
23
        </para>
 
24
        <itemizedlist>
 
25
            <listitem>
 
26
                <para>
 
27
                    Scilab equivalent for Matlab <literal>realmin</literal> or
 
28
                    <literal>realmin('double')</literal> is <literal>number_properties("tiny")</literal>.
 
29
                </para>
 
30
            </listitem>
 
31
            <listitem>
 
32
                <para>
 
33
                    There is no Scilab equivalent for Matlab <literal>realmin('single')</literal>
 
34
                </para>
 
35
            </listitem>
 
36
        </itemizedlist>
 
37
        <para>
 
38
            The function <literal>mtlb_realmin(prec)</literal> is used by
 
39
            <literal>mfile2sci</literal> to replace <literal>realmin(prec)</literal> when it was not
 
40
            possible to know what was the input while porting Matlab code to Scilab. This function will
 
41
            determine the correct semantic at run time. If you want to have a
 
42
            more efficient code it is possible to replace <literal>mtlb_realmin</literal> calls:
 
43
        </para>
 
44
        <itemizedlist>
 
45
            <listitem>
 
46
                <para>
 
47
                    If <literal>prec</literal> is equal to <literal>"double"</literal>
 
48
                    <literal>mtlb_realmin(prec)</literal> may be replaced by <literal>number_properties("tiny")</literal>
 
49
                </para>
 
50
            </listitem>
 
51
        </itemizedlist>
 
52
        <para>
 
53
            Caution: <literal>mtlb_realmin</literal> has not to be used for hand coded functions.
 
54
        </para>
 
55
    </refsection>
 
56
    <refsection role="see also">
 
57
        <title>See Also</title>
 
58
        <simplelist type="inline">
 
59
            <member>
 
60
                <link linkend="number_properties">number_properties</link>
 
61
            </member>
 
62
        </simplelist>
 
63
    </refsection>
64
64
</refentry>