source: trunk/SRC/Documentation/idldoc_assistant_output/Matrix/union.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 3.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>union.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="make_selection.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="zero_one.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Matrix/</font></h1>
58    <h2>union.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 find the union between 2 matrices of whole numbers
65
66 see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/inter.html">inter</a>.
67
68
69   
70
71     
72      <a name="#_union"></a>
73
74      <h2>union  <font size="-1" color="#006633">
75 Calculation
76</font></h2>
77
78      <p><font face="Courier"><i>result = </i>union(<i><a href="#_union_keyword_a">a</a>, <a href="#_union_keyword_b">b</a></i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3>
84 an array containing the set of values in a and b.
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_union_keyword_a"></a>
92    <h4>a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
98     
99     
100     
101    </h4>
102
103   
104 arrays of positive integers, which need
105 not be sorted. Duplicate elements are ignored, as they have no
106 effect on the result
107
108   
109
110    <a name="#_union_keyword_b"></a>
111    <h4>b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114     
115      <font size="-1" color="#006633">required</font>
116     
117     
118     
119     
120    </h4>
121
122     
123 see a
124
125   
126   
127
128   
129
130    <h3>Examples</h3><pre>
131
132   IDL> a = [2,4,6,8]
133   IDL> b = [6,1,3,2]
134   IDL> res=union(a,b)
135   IDL> print, res
136           1           2           3           4           5           6
137           8
138 this is the list ao all elements in either sets.
139
140    </pre><h3>Version history</h3>
141   
142    <h4>Version</h4>
143 $Id: union.pro 378 2008-08-12 12:35:46Z pinsard $
144
145    <h4>History</h4>
146 <a href="http://www.dfanning.com/tips/set_operations.html"/>
147
148   
149
150    <h3>Known issues</h3>
151   
152   
153   
154    <h4>Restrictions</h4> 
155 These functions will not be efficient on sparse sets with wide
156 ranges, as they trade memory for efficiency.
157 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
158 is used, which creates arrays of size equal to the range of the
159 resulting set.
160
161
162   
163   
164   
165   
166   
167   
168   
169
170    <font size="-3"><p>&nbsp;</p></font>
171    <hr size="1" color="#CCCCCC"/>
172     
173
174   
175
176    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
177
178  </body>
179</html>
Note: See TracBrowser for help on using the repository browser.