source: trunk/SRC/Documentation/idldoc_html_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: 4.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>union.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="union.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Matrix//union.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="make_selection.html">&lt;&lt;prev file</a> | <a href="zero_one.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="union.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Matrix/</a></h1>
82      <h2 class="pro_file">union.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 find the union between 2 matrices of whole numbers
91
92 see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/inter.html">inter</a>.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_union">
107
108          <h2><a class="top" href="#container">top</a>union <span class="categories">
109 Calculation
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>union(<span class="result"><a href="#_union_param_a">a</a>, <a href="#_union_param_b">b</a></span>)</p>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 an array containing the set of values in a and b.
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_union_param_a">a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132             
133             
134             
135            </h4>
136       
137          <div class="comments">
138 arrays of positive integers, which need
139 not be sorted. Duplicate elements are ignored, as they have no
140 effect on the result
141</div>
142           
143            <h4 id="_union_param_b">b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146             
147              <span class="attr">required</span>
148             
149             
150             
151             
152            </h4>
153       
154          <div class="comments"> 
155 see a
156</div>
157           
158
159         
160
161         
162
163          <h3>Examples</h3><div class="preformat">
164
165   IDL> a = [2,4,6,8]
166   IDL> b = [6,1,3,2]
167   IDL> res=union(a,b)
168   IDL> print, res
169           1           2           3           4           5           6
170           8
171 this is the list ao all elements in either sets.
172</div>
173          <h3>Version history</h3>
174         
175          <h4>Version</h4><div class="preformat">
176 $Id: union.pro 378 2008-08-12 12:35:46Z pinsard $
177</div>
178          <h4>History</h4><div class="preformat">
179 <a href="http://www.dfanning.com/tips/set_operations.html"/>
180</div>
181         
182         
183          <h3>Known issues</h3>
184         
185         
186         
187          <h4>Restrictions</h4><div class="preformat"> 
188 These functions will not be efficient on sparse sets with wide
189 ranges, as they trade memory for efficiency.
190 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
191 is used, which creates arrays of size equal to the range of the
192 resulting set.
193</div>
194       
195         
196         
197         
198         
199         
200         
201         
202       
203          <h3>Statistics</h3>
204          <table class="statistics">
205            <tr><td>McCabe cyclic</td><td>           3</td></tr>
206            <tr><td>McCabe essential</td><td>           1</td></tr>
207            <tr><td>McCabe modular design</td><td>           1</td></tr>
208          </table>
209         
210       
211        </div>
212       
213      </div>
214
215     
216
217      <div id="tagline">Produced by IDLdoc 2.0.</div>
218
219    </div>
220
221  </body>
222</html>
Note: See TracBrowser for help on using the repository browser.