source: trunk/SRC/Documentation/idldoc_html_output/Matrix/union.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.7 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 calculate the union between 2 matrices of whole numbers
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_union">
105
106          <h2><a class="top" href="#container">top</a>union <span class="categories">
107 Calculation
108</span></h2>
109       
110          <p class="header">
111            <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>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 tableau
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_union_param_a">a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 arrays of positive integers, which need
137               not be sorted. Duplicate elements are ignored, as they have no
138               effect on the result
139</div>
140           
141            <h4 id="_union_param_b">b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147             
148             
149             
150            </h4>
151       
152          <div class="comments"> 
153 see a
154</div>
155           
156
157         
158
159         
160
161          <h3>Examples</h3><div class="preformat">
162 IDL> a = [2,4,6,8]
163 IDL> b = [6,1,3,2]
164 IDL> union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set
165</div>
166          <h3>Version history</h3>
167         
168          <h4>Version</h4><div class="preformat">
169 $Id: union.pro 325 2007-12-06 10:04:53Z pinsard $
170</div>
171          <h4>History</h4><div class="preformat">
172 <a href="http://www.dfanning.com/tips/set_operations.html"/>
173</div>
174         
175         
176          <h3>Known issues</h3>
177         
178         
179         
180          <h4>Restrictions</h4><div class="preformat">
181 The empty set is denoted by an array with the first element equal to -1.
182
183 
184 These functions will not be efficient on sparse sets with wide
185 ranges, as they trade memory for efficiency.
186 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
187 is used, which creates arrays of size equal to the range of the
188 resulting set.
189</div>
190       
191         
192         
193         
194         
195         
196         
197         
198       
199          <h3>Statistics</h3>
200          <table class="statistics">
201            <tr><td>McCabe cyclic</td><td>           3</td></tr>
202            <tr><td>McCabe essential</td><td>           1</td></tr>
203            <tr><td>McCabe modular design</td><td>           1</td></tr>
204          </table>
205         
206       
207        </div>
208       
209      </div>
210
211     
212
213      <div id="tagline">Produced by IDLdoc 2.0.</div>
214
215    </div>
216
217  </body>
218</html>
Note: See TracBrowser for help on using the repository browser.