source: trunk/SRC/Documentation/idldoc_assistant_output/Matrix/inter.html @ 338

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

update documentation

File size: 3.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>inter.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="extrac2.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="make_selection.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>inter.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 calculate the intersection between 2 matrices of whole numbers
65
66
67   
68
69     
70      <a name="#_inter"></a>
71
72      <h2>inter  <font size="-1" color="#006633">
73 Calculation
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>inter(<i><a href="#_inter_keyword_a">a</a>, <a href="#_inter_keyword_b">b</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 tableau
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_inter_keyword_a"></a>
90    <h4>a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96     
97     
98     
99    </h4>
100
101     
102 arrays of positive integers, which need not to be
103 sorted. Duplicate elements are ignored, as they have no effect on the
104 result
105
106   
107
108    <a name="#_inter_keyword_b"></a>
109    <h4>b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115     
116     
117     
118    </h4>
119
120     
121 see a
122
123   
124   
125
126   
127
128    <h3>Examples</h3><pre>
129 IDL> a = [2,4,6,8]
130 IDL> b = [6,1,3,2]
131 IDL> inter(a,b) = [ 2, 6]       ; Common elements
132
133    </pre><h3>Version history</h3>
134   
135    <h4>Version</h4>
136 $Id: inter.pro 325 2007-12-06 10:04:53Z pinsard $
137
138    <h4>History</h4>
139 <a href="http://www.dfanning.com/tips/set_operations.html"/>
140
141   
142
143    <h3>Known issues</h3>
144   
145   
146   
147    <h4>Restrictions</h4> 
148 The empty set is denoted by an array with the first element equal to
149 -1.
150
151 
152 These functions will not be efficient on sparse sets with wide
153 ranges, as they trade memory for efficiency.
154 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
155 is used, which creates arrays of size equal to the range of the
156 resulting set.
157
158
159   
160   
161   
162   
163   
164   
165   
166
167    <font size="-3"><p>&nbsp;</p></font>
168    <hr size="1" color="#CCCCCC"/>
169     
170
171   
172
173    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
174
175  </body>
176</html>
Note: See TracBrowser for help on using the repository browser.