* Bug #12705 fixed - Elementary_functions & m2sci: members() function
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / setoperations / members.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) 2009 - Université du Maine - Samuel Gougeon
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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" xmlns:scilab="http://www.scilab.org" xml:id="members" xml:lang="en">
14     <refnamediv>
15         <refname>members</refname>
16         <refpurpose>retourne des vecteurs d'indices correspondants aux valeurs communes entre deux matrices
17         </refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Séquence d'appel</title>
21         <synopsis>[nb [,loc]] = members(A, S [,last])</synopsis>
22     </refsynopsisdiv>
23     <refsection>
24         <title>Paramètres</title>
25         <variablelist>
26             <varlistentry>
27                 <term>A</term>
28                 <listitem>
29                     <para>matrice ou hypermatrice de booléens, entiers, réels, complexes, polynômes ou chaînes de caractères</para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>S</term>
34                 <listitem>
35                     <para>
36                         matrice ou hypermatrice du même type que <literal>A</literal>
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>last</term>
42                 <listitem>
43                     <para>booléen</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>nb</term>
48                 <listitem>
49                     <para>
50                         matrice de réels de même taille que <literal>A</literal>
51                     </para>
52                 </listitem>
53             </varlistentry>
54             <varlistentry>
55                 <term>loc</term>
56                 <listitem>
57                     <para>
58                         matrice de réels de même taille que <literal>A</literal>
59                     </para>
60                 </listitem>
61             </varlistentry>
62         </variablelist>
63     </refsection>
64     <refsection>
65         <title>Description</title>
66         <para>
67             <literal>nb = members(A, S)</literal> retourne le nombre d'occurrences de <literal>A</literal> dans <literal>S</literal>.
68             Après <literal>[nb, loc] = members(A, S, last)</literal>,
69             <literal>loc(i, j)</literal> contient l'indice linéraire dans <literal>S</literal> de la première occurrence de <literal>A(i, j)</literal>.
70             Si <literal>last==%t</literal>, l'index de la dernière occurrence est retourné.
71             <literal>loc(i, j)</literal> retourne zéro si <literal>A(i, j)</literal> n'est pas trouvé.
72             <literal>%inf</literal> et <literal>-%inf</literal> sont supportés dans <literal>A</literal> et <literal>S</literal>.
73             <literal>%nan</literal> ne sont supportés que dans <literal>A</literal>.
74         </para>
75         <para>
76             Quand <literal>A</literal> est un vecteur de réels ou entiers et <literal>S</literal> est un vecteur de réels ou entiers strictement croissant,
77             <literal>dsearch(A, S, "d")</literal> est préféré à <literal>members(A, S)</literal>.
78         </para>
79     </refsection>
80     <refsection>
81         <title>Exemples</title>
82         <programlisting role="example"><![CDATA[
83 A = [1 8 4 5 2 1];
84 S = [9 7 4 2 1 4];
85
86 [nb, loc] = members(A, S, %t)
87 // Retourne loc = [5 0 6 0 4 5] parce-que la dernière occurrence dans S du troisième élément de A (qui est 4) est en sixième position
88
89 [nb, loc] = members(A, S, %f)
90 // Retourne loc = [5 0 3 0 4 5] parce-que la première occurrence dans S du troisième élément de A (qui est 4) est en troisième position
91
92 // Dans les deux cas, nb = [1 0 2 0 1 1] parce-que, par exemple, le nombre d'occurrences du troisième élément de A dans S est 2.
93
94 // Avec des hypermatrices. En réutilisant A et S :
95 A = matrix(A, [3 1 2]);
96 S = matrix(S, [3 1 2]);
97 [nb, loc] = members(A, S, %T)
98
99 // Avec des entiers :
100 A = int8(grand(3, 2, "uin", -5, 5));
101 S = int8(grand(4, 4, "uin", -5, 5));
102 [nb, loc] = members(A, S)
103
104 // Avec des polynômes (les coefficients complexes sont acceptés) :
105 z = %z;
106 A = [z (1-z)^2 ; -4 %i*z ];
107 S = [2  %i*z -z  3-z  z  z^3 z];
108 [nb, loc] = members(A, S)
109
110 // Avec du texte :
111 A = [ "Hi" "Hu" "Allo"];
112 S = [ "Hello" "Bonjour" "Allo"
113       "Holà"  "Allo"  "Hallo"
114       "Hi"    "Hé"    "Salud" ];
115 [nb, loc] = members(A, S, %t)
116 ]]></programlisting>
117     </refsection>
118     <refsection role="see also">
119         <title>Voir aussi</title>
120         <simplelist type="inline">
121             <member>
122                 <link linkend="dsearch">dsearch</link>
123             </member>
124             <member>
125                 <link linkend="intersect">intersect</link>
126             </member>
127             <member>
128                 <link linkend="unique">unique</link>
129             </member>
130             <member>
131                 <link linkend="gsort">gsort</link>
132             </member>
133             <member>
134                 <link linkend="union">union</link>
135             </member>
136         </simplelist>
137     </refsection>
138     <refsection>
139         <title>Historique</title>
140         <revhistory>
141             <revision>
142                 <revnumber>5.5.0</revnumber>
143                 <revremark>Fonction members introduite.</revremark>
144             </revision>
145         </revhistory>
146     </refsection>
147 </refentry>