5a0b4975501dacbb91dff7d301f7532c629ee51a
[scilab.git] / scilab / modules / elementary_functions / help / en_US / 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:ns5="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="en">
20     <refnamediv>
21         <refname>unique</refname>
22         <refpurpose>extracts (and sorts) distinct elements, rows or columns of a matrix</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Syntax</title>
26         <synopsis>
27             [N, k, nb] = unique(M)
28             [N, k, nb] = unique(M, orient)
29             [N, k, nb] = unique(.., "keepOrder")
30             [N, k, nb] = unique(.., "uniqueNan")
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection role="parameters">
34         <title>Arguments</title>
35         <variablelist>
36             <varlistentry>
37                 <term>M</term>
38                 <listitem>
39                     <para>vector, matrix, or hypermatrix of numbers or of strings.</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>orient</term>
44                 <listitem>
45                     <para>
46                         flag with possible values : 1 or "r", 2 or "c". It can't be used if
47                         <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
61                                 also 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 occurrences, 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 occurrences 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>Description</title>
101         <para>
102             <literal>unique(M)</literal> returns a vector which retains the
103             unique entries of <literal>M</literal> in ascending order.
104         </para>
105         <para>
106             <literal>unique(M,"r")</literal> or  <literal>unique(M,1)</literal> removes all
107             duplicates of <varname>M</varname> rows and returns unique rows  in lexicographic
108             ascending order.
109         </para>
110         <para>
111             <literal>unique(M,"c")</literal> or  <literal>unique(M,2)</literal> removes all
112             duplicates of <varname>M</varname> columns and returns unique columns in lexicographic
113             ascending order.
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="examples">
129         <title>Examples</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/>
173         <para>With complex numbers:</para>
174         <programlisting role="example"><![CDATA[
175 i = %i;
176 c = [1+i, 1-i, -i, i, -i, 1+i]
177 [u, k] = unique(c)
178 [uc, kc] = unique(c, "c")
179  ]]></programlisting>
180     <screen><![CDATA[
181 --> c = [1+i, 1-i, -i, i, -i, 1+i]
182  c  =
183    1. + i     1. - i  -i    i   -i    1. + i
184
185 --> [u, k] = unique(c)
186  u  =
187   -i    i    1. - i   1. + i
188
189  k  =
190    3.   4.   2.   1.
191 ]]></screen>
192         <para/>
193         <para>With some texts:</para>
194         <programlisting role="example"><![CDATA[
195 t = ["BA" "BB" "AB" "BA" "AB" "BA" "AB" "AB" "BA" "AA" "AB" "BA" "BA" "BA" "AA"
196      "AA" "AB" "AA" "AA" "BB" "BB" "BB" "BA" "AB" "AB" "BB" "BB" "AB" "AB" "AA"
197     ]
198 u = unique(t)'
199 [u, k, nb] = unique(t(1,:))
200 [u, k] = unique(t(1,:), "keepOrder")  // Keeping the original order of row#1 elements
201 [uc, kc, nb] = unique(t, "c")
202 [uc, kc, nb] = unique(t, "c", "keepOrder")  // Keeping the original order of columns
203  ]]></programlisting>
204     <screen><![CDATA[
205 --> t = ["BA" "BB" "AB" "BA" "AB" "BA" "AB" "AB" "BA" "AA" "AB" "BA" "BA" "BA" "AA"
206   >      "AA" "AB" "AA" "AA" "BB" "BB" "BB" "BA" "AB" "AB" "BB" "BB" "AB" "AB" "AA"
207   >     ]
208  t  =
209 !BA  BB  AB  BA  AB  BA  AB  AB  BA  AA  AB  BA  BA  BA  AA  !
210 !AA  AB  AA  AA  BB  BB  BB  BA  AB  AB  BB  BB  AB  AB  AA  !
211
212 --> u = unique(t)'
213  u  =
214 !AA  AB  BA  BB  !
215
216 --> [u, k, nb] = unique(t(1,:))
217  u  =
218 !AA  AB  BA  BB  !
219
220  k  =
221    10.   3.   1.   2.
222
223  nb  =
224    2.   5.   7.   1.
225
226 --> [u, k] = unique(t(1,:), "keepOrder")  // Keeping the original order
227  u  =
228 !BA  BB  AB  AA  !
229
230  k  =
231    1.   2.   3.   10.
232
233 --> [uc, kc, nb] = unique(t, "c")
234  nb  =
235    1.   1.   1.   1.   3.   2.   3.   2.   1.
236
237  kc  =
238    15.   10.   3.   8.   5.   1.   9.   6.   2.
239
240  uc  =
241 !AA  AA  AB  AB  AB  BA  BA  BA  BB  !             Sorted columns
242 !AA  AB  AA  BA  BB  AA  AB  BB  AB  !
243
244 --> [uc, kc, nb] = unique(t, "c", "keepOrder")  // Keeping the original order
245  uc  =
246 !BA  BB  AB  AB  BA  AB  BA  AA  AA  !
247 !AA  AB  AA  BB  BB  BA  AB  AB  AA  !
248
249  kc  =
250    1.   2.   3.   5.   6.   8.   9.   10.   15.
251
252  nb  =
253    2.   1.   1.   3.   2.   1.   3.   1.   1.
254 ]]></screen>
255         <para/>
256         <para>With Nan (and Inf) values. "uniqueNan" option:</para>
257         <programlisting role="example"><![CDATA[
258 M = [2  2  %nan  1     2  0     1  %nan  0    %nan
259      1  0  1     %nan  0  %inf  0  1     %inf 1
260     ];
261 [v,k,n] = unique(M); v',n'
262 [v,k,n] = unique(M, "uniqueNan"); v',n'
263 unique(M, "c")
264 [v, k, n] = unique(M, "c", "uniqueNan")
265  ]]></programlisting>
266     <screen><![CDATA[
267 --> M
268  M  =
269    2.   2.   Nan   1.    2.   0.    1.   Nan   0.    Nan
270    1.   0.   1.    Nan   0.   Inf   0.   1.    Inf   1.
271
272 --> [v,k,n] = unique(M); v',n'
273  ans  =
274    0.   1.   2.   Inf   Nan   Nan   Nan   Nan
275
276  ans  =
277    5.   6.   3.   2.   1.   1.   1.   1.
278
279 --> [v,k,n] = unique(M, "uniqueNan"); v',n'
280  ans  =
281    0.   1.   2.   Inf   Nan
282
283  ans  =
284    5.   6.   3.   2.   4.
285
286 --> unique(M, "c")
287  ans  =
288    0.    1.   1.    2.   2.   Nan   Nan   Nan
289    Inf   0.   Nan   0.   1.   1.    1.    1.
290
291 --> [v, k, n] = unique(M, "c", "uniqueNan")
292  v  =
293    0.    1.   1.    2.   2.   Nan
294    Inf   0.   Nan   0.   1.   1.
295
296  k  =
297    6.   7.   4.   2.   1.   3.
298
299  n  =
300    2.   1.   1.   2.   1.   3.
301 ]]></screen>
302     </refsection>
303     <refsection role="see also">
304         <title>See also</title>
305         <simplelist type="inline">
306             <member>
307                 <link linkend="members">members</link>
308             </member>
309             <member>
310                 <link linkend="gsort">gsort</link>
311             </member>
312             <member>
313                 <link linkend="vectorfind">vectorfind</link>
314             </member>
315             <member>
316                 <link linkend="grep">grep</link>
317             </member>
318             <member>
319                 <link linkend="union">union</link>
320             </member>
321             <member>
322                 <link linkend="intersect">intersect</link>
323             </member>
324         </simplelist>
325     </refsection>
326     <refsection role="history">
327         <title>History</title>
328         <revhistory>
329             <revision>
330                 <revnumber>6.0.2</revnumber>
331                 <revdescription>
332                     unique() can now be used to unduplicate complex numbers.
333                 </revdescription>
334             </revision>
335             <revision>
336                 <revnumber>6.1.0</revnumber>
337                 <revdescription>
338                     <itemizedlist>
339                         <listitem>
340                             "keepOrder" and "uniqueNan" options introduced.
341                         </listitem>
342                         <listitem>
343                             Third output argument <literal>nb</literal> introduced.
344                         </listitem>
345                     </itemizedlist>
346                 </revdescription>
347             </revision>
348         </revhistory>
349     </refsection>
350 </refentry>