File: clean.xml

package info (click to toggle)
scilab 5.3.3-10
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 330,656 kB
file content (58 lines) | stat: -rw-r--r-- 2,072 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<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="fr" xml:id="clean">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>clean</refname>
    <refpurpose> nettoie une matrice (arrondi à zéro des termes très petits)    </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Séquence d'appel</title>
    <synopsis>[B]=clean(A [,epsa [,epsr]])</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Paramètres</title>
    <variablelist>
      <varlistentry>
        <term>A  </term>
        <listitem>
          <para>une matrice (scalaire, polynômes, creuse, ...) 
</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>epsa,epsr  </term>
        <listitem>
          <para>nombres réels. Tolérances (valeurs par défaut resp. 1.d-10 et 1.d-10)
</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
    Cette fonction élimine (force à zéro) les coefficients 
    de valeur absolue &lt; <literal>epsa</literal> ou de valeur relative &lt; <literal>epsr</literal> 
    (relative par rapport à la  norme 1 des coefficients)
    dans un polynôme (éventuellement matrice de polynôme ou rationnelle).
  </para>
    <para>
    Les valeurs par défaut sont <literal>epsa=1.d-10</literal> et <literal>epsr=1.d-10</literal>.
  </para>
    <para>
    Pour une matrice constante (non polynomiale) <literal>clean(A,epsa)</literal> force à zéro
    les termes de <literal>A</literal> plus petits que <literal>epsa</literal>.
  </para>
  </refsection>
  <refsection>
    <title>Exemples</title>
    <programlisting role="example"><![CDATA[ 
x=poly(0,'x');
w=[x,1,2+x;3+x,2-x,x^2;1,2,3+x]/3;
w*inv(w)
clean(w*inv(w))
 ]]></programlisting>
  </refsection>
</refentry>