help format: (fr) added
[scilab.git] / scilab / modules / linear_algebra / help / en_US / eigen / gschur.xml
index 1019831..9a5a759 100644 (file)
@@ -1,57 +1,60 @@
-        <?xml version="1.0" encoding="UTF-8"?>
-    <!--
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
  * 
- * This file must be used under the terms of the CeCILL.
- * This source file is licensed as described in the file COPYING, which
- * you should have received as part of this distribution.  The terms
- * are also available at    
- * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
  *
  -->
-    <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" scilab:needs-examples="no" xml:id="gschur">
-        <refnamediv>
-            <refname>gschur</refname>
-            <refpurpose>
-                generalized Schur form. <emphasis role="bold">This function is obsolete.</emphasis>
-            </refpurpose>
-        </refnamediv>
-        <refsynopsisdiv>
-            <title>Calling Sequence</title>
-            <synopsis>[As,Es]=gschur(A,E)
-                [As,Es,Q,Z]=gschur(A,E)
-                [As,Es,Z,dim] = gschur(A,E,flag)
-                [As,Es,Z,dim]= gschur(A,E,extern)
-            </synopsis>
-        </refsynopsisdiv>
-        <refsection>
-            <title>Description</title>
-            <para>
-                This function is obsolete and is now included in the <literal>schur</literal>
-                function. In most cases the <literal>gschur</literal> function will still work as
-                before, but it will be removed in the future release. 
-            </para>
-            <para>
-                The first three syntaxes can be replaced by
-            </para>
-            <programlisting role=""><![CDATA[ 
+<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" scilab:needs-examples="no" xml:id="gschur">
+    <refnamediv>
+        <refname>gschur</refname>
+        <refpurpose>
+            generalized Schur form. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Syntax</title>
+        <synopsis>[As,Es]=gschur(A,E)
+            [As,Es,Q,Z]=gschur(A,E)
+            [As,Es,Z,dim] = gschur(A,E,flag)
+            [As,Es,Z,dim]= gschur(A,E,extern)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function is obsolete and is now included in the <literal>schur</literal>
+            function. In most cases the <literal>gschur</literal> function will still work as
+            before, but it will be removed in the future release. 
+        </para>
+        <para>
+            The first three syntaxes can be replaced by
+        </para>
+        <programlisting role=""><![CDATA[ 
 [As,Es]=schur(A,E)
-[As,Es,Q,Z]=schur(A,E);Q=Q' //NOTE THE TRANPOSITION HERE
+[As,Es,Q,Z]=schur(A,E);Q=Q' //NOTE THE TRANSPOSITION HERE
 [As,Es,Z,dim] = schur(A,E,flag) 
  ]]></programlisting>
-            <para>
-                The last syntax requires little more adaptations:
-            </para>
-            <variablelist>
-                <varlistentry>
-                    <term>if</term>
-                    <listitem>
-                        <para>extern is a scilab function  the new calling sequence
-                            should be <literal>[As,Es,Z,dim]= schur(A,E,Nextern)</literal> with
-                            Nextern defined as follow:
-                        </para>
-                        <programlisting role=""><![CDATA[ 
+        <para>
+            The last syntax requires little more adaptations:
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>if</term>
+                <listitem>
+                    <para>extern is a scilab function  the new syntax
+                        should be <literal>[As,Es,Z,dim]= schur(A,E,Nextern)</literal> with
+                        Nextern defined as follow:
+                    </para>
+                    <programlisting role=""><![CDATA[ 
 function t=Nextern(R)
 if R(2)==0 then
   t=extern([1,R(1),R(3)])==1
@@ -61,18 +64,18 @@ else
 end
 endfunction
  ]]></programlisting>
-                    </listitem>
-                </varlistentry>
-                <varlistentry>
-                    <term>if</term>
-                    <listitem>
-                        <para>extern is the name of an external function coded in Fortran or C
-                            the new calling sequence should be <literal>[As,Es,Z,dim]=    schur(A,E,'nextern')</literal> with nextern defined as follow:
-                        </para>
-                    </listitem>
-                </varlistentry>
-            </variablelist>
-            <programlisting role=""><![CDATA[ 
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>if</term>
+                <listitem>
+                    <para>extern is the name of an external function coded in Fortran or C
+                        the new syntax should be <literal>[As,Es,Z,dim]=    schur(A,E,'nextern')</literal> with nextern defined as follow:
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+        <programlisting role=""><![CDATA[ 
 logical function nextern(ar,ai,beta)
 double precision ar,ai,beta
 integer r,extern
@@ -84,16 +87,16 @@ endif
 nextern=r.eq.1
 end
  ]]></programlisting>
-        </refsection>
-        <refsection role="see also">
-            <title>See Also</title>
-            <simplelist type="inline">
-                <member>
-                    <link linkend="external">external</link>
-                </member>
-                <member>
-                    <link linkend="schur">schur</link>
-                </member>
-            </simplelist>
-        </refsection>
-    </refentry>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="external">external</link>
+            </member>
+            <member>
+                <link linkend="schur">schur</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>