← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/linear_algebra/help/en_US/kernel/kernel.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/linear_algebra/help/en_US/kernel/kernel.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!--
 
3
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 
4
 * Copyright (C) 2008 - INRIA
 
5
 * 
 
6
 * This file must be used under the terms of the CeCILL.
 
7
 * This source file is licensed as described in the file COPYING, which
 
8
 * you should have received as part of this distribution.  The terms
 
9
 * are also available at    
 
10
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
11
 *
 
12
 -->
 
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="kernel">
 
14
    <refnamediv>
 
15
        <refname>kernel</refname>
 
16
        <refpurpose> kernel, nullspace</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>W=kernel(A [,tol,[,flag])</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>A</term>
 
27
                <listitem>
 
28
                    <para>full real or complex matrix or real sparse matrix</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>flag</term>
 
33
                <listitem>
 
34
                    <para>
 
35
                        character string <literal>'svd'</literal> (default) or <literal>'qr'</literal>
 
36
                    </para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>tol</term>
 
41
                <listitem>
 
42
                    <para>real number</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>W</term>
 
47
                <listitem>
 
48
                    <para>full column rank matrix</para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
        </variablelist>
 
52
    </refsection>
 
53
    <refsection>
 
54
        <title>Description</title>
 
55
        <para>
 
56
            <literal>W=kernel(A)</literal> returns the kernel (nullspace) of <literal>A</literal>. If A has full column rank then an empty matrix [] is returned.
 
57
        </para>
 
58
        <para>
 
59
            <literal>flag</literal> and <literal>tol</literal> are optional parameters: <literal>flag = 'qr'</literal> 
 
60
            or <literal>'svd'</literal> (default is <literal>'svd'</literal>).
 
61
        </para>
 
62
        <para>
 
63
            <literal>tol</literal> = tolerance parameter (of order <literal>%eps</literal> as default value).
 
64
        </para>
 
65
    </refsection>
 
66
    <refsection>
 
67
        <title>Examples</title>
 
68
        <programlisting role="example"><![CDATA[ 
 
69
A=rand(3,1)*rand(1,3);
 
70
A*kernel(A)
 
71
A=sparse(A);
 
72
clean(A*kernel(A))
 
73
 ]]></programlisting>
 
74
    </refsection>
 
75
    <refsection role="see also">
 
76
        <title>See Also</title>
 
77
        <simplelist type="inline">
 
78
            <member>
 
79
                <link linkend="colcomp">colcomp</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="fullrf">fullrf</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="fullrfk">fullrfk</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="linsolve">linsolve</link>
 
89
            </member>
 
90
        </simplelist>
 
91
    </refsection>
 
92
</refentry>