source: trunk/SRC/Documentation/idldoc_html_output/Matrix/inter.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

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