* Bug 14873 fixed [doc]: setfield page fixed updated clarified
[scilab.git] / scilab / modules / data_structures / help / fr_FR / setfield.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2006-2008 - INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2020 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:db="http://docbook.org/ns/docbook"
18           xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="setfield">
19     <refnamediv>
20         <refname>setfield</refname>
21         <refpurpose>modifie la valeur d'un élément d'une mlist, tlist ou list</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Séquence d'appel</title>
25         <synopsis>uL = setfield(a, v, L)</synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>L</term>
32                 <listitem>
33                     liste de type <literal>list</literal>, <literal>tlist</literal> ou
34                     <literal>mlist</literal>, dont un élement doit être modifié.
35                     <para/>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>a</term>
40                 <listitem>
41                     Adresse de l'élément de liste à modifier. Elle peut être soit un mot texte
42                     spécifiant un nom de champ, soit un entier positif indiquant le n°
43                     de l'élément dans la liste.
44                     Voir <link linkend="insertion">insertion</link> pour plus de détails.
45                     <para/>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>v</term>
50                 <listitem>
51                     Tout objet Scilab : la valeur à affecter à l'élément.
52                     <para/>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>uL</term>
57                 <listitem>
58                     Liste modifiée.
59                     <para/>
60                 </listitem>
61             </varlistentry>
62         </variablelist>
63     </refsection>
64     <refsection>
65         <title>Description</title>
66         <para>
67             <literal>L=setfield(a,v,L)</literal> adresse et modifie le
68             i<superscript>ème</superscript> élément d'une liste, selon une
69             syntaxe identique pour tous les types list, tlist et mlist
70             disponibles en Scilab.
71         </para>
72         <para>
73             Pour des simples list et pour des mlist, <literal>L=setfield(a,v,L)</literal>
74             est équivalent à <literal>L(a)=v</literal>, qui est plus simple et préférable.
75             L'équivalence tient aussi pour toute mlist si l'adresse <varname>a</varname>
76             est le nom d'un champ.
77         </para>
78         <para>
79             En revanche, pour toute mlist <varname>L</varname>, si <literal>i</literal>
80             est un n°, <literal>L(i)=v</literal> adresse le i<superscript>ème</superscript>
81             élément de <varname>L</varname> considérée comme un vecteur, au lieu
82             du i<superscript>ème</superscript> élément tel que déclaré dans la
83             définition initiale <literal>mlist(c1,c2,c3...)</literal>.
84             <literal>setfield(i,v,L)</literal> aura alors le même sens que pour les
85             autres types de listes.
86         </para>
87     </refsection>
88     <refsection>
89         <title>Exemples</title>
90         <para>
91             Pour une tlist, <literal>setfield(3, v, T)</literal> équivaut à
92             <literal>T(3)=v</literal> :
93         </para>
94         <programlisting role="example"><![CDATA[
95 T = tlist(['V','a','b'], [%z (1-%z) %z^2], [%f %t %t]);
96 // L'insertion est prédéfinie :
97 T(3) = [%t %t %f];
98 T(3)
99
100 T = setfield(3, [%f %t %f], T);
101 T(3)
102  ]]></programlisting>
103     <screen><![CDATA[
104 --> T = tlist(['V','a','b'], [%z (1-%z) %z^2], [%f %t %t]);
105 --> // L'insertion est prédéfinie :
106 --> T(3) = [%t %t %f];
107 --> T(3)
108  ans  =
109   T T F
110
111 --> T = setfield(3, [%f %t %f], T);
112 --> T(3)
113  ans  =
114   F T F
115 ]]></screen>
116         <para>
117             Pour une mlist, aucune routine d'insertion indexée n'est prédéfinie. L'utilisateur
118             est ainsi libre d'en définir une pour un adressage matriciel des données.
119         </para>
120         <programlisting role="example"><![CDATA[
121 M = mlist(['V','a','b'], [%z (1-%z) %z^2], [%f %t %t]);
122 M.b = [%t %t %t];
123 M.b                 // OK, alors que ...
124 M(3) = [%f %t %f];  // => erreur
125
126 // Une insertion directe avec setfield() est toujours possible :
127 M = setfield(3, [%t %f %t], M);
128 getfield(3, M)
129  ]]></programlisting>
130     <screen><![CDATA[
131 --> M = mlist(['V','a','b'], [%z (1-%z) %z^2], [%f %t %t]);
132 --> M.b = [%t %t %t];
133 --> M.b 
134  ans  =
135   T T T
136
137 --> M(3) = [%t %f %t];  // => erreur
138 Fonction non définie pour les types fournis.
139   vérifier les arguments ou définir la fonction %b_i_V pour la surcharge.
140
141 --> // Une insertion directe avec setfield() est toujours possible :
142 --> M = setfield(3, [%t %f %t], M);
143 --> getfield(3, M)
144  ans  =
145   T F T
146 ]]></screen>
147     </refsection>
148     <refsection role="see also">
149         <title>Voir aussi</title>
150         <simplelist type="inline">
151             <member>
152                 <link linkend="insertion">insertion</link>
153             </member>
154             <member>
155                 <link linkend="getfield">getfield</link>
156             </member>
157         </simplelist>
158     </refsection>
159     <refsection>
160         <title>History</title>
161         <revhistory>
162             <revision>
163                 <revnumber>6.0.0</revnumber>
164                 <revdescription>
165
166                     <itemizedlist>
167                         <listitem>
168                             La liste modifiée est désormais donnée en réponse, au lieu d'être
169                             modifiée "sur place".
170                         </listitem>
171                         <listitem>
172                             setfield() ne peut plus être utilisée pour des tableaux de cellules.
173                         </listitem>
174                     </itemizedlist>
175                 </revdescription>
176             </revision>
177         </revhistory>
178     </refsection>
179 </refentry>