Help check: validate the help files on compilation against a derivated docbook schema
[scilab.git] / scilab / modules / elementary_functions / help / en_US / signalprocessing / bloc2exp.xml
index 630f2a8..b51d1d2 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="bloc2exp" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="bloc2exp" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>bloc2exp</refname>
-
     <refpurpose>block-diagram to symbolic expression</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>[str]=bloc2exp(blocd)
 [str,names]=bloc2exp(blocd)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>blocd</term>
-
         <listitem>
           <para>list</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>str</term>
-
         <listitem>
           <para>string</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>names</term>
-
         <listitem>
           <para>string</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>given a block-diagram representation of a linear system
     <literal>bloc2exp</literal> returns its symbolic evaluation. The first
     element of the list <literal>blocd</literal> must be the string
     <literal>'blocd'</literal>. Each other element of this list
     <literal>(blocd(2),blocd(3),...)</literal> is itself a list of one the
     following types :</para>
-
-    <programlisting role = ""><![CDATA[ 
+    <programlisting><![CDATA[ 
 list('transfer','name_of_linear_system')
  ]]></programlisting>
-
-    <programlisting role = ""><![CDATA[  
+    <programlisting><![CDATA[  
 list('link','name_of_link',
                [number_of_upstream_box,upstream_box_port],
                [downstream_box_1,downstream_box_1_portnumber],
                [downstream_box_2,downstream_box_2_portnumber],
                ...)
  ]]></programlisting>
-
     <para>The strings <literal>'transfer'</literal> and
     <literal>'links'</literal> are keywords which indicate the type of element
     in the block diagram.</para>
-
     <para>Case 1 : the second parameter of the list is a character string
     which may refer (for a possible further evaluation) to the Scilab name of
     a linear system given in state-space representation
     (<literal>syslin</literal> list) or in transfer form (matrix of
     rationals).</para>
-
     <para>To each transfer block is associated an integer. To each input and
     output of a transfer block is also associated its number, an integer (see
     examples)</para>
-
     <para>Case 2 : the second kind of element in a block-diagram
     representation is a link. A link links one output of a block represented
     by the pair <literal>[number_of_upstream_box,upstream_box_port]</literal>,
     to different inputs of other blocks. Each such input is represented by the
     pair
     <literal>[downstream_box_i,downstream_box_i_portnumber]</literal>.</para>
-
     <para>The different elements of a block-diagram can be defined in an
     arbitrary order.</para>
-
     <para>For example</para>
-
     <para>[1] <literal>S1*S2</literal> with unit feedback.</para>
-
     <para>There are 3 transfers <literal>S1</literal> (number
     <literal>n_s1=2</literal>) , <literal>S2</literal> (number
     <literal>n_s2=3</literal>) and an adder (number
     <literal>n_add=4</literal>) with symbolic transfer function
     <literal>['1','1']</literal>.</para>
-
     <para>There are 4 links. The first one (named <literal>'U'</literal>)
     links the input (port 0 of fictitious block -1, omitted) to port 1 of the
     adder. The second and third one link respectively (output)port 1 of the
@@ -129,8 +99,7 @@ list('link','name_of_link',
     fourth link (named <literal>'Y'</literal>) links (output)port 1 of
     <literal>S2</literal> to the output (port 0 of fictitious block -1,
     omitted) and to (input)port 2 of the adder.</para>
-
-    <programlisting role = "example"><![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 //Initialization
 syst=list('blocd'); l=1;
 
@@ -153,18 +122,14 @@ l=l+1;syst(l)=list('link','Y',[n_s2,1],[-1],[n_adder,2]);
 //Evaluation call
 w=bloc2exp(syst);
  ]]></programlisting>
-
     <para>The result is the character string:
     <literal>w=-(s2*s1-eye())\s2*s1</literal>.</para>
-
     <para>Note that invoked with two output arguments, <literal>[str,names]=
     blocd(syst)</literal> returns in <literal>names</literal> the list of
     symbolic names of named links. This is useful to set names to inputs and
     outputs.</para>
-
     <para>[2] second example</para>
-
-    <programlisting role = "example"><![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 //Initialization
 syst=list('blocd'); l=1;
 
@@ -183,24 +148,22 @@ l=l+1;syst(l)=list('link','y',[n_s,2],[n_k,1]);
 //Evaluation call
 w=bloc2exp(syst);
  ]]></programlisting>
-
     <para>In this case the result is a formula equivalent to the usual
     one:</para>
-
-    <para><literal>P11+P12*invr(eye()-K*P22)*K*P21;</literal></para>
+    <para>
+      <literal>P11+P12*invr(eye()-K*P22)*K*P21;</literal>
+    </para>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="bloc2ss">bloc2ss</link></member>
+      <member>
+        <link linkend="bloc2ss">bloc2ss</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>S. S., F. D. (INRIA)</para>
   </refsection>
 </refentry>