← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/elementary_functions/help/en_US/exponential/log1p.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/elementary_functions/help/en_US/exponential/log1p.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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="log1p" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>log1p</refname>
5
 
    <refpurpose>computes with accuracy the natural logarithm of its argument
6
 
      added by one
7
 
    </refpurpose>
8
 
  </refnamediv>
9
 
  <refsynopsisdiv>
10
 
    <title>Calling Sequence</title>
11
 
    <synopsis>y=log1p(x)</synopsis>
12
 
  </refsynopsisdiv>
13
 
  <refsection>
14
 
    <title>Arguments</title>
15
 
    <variablelist>
16
 
      <varlistentry>
17
 
        <term>x</term>
18
 
        <listitem>
19
 
          <para>real scalar, vector or matrix</para>
20
 
        </listitem>
21
 
      </varlistentry>
22
 
      <varlistentry>
23
 
        <term>y</term>
24
 
        <listitem>
25
 
          <para>real scalar, vector or matrix</para>
26
 
        </listitem>
27
 
      </varlistentry>
28
 
    </variablelist>
29
 
  </refsection>
30
 
  <refsection>
31
 
    <title>Description</title>
32
 
    <para>
33
 
      <literal>log1p(x)</literal> is the "element-wise" <literal>log(1+x)</literal> function.
34
 
      <literal>y(i,j)=log(1 + x(i,j))</literal>. This function, defined for <literal>x</literal>
35
 
      &gt; -1, must be used if we want to compute <literal>log(1+x)</literal> with accuracy for <literal>|x|</literal>
36
 
      &lt;&lt; 1.
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection>
40
 
    <title>Examples</title>
41
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>log1p</refname>
 
5
        <refpurpose>computes with accuracy the natural logarithm of its argument
 
6
            added by one
 
7
        </refpurpose>
 
8
    </refnamediv>
 
9
    <refsynopsisdiv>
 
10
        <title>Calling Sequence</title>
 
11
        <synopsis>y=log1p(x)</synopsis>
 
12
    </refsynopsisdiv>
 
13
    <refsection>
 
14
        <title>Arguments</title>
 
15
        <variablelist>
 
16
            <varlistentry>
 
17
                <term>x</term>
 
18
                <listitem>
 
19
                    <para>real scalar, vector or matrix</para>
 
20
                </listitem>
 
21
            </varlistentry>
 
22
            <varlistentry>
 
23
                <term>y</term>
 
24
                <listitem>
 
25
                    <para>real scalar, vector or matrix</para>
 
26
                </listitem>
 
27
            </varlistentry>
 
28
        </variablelist>
 
29
    </refsection>
 
30
    <refsection>
 
31
        <title>Description</title>
 
32
        <para>
 
33
            <literal>log1p(x)</literal> is the "element-wise" <literal>log(1+x)</literal> function.
 
34
            <literal>y(i,j)=log(1 + x(i,j))</literal>. This function, defined for <literal>x</literal>
 
35
            &gt; -1, must be used if we want to compute <literal>log(1+x)</literal> with accuracy for <literal>|x|</literal>
 
36
            &lt;&lt; 1.
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection>
 
40
        <title>Examples</title>
 
41
        <programlisting role="example"><![CDATA[ 
42
42
format("e",24)
43
43
log(1.001)
44
44
log1p(0.001)
48
48
log1p(1.e-20)
49
49
format("v") //reset default format
50
50
 ]]></programlisting>
51
 
  </refsection>
52
 
  <refsection role="see also">
53
 
    <title>See Also</title>
54
 
    <simplelist type="inline">
55
 
      <member>
56
 
        <link linkend="log">log</link>
57
 
      </member>
58
 
    </simplelist>
59
 
  </refsection>
 
51
    </refsection>
 
52
    <refsection role="see also">
 
53
        <title>See Also</title>
 
54
        <simplelist type="inline">
 
55
            <member>
 
56
                <link linkend="log">log</link>
 
57
            </member>
 
58
        </simplelist>
 
59
    </refsection>
60
60
</refentry>