source: trunk/SRC/Documentation/idldoc_assistant_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: 3.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>linearequation.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="isafile.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="lineintersection.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>linearequation.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Calculate a linear equation of the type ax+by+c=0
65 thanks to coordinates of 2 points.
66 comment: we can have a table with pairs of points.
67
68
69   
70
71     
72      <a name="#_linearequation"></a>
73
74      <h2>linearequation  <font size="-1" color="#006633">
75 Utilities
76</font></h2>
77
78      <p><font face="Courier"><i>result = </i>linearequation(<i><a href="#_linearequation_keyword_point1">point1</a>, <a href="#_linearequation_keyword_point2">point2</a></i>)</font></p>
79
80   
81
82
83    <h3>Return value</h3>
84 abc is a table of dimension 3, number_of_straight_line,
85 where for each line of the table we obtain the 3 parameters
86 a, b and c of the linear equation ax+by+c=0
87
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_linearequation_keyword_point1"></a>
94    <h4>point1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95      <font size="-1" color="#006633">in</font>
96     
97     
98      <font size="-1" color="#006633">required</font>
99     
100     
101     
102     
103    </h4>
104
105   
106 This is the first point of (the) straight line(s) whose we want to calculate
107 equation(s)
108
109   
110
111    <a name="#_linearequation_keyword_point2"></a>
112    <h4>point2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113      <font size="-1" color="#006633">in</font>
114     
115     
116      <font size="-1" color="#006633">required</font>
117     
118     
119     
120     
121    </h4>
122
123   
124 This is the second point of (the) straight line(s) whose we want to calculate
125 equation(s)
126
127 There is 2 possibilities:
128      1) point is a complex or a table of complex, where each element is the coordinates of the point.
129      2) point is a table of real of dimension 2,number_of_straight_line.
130         For each row of the table, we have coordinates of the point.
131
132   
133   
134
135   
136
137    <h3>Examples</h3><pre>
138 IDL> abc=linearequation(complex(1,2),[3,4])
139 IDL> print, abc[0]*1+abc[1]*2+abc[2]
140 0.00000
141
142    </pre><h3>Version history</h3>
143   
144    <h4>Version</h4>
145 $Id: linearequation.pro 325 2007-12-06 10:04:53Z pinsard $
146
147    <h4>History</h4>
148 Sebastien Masson (smasson@lodyc.jussieu.fr)
149          10 juin 2000
150
151   
152
153   
154   
155   
156   
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.