a8d164a8259d0c6aab11eb96575ee0d3d409126c
[scilab.git] / scilab / modules / elementary_functions / help / pt_BR / setoperations / unique.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) 2008 - INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2017 - 2019 - 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:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="unique" xml:lang="pt">
20     <refnamediv>
21         <refname>unique</refname>
22         <refpurpose>remover todos os componentes duplicados de um vetor ou uma matriz
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Seqüência de Chamamento</title>
27         <synopsis>
28             [N, k, nb] = unique(M)
29             [N, k, nb] = unique(M, orient)
30             [N, k, nb] = unique(.., "keepOrder")
31             [N, k, nb] = unique(.., "uniqueNan")
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection role="parameters">
35         <title>Parâmetros</title>
36         <variablelist>
37             <varlistentry>
38                 <term>M</term>
39                 <listitem>
40                     <para>vetor ou matriz de números ou strings </para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>orient</term>
45                 <listitem>
46                     <para>flag com valores possíveis : 1 ou "r", 2 ou "c".
47                         It can't be used if <varname>M</varname> is an hypermatrix.
48                     </para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>N</term>
53                 <listitem>
54                     <para>
55                       <itemizedlist>
56                         <listitem>
57                             <para>
58                               If <varname>orient</varname> is not used: Vector of extracted
59                               <varname>M</varname> components sorted in ascending order.
60                             If <varname>M</varname> is a row vector, <varname>N</varname> is also
61                             a row vector. In all other <varname>M</varname> cases,
62                             <varname>N</varname> is a matrix or a column vector.
63                             </para>
64                         </listitem>
65                         <listitem>
66                           If <varname>orient</varname> is used: Matrix of extracted
67                           <varname>M</varname> rows or columns, sorted in lexicographic ascending order.
68                         </listitem>
69                       </itemizedlist>
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>k</term>
75                 <listitem>
76                     <para>
77                       Vector of indices of first encountered occurences, such that
78                       <literal>N(i) = M(k(i))</literal> or <literal>N(i,:) = M(k(i),:)</literal>
79                       or <literal>N(:,i) = M(:,k(i))</literal>.
80                     </para>
81                     <para>
82                         <varname>k</varname> is a row if <varname>M</varname> is a row or if
83                         <literal>orient="c"</literal> is used. Otherwise it's a column.
84                     </para>
85                 </listitem>
86             </varlistentry>
87             <varlistentry>
88                 <term>nb</term>
89                 <listitem>
90                     <para>
91                       Vector of integers > 0, with the same <varname>k</varname> shape:
92                       Numbers of occurences in <varname>M</varname> of respective unduplicated
93                       entities (components, rows, columns) returned in <varname>N</varname>.
94                     </para>
95                 </listitem>
96             </varlistentry>
97         </variablelist>
98     </refsection>
99     <refsection role="description">
100         <title>Descrição</title>
101         <para>
102             <literal>unique(M)</literal> retorna um vetor que retém as entradas
103             únicas de <literal>M</literal> em ordem ascendente.
104         </para>
105         <para>
106             <literal>unique(M,"r")</literal> ou
107             <literal>unique(M,1)</literal>retorna as linhas únicas de
108             <literal>M</literal> em ordem lexicográfica ascendente.
109         </para>
110         <para>
111             <literal>unique(M,"c")</literal> ou
112             <literal>unique(M,2)</literal>retorna as linhas únicas de
113             <literal>M</literal> em ordem lexicográfica ascendente.
114         </para>
115         <para>
116             <literal>unique(M,.. "keepOrder")</literal> returns <varname>M</varname> unduplicated
117             entries in their original order in <varname>M</varname>.
118             <literal>"keepOrder"</literal> is case-insensitive.
119         </para>
120         <para>
121             <literal>unique(M,.. "uniqueNan")</literal> considers all Nan values as the same one,
122             and unduplicates them. By default, any Nan is different
123             from any other Nan, including itself: <literal>%nan&lt;>%nan</literal> is true, unless
124             <literal>"uniqueNan"</literal> is used. Specifying
125             <literal>"uniqueNan"</literal> is case-insensitive.
126         </para>
127     </refsection>
128     <refsection role="description">
129         <title>Exemplos</title>
130         <para>With some numbers:</para>
131         <programlisting role="example"><![CDATA[
132 M = int8([2  0  2  2  1  1  1  2  1  1  0  1  1  0  1  1
133           0  1  2  0  1  2  2  0  1  1  2  0  1  0  0  0
134           ])
135 [u, k] = unique(M)
136 [uc, kc] = unique(M, "c")
137
138 // Get unduplicated columns in initial order:
139 M(:, gsort(kc,"g","i"))
140  ]]></programlisting>
141     <screen><![CDATA[
142 --> M
143  M =
144   2  0  2  2  1  1  1  2  1  1  0  1  1  0  1  1
145   0  1  2  0  1  2  2  0  1  1  2  0  1  0  0  0
146
147 --> [u, k] = unique(M)
148  u  =
149   0
150   1
151   2
152
153  k  =
154    2.
155    4.
156    1.
157
158 --> [uc, kc] = unique(M, "c")
159  uc  =
160   0  0  0  1  1  1  2  2
161   0  1  2  0  1  2  0  2
162
163  kc  =
164    14.   2.   11.   12.   5.   6.   1.   3.
165
166 --> // Get unduplicated columns in initial order:
167 --> M(:, gsort(kc,"g","i"))
168  ans  =
169   2  0  2  1  1  0  1  0
170   0  1  2  1  2  2  0  0
171 ]]></screen>
172         <para>With complex numbers:</para>
173         <programlisting role="example"><![CDATA[
174 i = %i;
175 c = [1+i, 1-i, -i, i, -i, 1+i]
176 [u, k] = unique(c)
177 [uc, kc] = unique(c, "c")
178  ]]></programlisting>
179     <screen><![CDATA[
180 --> c = [1+i, 1-i, -i, i, -i, 1+i]
181  c  =
182    1. + i     1. - i  -i    i   -i    1. + i
183
184 --> [u, k] = unique(c)
185  u  =
186   -i    i    1. - i   1. + i
187
188  k  =
189    3.   4.   2.   1.
190 ]]></screen>
191
192     <para>With some texts:</para>
193         <programlisting role="example"><![CDATA[
194 t = ["BA" "BB" "AB" "BA" "AB" "BA" "AB" "AB" "BA" "AA" "AB" "BA" "BA" "BA" "AA"
195      "AA" "AB" "AA" "AA" "BB" "BB" "BB" "BA" "AB" "AB" "BB" "BB" "AB" "AB" "AA"
196     ]
197 u = unique(t)'
198 [u, k, nb] = unique(t(1,:))
199 [u, k] = unique(t(1,:), "keepOrder")  // Keeping the original order of row#1 elements
200 [uc, kc, nb] = unique(t, "c")
201 [uc, kc, nb] = unique(t, "c", "keepOrder")  // Keeping the original order of columns
202  ]]></programlisting>
203     <screen><![CDATA[
204 --> t = ["BA" "BB" "AB" "BA" "AB" "BA" "AB" "AB" "BA" "AA" "AB" "BA" "BA" "BA" "AA"
205   >      "AA" "AB" "AA" "AA" "BB" "BB" "BB" "BA" "AB" "AB" "BB" "BB" "AB" "AB" "AA"
206   >     ]
207  t  =
208 !BA  BB  AB  BA  AB  BA  AB  AB  BA  AA  AB  BA  BA  BA  AA  !
209 !AA  AB  AA  AA  BB  BB  BB  BA  AB  AB  BB  BB  AB  AB  AA  !
210
211 --> u = unique(t)'
212  u  =
213 !AA  AB  BA  BB  !
214
215 --> [u, k, nb] = unique(t(1,:))
216  u  =
217 !AA  AB  BA  BB  !
218
219  k  =
220    10.   3.   1.   2.
221
222  nb  =
223    2.   5.   7.   1.
224
225 --> [u, k] = unique(t(1,:), "keepOrder")  // Keeping the original order
226  u  =
227 !BA  BB  AB  AA  !
228
229  k  =
230    1.   2.   3.   10.
231
232 --> [uc, kc, nb] = unique(t, "c")
233  nb  =
234    1.   1.   1.   1.   3.   2.   3.   2.   1.
235
236  kc  =
237    15.   10.   3.   8.   5.   1.   9.   6.   2.
238
239  uc  =
240 !AA  AA  AB  AB  AB  BA  BA  BA  BB  !             Sorted columns
241 !AA  AB  AA  BA  BB  AA  AB  BB  AB  !
242
243 --> [uc, kc, nb] = unique(t, "c", "keepOrder")  // Keeping the original order
244  uc  =
245 !BA  BB  AB  AB  BA  AB  BA  AA  AA  !
246 !AA  AB  AA  BB  BB  BA  AB  AB  AA  !
247
248  kc  =
249    1.   2.   3.   5.   6.   8.   9.   10.   15.
250
251  nb  =
252    2.   1.   1.   3.   2.   1.   3.   1.   1.
253 ]]></screen>
254         <para/>
255         <para>With Nan (and Inf) values. "uniqueNan" option:</para>
256         <programlisting role="example"><![CDATA[
257 M = [2  2  %nan  1     2  0     1  %nan  0    %nan
258      1  0  1     %nan  0  %inf  0  1     %inf 1
259     ];
260 [v,k,n] = unique(M); v',n'
261 [v,k,n] = unique(M, "uniqueNan"); v',n'
262 unique(M, "c")
263 [v, k, n] = unique(M, "c", "uniqueNan")
264  ]]></programlisting>
265     <screen><![CDATA[
266 --> M
267  M  =
268    2.   2.   Nan   1.    2.   0.    1.   Nan   0.    Nan
269    1.   0.   1.    Nan   0.   Inf   0.   1.    Inf   1.
270
271 --> [v,k,n] = unique(M); v',n'
272  ans  =
273    0.   1.   2.   Inf   Nan   Nan   Nan   Nan
274
275  ans  =
276    5.   6.   3.   2.   1.   1.   1.   1.
277
278 --> [v,k,n] = unique(M, "uniqueNan"); v',n'
279  ans  =
280    0.   1.   2.   Inf   Nan
281
282  ans  =
283    5.   6.   3.   2.   4.
284
285 --> unique(M, "c")
286  ans  =
287    0.    1.   1.    2.   2.   Nan   Nan   Nan
288    Inf   0.   Nan   0.   1.   1.    1.    1.
289
290 --> [v, k, n] = unique(M, "c", "uniqueNan")
291  v  =
292    0.    1.   1.    2.   2.   Nan
293    Inf   0.   Nan   0.   1.   1.
294
295  k  =
296    6.   7.   4.   2.   1.   3.
297
298  n  =
299    2.   1.   1.   2.   1.   3.
300 ]]></screen>
301     </refsection>
302     <refsection role="see also">
303         <title>Ver Também</title>
304         <simplelist type="inline">
305             <member>
306                 <link linkend="members">members</link>
307             </member>
308             <member>
309                 <link linkend="gsort">gsort</link>
310             </member>
311             <member>
312                 <link linkend="vectorfind">vectorfind</link>
313             </member>
314             <member>
315                 <link linkend="grep">grep</link>
316             </member>
317             <member>
318                 <link linkend="union">union</link>
319             </member>
320             <member>
321                 <link linkend="intersect">intersect</link>
322             </member>
323         </simplelist>
324     </refsection>
325     <refsection role="history">
326         <title>Histórico</title>
327         <revhistory>
328             <revision>
329                 <revnumber>6.0.2</revnumber>
330                 <revdescription>
331                     unique() can now be used to unduplicate complex numbers.
332                 </revdescription>
333             </revision>
334             <revision>
335                 <revnumber>6.1.0</revnumber>
336                 <revdescription>
337                     <itemizedlist>
338                         <listitem>
339                             "keepOrder" and "uniqueNan" options introduced.
340                         </listitem>
341                         <listitem>
342                             Third output argument <literal>nb</literal> introduced.
343                         </listitem>
344                     </itemizedlist>
345                 </revdescription>
346             </revision>
347         </revhistory>
348     </refsection>
349 </refentry>