source: trunk/SRC/Documentation/idldoc_assistant_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: 3.7 KB
RevLine 
[163]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
[234]63   
[402]64 find the intersection between 2 matrices of whole numbers
[163]65
[402]66 see also <a href="..//Matrix/different.html">different</a> and <a href="..//Matrix/union.html">union</a>
[163]67
[402]68
[163]69   
70
71     
72      <a name="#_inter"></a>
73
[234]74      <h2>inter  <font size="-1" color="#006633">
[163]75 Calculation
76</font></h2>
77
78      <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>
79
80   
81
82
[242]83    <h3>Return value</h3>
[402]84 an array containing the set of values in both a and b.
[163]85
[402]86 The empty set is denoted by an array with the first element equal to
87 -1.
[163]88
[402]89
[163]90   
91    <h3>Parameters</h3>
92   
93
94    <a name="#_inter_keyword_a"></a>
95    <h4>a&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
96      <font size="-1" color="#006633">in</font>
97     
98     
99      <font size="-1" color="#006633">required</font>
100     
101     
102     
103     
104    </h4>
105
[242]106     
107 arrays of positive integers, which need not to be
[163]108 sorted. Duplicate elements are ignored, as they have no effect on the
109 result
110
111   
112
113    <a name="#_inter_keyword_b"></a>
114    <h4>b&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115      <font size="-1" color="#006633">in</font>
116     
117     
118      <font size="-1" color="#006633">required</font>
119     
120     
121     
122     
123    </h4>
124
[242]125     
126 see a
[163]127
128   
129   
130
131   
132
[234]133    <h3>Examples</h3><pre>
[163]134
[402]135   IDL> a = [2,4,6,8]
136   IDL> b = [6,1,3,2]
137   IDL> res=inter(a,b)
138              2           6
139 Right because 2 and 6 are in a and B.
140
[234]141    </pre><h3>Version history</h3>
[163]142   
[234]143    <h4>Version</h4>
[402]144 $Id: inter.pro 378 2008-08-12 12:35:46Z pinsard $
[163]145
[234]146    <h4>History</h4>
147 <a href="http://www.dfanning.com/tips/set_operations.html"/>
[163]148
149   
150
151    <h3>Known issues</h3>
152   
153   
154   
[242]155    <h4>Restrictions</h4> 
[163]156 These functions will not be efficient on sparse sets with wide
[242]157 ranges, as they trade memory for efficiency.
[338]158 The <a href="/Applications/itt/idl64/help/online_help/HISTOGRAM.html">HISTOGRAM</a> function
[163]159 is used, which creates arrays of size equal to the range of the
160 resulting set.
161
162
163   
164   
165   
166   
167   
168   
169   
170
171    <font size="-3"><p>&nbsp;</p></font>
172    <hr size="1" color="#CCCCCC"/>
173     
174
175   
176
[187]177    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]178
179  </body>
[249]180</html>
Note: See TracBrowser for help on using the repository browser.