source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/lineintersection.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.2 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>lineintersection.pro (IDLdoc API 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="lineintersection.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="linearequation.html">&lt;&lt;prev file</a> | <a href="oups.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="lineintersection.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/UTILITAIRE/</a></h1>
82      <h2 class="pro_file">lineintersection.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_lineintersection">
103
104          <h2><a class="top" href="#container">top</a>lineintersection </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>lineintersection(<span class="result"><a href="#_lineintersection_param_abc1">abc1</a>, <a href="#_lineintersection_param_abc2">abc2</a></span>, <a href="#_lineintersection_keyword_FLOAT">FLOAT</a>=<span class="result">FLOAT</span>)</p>
108       
109          <div class="comments">
110 NAME: lineintersection
111
112 PURPOSE: Calcule les coordonnees de l''intersection de 2 droites ou
113 d''une serie de 2 droites
114
115 CATEGORY:petit truc qui peut etre utile (sans boucles, ca va de soit!)
116
117 CALLING SEQUENCE: point=lineintersection(abc1, abc2)
118 
119 INPUTS: abc est un tableau de dimensions 3,
120 nbre_de_couple_de_droites, dont chaque ligne contient les 3
121 parametres a, b, c de l''equation de droite du type ax+by+c=0
122
123 KEYWORD PARAMETERS:
124       /FLOAT: pour retourner l''output sous forme de tableau de
125       reel plutot que de vecteur decomplexes (par defaut)
126
127 OUTPUTS:2 possibilites:
128      1) par defaut: c''est une vecteur de complexe dont chaque
129      element est les coordonnees du point d''intersection d''un
130      couple de droites.
131      2) si /FLOAT est active, c'est un tableau de reels de
132      dimensiones 2, nbre_de_couple_de_droites dont chaque
133      ligne est les coordonnees du point d''intersection d''un
134      couple de droites
135
136 COMMON BLOCKS:
137
138 SIDE EFFECTS:si les deux droites dont paralleles, on retourne les
139 coordonnes (!values.f_nan,!values.f_nan)
140
141 RESTRICTIONS:attention a la precision de la machine qui fait que
142 les coordonnees calcules de verifient peut-etre pas exactement les
143 equations du couple de droites.
144
145 EXAMPLE:
146     IDL> abc1=linearequation(complex(1,2),[3,4])
147     IDL> abc2=linearequation(complex(1,2),[8,15])
148     IDL> print, lineintersection(abc1, abc2)
149     (      1.00000,      2.00000)
150     IDL> print, lineintersection(abc1, abc2,/float)
151           1.00000      2.00000
152</div>
153
154         
155
156         
157            <h3>Parameters</h3>
158       
159           
160            <h4 id="_lineintersection_param_abc1">abc1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161             
162             
163             
164             
165             
166             
167             
168             
169            </h4>
170       
171          <div class="comments"></div>
172           
173            <h4 id="_lineintersection_param_abc2">abc2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174             
175             
176             
177             
178             
179             
180             
181             
182            </h4>
183       
184          <div class="comments"></div>
185           
186
187         
188
189         
190
191            <h3>Keywords</h3>
192           
193            <h4 id="_lineintersection_keyword_FLOAT">FLOAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194             
195             
196             
197             
198             
199             
200             
201             
202            </h4>
203       
204            <div class="comments"></div>
205           
206         
207
208         
209         
210         
211         
212         
213         
214         
215         
216         
217         
218         
219         
220       
221         
222         
223         
224         
225         
226         
227         
228       
229         
230       
231        </div>
232       
233      </div>
234
235     
236
237      <div id="tagline">Produced by IDLdoc 2.0.</div>
238
239    </div>
240
241  </body>
242</html>
Note: See TracBrowser for help on using the repository browser.