householder documentation page was missing some improvements 56/17856/3
Pierre-Aime Agnel [Mon, 7 Mar 2016 15:11:51 +0000 (16:11 +0100)]
following commit https://codereview.scilab.org/#/c/17849/

Change-Id: I4afb64229cea7ff0935778c44e0e0d5e1672a80c

scilab/modules/helptools/etc/images_md5.txt
scilab/modules/linear_algebra/help/en_US/factorization/householder.xml
scilab/modules/linear_algebra/help/fr_FR/factorization/householder.xml
scilab/modules/linear_algebra/help/ja_JP/factorization/householder.xml
scilab/modules/linear_algebra/help/pt_BR/factorization/householder.xml

index 4ee8949..2a90c7d 100644 (file)
@@ -942,6 +942,7 @@ histplot_ru_RU_2.png=8117e3f08f726740eb7a4e19b7c80cf1
 histplot_ru_RU_3.png=cd3e60e8f0a028549da7547fbf4b7222
 histplot_ru_RU_4.png=ac27914effe5c72bfcd955f7a90d43d2
 hotcolormap_1.png=93b81776ad0b15d88239eab74997022e
+householder_1.png=e4cf33e6819540c66917a01587518816
 hsv2rgb_1.png=7d20c259e94301d9763fbddb7bff4784
 hsvcolormap_1.png=11918d88bcc793200af0b9f1b58b0554
 iir_1.png=e675c2755f68ddc4611c849895b63012
@@ -1002,8 +1003,8 @@ move_1.png=c4599a8693c9c099ac9c7f1a5dee3e91
 mrfit_1.png=d8d3736f01fc8fc707c53508cddd575f
 nanreglin_1.png=a2189dd0a4084c54b9c1e05b45db555b
 nanreglin_2.png=5a3c75b736030778ba4a1717051810cb
-ndgrid_1.png=3ce3028731d1b6677c0b30ae6d59f68e
-ndgrid_2.png=4ef02608494aec0d492a68853b3bec1b
+ndgrid_1.png=881b8c6e4e1ccf21fce8004766f2df8d
+ndgrid_2.png=2c9c5b309ed4b25ee57c8b35e6a1fe1
 ndgrid_ru_RU_2.png=de964c7f8e0168a8c01b85f494329120
 nicholschart_en_US_1.png=4123c1234e85121879226ae325b64513
 nicholschart_en_US_2.png=f40d41b275495a2e839ed7f26bbbf92
@@ -1068,7 +1069,7 @@ plot2d3_2.png=42ff831fb2c002525f96d9232fdd718b
 plot2d4_1.png=ca17ee46fae89a343407d090111051b5
 plot2d4_2.png=44ad62335417f4cd080eefdde0edd1c1
 plot2d_1.png=6938527906d00e35013f43aa6810e52f
-plot2d_10.png=ad1bc6dc6ac4a8b2201f4f897ea2fb3b
+plot2d_10.png=7c45e534c2b6341dd8a24a63871aa3a9
 plot2d_2.png=48949e8c7de5cab2f8f68e9b0d30f65a
 plot2d_3.png=d491471e1355626da75f16255adbbf45
 plot2d_4.png=8db7dbb9f894fa92f0426971771818fa
@@ -1097,7 +1098,7 @@ plot3d_7.png=b106077ec3b360ba717fef4579da3f55
 plot3d_8.png=d7ca9d9d5dd993d30bc6423a0528ff8e
 plot3d_9.png=c0f93d84e3ccdc76486bd41209b1f76b
 plot_1.png=f1b99772428f58ecb395a0e9d646467c
-plot_10.png=39217be67a065109f320385c67293b6e
+plot_10.png=e56bd24f47d06312c9f9f37211674a61
 plot_11.png=3fbb963b7ebc42b5cf32d0443197c30b
 plot_12.png=59b89f2aa6e520bf84d04f4cc922e51
 plot_13.png=483a01785c6cf3d4e2fd579856fd1ac8
index 5a9fde0..495274b 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>         householder         // demo</synopsis>
-        <synopsis> u     = householder(v [,w])</synopsis>
-        <synopsis>[u, H] = householder(v [,w])</synopsis>
+        <synopsis>
+            householder         // demo
+            u     = householder(v [,w])
+            [u, H] = householder(v [,w])
+        </synopsis>
     </refsynopsisdiv>
     <refsection role="arguments">
         <title>Arguments</title>
         <para>
             If the related reflexion matrix <varname>H</varname> is computed, for any point A
             of column coordinates <literal>a</literal>, <literal>H*a</literal> are the coordinates of
-            the reflected image of A on P.
+            the reflected image of A (see the example below).
         </para>
         <note>
             If <varname>v</varname> or/and <varname>w</varname> are in row, they are priorly
@@ -147,7 +149,9 @@ clean(hm' - hm)         // must be zeros(3,3)
 clean(det(hm))          // must be -1
  ]]></programlisting>
         
-        <para>APPLICATION : Reflected image of an object</para>
+        <para>
+            <emphasis role="bold"> Application:</emphasis> Reflected image of an object w.r. to a given plane
+        </para>
         <programlisting role="example"><![CDATA[
 // (OA) = [0 0 1] is reflected in O into (OB) = [ 1 1 0.3 ]:
 [n, H] = householder([0 0 1]', [ 1 1 0.3 ]');
index 6158e2f..8f5dcb6 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>         householder         // demo</synopsis>
-        <synopsis> u     = householder(v [,w])</synopsis>
-        <synopsis>[u, H] = householder(v [,w])</synopsis>
+        <synopsis>
+            householder         // demo
+            u     = householder(v [,w])
+            [u, H] = householder(v [,w])
+        </synopsis>
     </refsynopsisdiv>
     <refsection role="arguments">
         <title>Paramètres</title>
         <para>
             Si la matrice de réflexion <varname>H</varname> correspondante est calculée,
             pour tout point A de coordonnées <literal>a</literal> en colonne, <literal>H*a</literal>
-            sont les coordonnées de l'image de A réfléchie sur P.
+            sont les coordonnées de l'image réfléchie de A (exemple ci-dessous).
         </para>
         <note>
             Si <varname>v</varname> ou/et <varname>w</varname> sont des vecteurs ligne,
@@ -147,7 +149,9 @@ clean(hm' - hm)         // must be zeros(3,3)
 clean(det(hm))          // must be -1
  ]]></programlisting>
         
-        <para>APPLICATION : Image réfléchie d'un objet</para>
+        <para>
+            <emphasis role="bold">Application :</emphasis> Image réfléchie d'un objet par rapport à un plan donné.
+        </para>
         <programlisting role="example"><![CDATA[
 // (OA) = [0 0 1] se réfléchit en O en (OB) = [ 1 1 0.3 ]:
 [n, H] = householder([0 0 1]', [ 1 1 0.3 ]');
index 94c17ed..0a2e6f1 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>呼び出し手順</title>
-        <synopsis>         householder         // demo</synopsis>
-        <synopsis> u     = householder(v [,w])</synopsis>
-        <synopsis>[u, H] = householder(v [,w])</synopsis>
+        <synopsis>
+            householder         // demo
+            u     = householder(v [,w])
+            [u, H] = householder(v [,w])
+        </synopsis>
     </refsynopsisdiv>
     <refsection role="arguments">
         <title>引数</title>
         <para>
             If the related reflexion matrix <varname>H</varname> is computed, for any point A
             of column coordinates <literal>a</literal>, <literal>H*a</literal> are the coordinates of
-            the reflected image of A on P.
+            the reflected image of A (see the example below).
         </para>
         <note>
             If <varname>v</varname> or/and <varname>w</varname> are in row, they are priorly
@@ -150,7 +152,9 @@ clean(hm' - hm)         // must be zeros(3,3)
 clean(det(hm))          // must be -1
  ]]></programlisting>
         
-        <para>APPLICATION : Reflected image of an object</para>
+        <para>
+            <emphasis role="bold">Application:</emphasis> Reflected image of an object w.r. to a given plane
+        </para>
         <programlisting role="example"><![CDATA[
 // (OA) = [0 0 1] is reflected in O into (OB) = [ 1 1 0.3 ]:
 [n, H] = householder([0 0 1]', [ 1 1 0.3 ]');
@@ -227,5 +231,4 @@ drawnow
             </revision>
         </revhistory>
     </refsection>
-    
 </refentry>
index 318eef7..470e773 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="householder" xml:lang="pt">
     <refnamediv>
         <refname>householder</refname>
-        <refpurpose>matriz de reflexão ortogonal de Householder</refpurpose>
+        <refpurpose>matriz de reflexão ortogonal de Householder</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
-        <title>Seqüência de Chamamento</title>
-        <synopsis>         householder         // demo</synopsis>
-        <synopsis> u     = householder(v [,w])</synopsis>
-        <synopsis>[u, H] = householder(v [,w])</synopsis>
+        <title>Seqüência de Chamamento</title>
+        <synopsis>
+            householder         // demo
+            u     = householder(v [,w])
+            [u, H] = householder(v [,w])
+        </synopsis>
     </refsynopsisdiv>
     <refsection role="arguments">
-        <title>Parâmetros</title>
+        <title>Parâmetros</title>
         <variablelist>
             <varlistentry>
                 <term>v</term>
@@ -37,7 +39,7 @@
                 <term>w</term>
                 <listitem>
                     <para>vetor coluna de reais ou complexos com o mesmo tamanho que
-                        <varname>v</varname>. Valor padrão é <literal>eye(v)</literal> ((Ox) axis)
+                        <varname>v</varname>. Valor padrão é <literal>eye(v)</literal> ((Ox) axis)
                     </para>
                 </listitem>
             </varlistentry>
@@ -68,7 +70,7 @@
         </variablelist>
     </refsection>
     <refsection role="description">
-        <title>Descrição</title>
+        <title>Descrição</title>
         <para>
             <literal>householder(..)</literal> computes the unit vector <varname>u</varname>
             lying in the <literal>(v,w)</literal> plane and orthogonal to the bisectrix of
         <para>
             If the related reflexion matrix <varname>H</varname> is computed, for any point A
             of column coordinates <literal>a</literal>, <literal>H*a</literal> are the coordinates of
-            the reflected image of A on P.
+            the reflected image of A (see the example below).
         </para>
         <note>
             If <varname>v</varname> or/and <varname>w</varname> are in row, they are priorly
@@ -147,7 +149,9 @@ clean(hm' - hm)         // must be zeros(3,3)
 clean(det(hm))          // must be -1
  ]]></programlisting>
         
-        <para>APPLICATION : Reflected image of an object</para>
+        <para>
+            <emphasis role="bold">Application:</emphasis> Reflected image of an object w.r. to a given plane
+        </para>
         <programlisting role="example"><![CDATA[
 // (OA) = [0 0 1] is reflected in O into (OB) = [ 1 1 0.3 ]:
 [n, H] = householder([0 0 1]', [ 1 1 0.3 ]');
@@ -199,7 +203,7 @@ drawnow
         </scilab:image>
     </refsection>
     <refsection role="see also">
-        <title>Ver Também</title>
+        <title>Ver Também</title>
         <simplelist type="inline">
             <member>
                 <link linkend="qr">qr</link>
@@ -210,7 +214,7 @@ drawnow
         </simplelist>
     </refsection>
     <refsection role="history">
-        <title>Histórico</title>
+        <title>Histórico</title>
         <revhistory>
             <revision>
                 <revnumber>6.0</revnumber>