source: trunk/SRC/Documentation/idldoc_html_output/Utilities/linearequation.html @ 338

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

update documentation
File size: 4.9 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>linearequation.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="linearequation.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="../../../Utilities//linearequation.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="isafile.html">&lt;&lt;prev file</a> | <a href="lineintersection.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="linearequation.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">Utilities/</a></h1>
82      <h2 class="pro_file">linearequation.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Calculate a linear equation of the type ax+by+c=0
91 thanks to coordinates of 2 points.
92 comment: we can have a table with pairs of points.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_linearequation">
107
108          <h2><a class="top" href="#container">top</a>linearequation <span class="categories">
109 Utilities
110</span></h2>
111       
112          <p class="header">
113            <span class="result">result = </span>linearequation(<span class="result"><a href="#_linearequation_param_point1">point1</a>, <a href="#_linearequation_param_point2">point2</a></span>)</p>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 abc is a table of dimension 3, number_of_straight_line,
120 where for each line of the table we obtain the 3 parameters
121 a, b and c of the linear equation ax+by+c=0
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_linearequation_param_point1">point1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments">
140 This is the first point of (the) straight line(s) whose we want to calculate
141 equation(s)
142</div>
143           
144            <h4 id="_linearequation_param_point2">point2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145              <span class="attr">in</span>
146             
147             
148              <span class="attr">required</span>
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments">
156 This is the second point of (the) straight line(s) whose we want to calculate
157 equation(s)
158
159 There is 2 possibilities:
160      1) point is a complex or a table of complex, where each element is the coordinates of the point.
161      2) point is a table of real of dimension 2,number_of_straight_line.
162         For each row of the table, we have coordinates of the point.
163</div>
164           
165
166         
167
168         
169
170          <h3>Examples</h3><div class="preformat">
171 IDL> abc=linearequation(complex(1,2),[3,4])
172 IDL> print, abc[0]*1+abc[1]*2+abc[2]
173 0.00000
174</div>
175          <h3>Version history</h3>
176         
177          <h4>Version</h4><div class="preformat">
178 $Id: linearequation.pro 325 2007-12-06 10:04:53Z pinsard $
179</div>
180          <h4>History</h4><div class="preformat">
181 Sebastien Masson (smasson@lodyc.jussieu.fr)
182          10 juin 2000
183</div>
184         
185         
186         
187         
188         
189         
190         
191       
192         
193         
194         
195         
196         
197         
198         
199       
200          <h3>Statistics</h3>
201          <table class="statistics">
202            <tr><td>McCabe cyclic</td><td>           5</td></tr>
203            <tr><td>McCabe essential</td><td>           1</td></tr>
204            <tr><td>McCabe modular design</td><td>           1</td></tr>
205          </table>
206         
207       
208        </div>
209       
210      </div>
211
212     
213
214      <div id="tagline">Produced by IDLdoc 2.0.</div>
215
216    </div>
217
218  </body>
219</html>
Note: See TracBrowser for help on using the repository browser.