← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/statistics/help/en_US/data_missing_values/thrownan.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/statistics/help/en_US/data_missing_values/thrownan.xml
12
12
 *
13
13
 -->
14
14
<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="thrownan">
15
 
  <refnamediv>
16
 
    <refname>thrownan</refname>
17
 
    <refpurpose>Eliminates nan values</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>[nonan,numb]=thrownan(x)</synopsis>
22
 
  </refsynopsisdiv>
23
 
  <refsection>
24
 
    <title>Arguments</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>x</term>
28
 
        <listitem>
29
 
          <para>
30
 
            a m-by-n real or complex matrix of doubles.
31
 
            If the number of columns in <literal>x</literal> is different from 1,
32
 
            then the column-by-column matrix <literal>x</literal> is considered.
33
 
          </para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
      <varlistentry>
37
 
        <term>nonan</term>
38
 
        <listitem>
39
 
          <para>
40
 
            a (m*n)-by-1 real or complex matrix of doubles, without any %nan entries.
41
 
          </para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
      <varlistentry>
45
 
        <term>numb</term>
46
 
        <listitem>
47
 
          <para>
48
 
            a (m*n)-by-1 real or complex matrix of floating point integers, the
49
 
            indices <literal>k</literal> in <literal>x</literal> where <literal>x(k)</literal>
50
 
            is non-nan.
51
 
          </para>
52
 
        </listitem>
53
 
      </varlistentry>
54
 
    </variablelist>
55
 
  </refsection>
56
 
  <refsection>
57
 
    <title>Description</title>
58
 
    <para>
59
 
      This function returns  in vector <literal>nonan</literal> the values
60
 
      (ignoring the <literal>%nan</literal> entries) of a matrix <literal>x</literal> and
61
 
      in  the corresponding places of vector  <literal>numb</literal> the
62
 
      indexes of the value.
63
 
    </para>
64
 
  </refsection>
65
 
  <refsection>
66
 
    <title>Examples</title>
67
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>thrownan</refname>
 
17
        <refpurpose>Eliminates nan values</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>[nonan,numb]=thrownan(x)</synopsis>
 
22
    </refsynopsisdiv>
 
23
    <refsection>
 
24
        <title>Arguments</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>x</term>
 
28
                <listitem>
 
29
                    <para>
 
30
                        a m-by-n real or complex matrix of doubles.
 
31
                        If the number of columns in <literal>x</literal> is different from 1,
 
32
                        then the column-by-column matrix <literal>x</literal> is considered.
 
33
                    </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
            <varlistentry>
 
37
                <term>nonan</term>
 
38
                <listitem>
 
39
                    <para>
 
40
                        a (m*n)-by-1 real or complex matrix of doubles, without any %nan entries.
 
41
                    </para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
            <varlistentry>
 
45
                <term>numb</term>
 
46
                <listitem>
 
47
                    <para>
 
48
                        a (m*n)-by-1 real or complex matrix of floating point integers, the
 
49
                        indices <literal>k</literal> in <literal>x</literal> where <literal>x(k)</literal>
 
50
                        is non-nan.
 
51
                    </para>
 
52
                </listitem>
 
53
            </varlistentry>
 
54
        </variablelist>
 
55
    </refsection>
 
56
    <refsection>
 
57
        <title>Description</title>
 
58
        <para>
 
59
            This function returns  in vector <literal>nonan</literal> the values
 
60
            (ignoring the <literal>%nan</literal> entries) of a matrix <literal>x</literal> and
 
61
            in  the corresponding places of vector  <literal>numb</literal> the
 
62
            indexes of the value.
 
63
        </para>
 
64
    </refsection>
 
65
    <refsection>
 
66
        <title>Examples</title>
 
67
        <programlisting role="example"><![CDATA[ 
68
68
x=[0.2113249 %nan 0.6653811;0.7560439 0.3303271 0.6283918]
69
69
[nonan numb]=thrownan(x)
70
70
and(x(numb)==nonan) // Must be %t
71
71
 ]]></programlisting>
72
 
  </refsection>
 
72
    </refsection>
73
73
</refentry>