correct bug 4184 for data_structures - uniformisation of the examples presentation
[scilab.git] / scilab / modules / data_structures / help / fr_FR / tlist.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry version="5.0-subset Scilab" xml:id="tlist" xml:lang="fr"
3           xmlns="http://docbook.org/ns/docbook"
4           xmlns:xlink="http://www.w3.org/1999/xlink"
5           xmlns:svg="http://www.w3.org/2000/svg"
6           xmlns:ns3="http://www.w3.org/1999/xhtml"
7           xmlns:mml="http://www.w3.org/1998/Math/MathML"
8           xmlns:db="http://docbook.org/ns/docbook">
9   <info>
10     <pubdate>$LastChangedDate$</pubdate>
11   </info>
12
13   <refnamediv>
14     <refname>tlist</refname>
15
16     <refpurpose>Objet Scilab. Définition d'une liste typée</refpurpose>
17   </refnamediv>
18
19   <refsynopsisdiv>
20     <title>Séquence d'appel</title>
21
22     <synopsis>tlist(typ,a1,....an )</synopsis>
23   </refsynopsisdiv>
24
25   <refsection>
26     <title>Paramètres</title>
27
28     <variablelist>
29       <varlistentry>
30         <term>typ</term>
31
32         <listitem>
33           <para>chaîne de caractères ou matrice de chaînes de
34           caractères</para>
35         </listitem>
36       </varlistentry>
37
38       <varlistentry>
39         <term>ai</term>
40
41         <listitem>
42           <para>objet Scilab (<literal>matrice, liste,
43           chaîne...</literal>).</para>
44         </listitem>
45       </varlistentry>
46     </variablelist>
47   </refsection>
48
49   <refsection>
50     <title>Description</title>
51
52     <para>Crée une <literal>liste typée</literal> avec les éléments
53     <literal>ai</literal>. L'argument <literal>typ</literal> spécifie le nom
54     du type. L'utilisateur peut redéfinir les opérateurs et primitives de
55     Scilab pour ces nouveaux objets à l'aide de fonctions Scilab (voir
56     <literal>overloading</literal>). La seule différence entre les listes
57     typées et les listes (voir <literal>list</literal>) est la valeur
58     numérique du type (16 au lieu de 15).</para>
59
60     <para><literal>typ(1)</literal> spécifie le nom du type (cette chaîne de
61     caractères est utilisée dans les noms des fonctions surchargeant les
62     opérateurs et primitives).</para>
63
64     <para>S'il est spécifié, <literal>typ(i)</literal> donne le nom formel de
65     l'élément <literal>i+1</literal> (voir plus bas dans les exemples).</para>
66
67     <para>Les opérations standard sur les listes fonctionnent similairement
68     pour les listes typées (tlist).</para>
69
70     <para>extraction : <literal>[x,y,z...]=l(v)</literal> ou
71     <literal>v</literal> est un vecteur d'indices;
72     <literal>[x,y,z]=l(:)</literal> extrait tous les éléments.</para>
73
74     <para>insertion : <literal>l(i)=a</literal></para>
75
76     <para>suppression : <literal>l(i)=null()</literal> supprime le i-ème
77     élément de la <literal>tlist l</literal>.</para>
78
79     <para>affichage</para>
80
81     <para>De plus si les composantes <literal>typ(2:n+1)</literal> sont
82     spécifiées, les éléments peuvent être désignés par leur noms
83     formels.</para>
84
85     <para>Voici quelques exemples d'utilisation des liste typées :</para>
86
87     <para>Dans Scilab, les systèmes dynamiques linéaires sont définis par une
88     liste typée : le quadruplet <literal>[A,B,C,D]</literal> est représenté
89     par la tlist
90     <literal>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</literal>
91     et cette tlist spécifique est créée par la fonction
92     <literal>syslin</literal>.</para>
93
94     <para>Sys(2), Sys('A') ou Sys.A est la matrice d'état et Sys('dt') ou
95     Sys.dt est le domaine temporel.</para>
96
97     <para>Une matrice rationnelle <literal>H</literal> est représentée par la
98     tlist <literal>H=tlist(['r';'num';'den';'dt'],Num,Den,[])</literal> où
99     <literal>Num</literal> et <literal>Den</literal> sont deux matrices
100     polynomiales et un système dynamique linéaire (en temps continu) peut être
101     créé sous la forme d'une matrice de transfert <literal>H</literal> par
102     <literal>syslin('c',H)</literal>.</para>
103
104     <para>H(2), H('num') ou H.num est le numérateur de la matrice de
105     transfert</para>
106   </refsection>
107
108   <refsection>
109     <title>Exemples</title>
110
111     <programlisting role="example"> 
112 // tlist creation
113 t = tlist(["listtype","field1","field2"], [], []);
114 t.field1(1) = 10;
115 t.field1(2) = 20;
116 t.field2(1) = "Scilab";
117 t.field2(2) = "tlist";
118 t.field2(3) = "example";
119
120 // Fields contents display
121 disp(t.field1)
122 disp(t.field2)
123
124 // Generic tlist display
125 disp(t)
126
127 // Overloading display for this type of tlist
128 function %listtype_p(mytlist)
129
130 f = fieldnames(mytlist);
131
132 // typeof(mytlist) &lt;=&gt; f(1)
133 mprintf("Displaying a tlist of type: %s\n", typeof(mytlist));
134
135 mprintf("\n");
136
137 mprintf("-- Field ''%s'' --\n", f(1));
138 mprintf("Contents: %s\n", sci2exp(mytlist(f(1))));
139
140 mprintf("\n");
141
142 mprintf("-- Field ''%s'' --\n", f(2));
143 mprintf("Contents: %s\n", sci2exp(mytlist(f(2))));
144
145 endfunction
146
147 // Display using overloading function
148 disp(t)
149  </programlisting>
150   </refsection>
151
152   <refsection>
153     <title>Voir Aussi</title>
154
155     <simplelist type="inline">
156       <member><link linkend="null">null</link></member>
157
158       <member><link linkend="percent">percent</link></member>
159
160       <member><link linkend="syslin">syslin</link></member>
161
162       <member><link linkend="list">list</link></member>
163     </simplelist>
164   </refsection>
165 </refentry>