source: trunk/SRC/Documentation/idldoc_html_output/Matrix/inter.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>inter.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="inter.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//inter.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="extrac2.html">&lt;&lt;prev file</a> | <a href="make_selection.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inter.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">inter.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 find the intersection between 2 matrices of whole numbers
91
92 see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/union.html">union</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="_inter">
107
108          <h2><a class="top" href="#container">top</a>inter <span class="categories">
109 Calculation
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>inter(<span class="result"><a href="#_inter_param_a">a</a>, <a href="#_inter_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 both a and b.
120
121 The empty set is denoted by an array with the first element equal to
122 -1.
123</div>
124
125         
126            <h3>Parameters</h3>
127       
128           
129            <h4 id="_inter_param_a">a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130              <span class="attr">in</span>
131             
132             
133              <span class="attr">required</span>
134             
135             
136             
137             
138            </h4>
139       
140          <div class="comments"> 
141 arrays of positive integers, which need not to be
142 sorted. Duplicate elements are ignored, as they have no effect on the
143 result
144</div>
145           
146            <h4 id="_inter_param_b">b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147              <span class="attr">in</span>
148             
149             
150              <span class="attr">required</span>
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments"> 
158 see a
159</div>
160           
161
162         
163
164         
165
166          <h3>Examples</h3><div class="preformat">
167
168   IDL> a = [2,4,6,8]
169   IDL> b = [6,1,3,2]
170   IDL> res=inter(a,b)
171              2           6
172 Right because 2 and 6 are in a and B.
173</div>
174          <h3>Version history</h3>
175         
176          <h4>Version</h4><div class="preformat">
177 $Id: inter.pro 378 2008-08-12 12:35:46Z pinsard $
178</div>
179          <h4>History</h4><div class="preformat">
180 <a href="http://www.dfanning.com/tips/set_operations.html"/>
181</div>
182         
183         
184          <h3>Known issues</h3>
185         
186         
187         
188          <h4>Restrictions</h4><div class="preformat"> 
189 These functions will not be efficient on sparse sets with wide
190 ranges, as they trade memory for efficiency.
191 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
192 is used, which creates arrays of size equal to the range of the
193 resulting set.
194</div>
195       
196         
197         
198         
199         
200         
201         
202         
203       
204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>           9</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
223</html>
Note: See TracBrowser for help on using the repository browser.