source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/spl_fstdrv.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 4.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>spl_fstdrv.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="quadrilateral2square.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="spl_incr.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>spl_fstdrv.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 SPL_FSTDRV returns the values of the first derivative of
65 the interpolating function at the points X2i. it is a double
66 precision array.
67
68 Given the arrays X and Y, which tabulate a function (with the X[i]
69 AND Y[i] in ascending order), and given an input value X2, the
70 SPL_INCR function returns an interpolated value for the given values
71 of X2. The interpolation method is based on cubic spline, corrected
72 in a way that interpolated value are also in ascending order
73
74
75   
76
77     
78      <a name="#_spl_fstdrv"></a>
79
80      <h2>spl_fstdrv  </h2>
81
82      <p><font face="Courier"><i>result = </i>spl_fstdrv(<i><a href="#_spl_fstdrv_keyword_x">x</a>, <a href="#_spl_fstdrv_keyword_y">y</a>, <a href="#_spl_fstdrv_keyword_yscd">yscd</a>, <a href="#_spl_fstdrv_keyword_x2">x2</a></i>)</font></p>
83
84   
85
86
87    <h3>Return value</h3>
88
89    y2: f'(x2) = y2.
90
91
92   
93    <h3>Parameters</h3>
94   
95
96    <a name="#_spl_fstdrv_keyword_x"></a>
97    <h4>x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
98      <font size="-1" color="#006633">in</font>
99     
100     
101      <font size="-1" color="#006633">required</font>
102     
103     
104     
105     
106    </h4>
107
108   
109 An n-element (at least 2) input vector that specifies the
110 tabulate points in ascending order.
111
112   
113
114    <a name="#_spl_fstdrv_keyword_y"></a>
115    <h4>y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116      <font size="-1" color="#006633">in</font>
117     
118     
119      <font size="-1" color="#006633">required</font>
120     
121     
122     
123     
124    </h4>
125
126   
127 f(x) = y. An n-element input vector that specifies the values
128 of the tabulated function F(Xi) corresponding to Xi.
129
130   
131
132    <a name="#_spl_fstdrv_keyword_yscd"></a>
133    <h4>yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134      <font size="-1" color="#006633">in</font>
135     
136     
137      <font size="-1" color="#006633">required</font>
138     
139     
140     
141     
142    </h4>
143
144   
145 The output from SPL_INIT for the specified X and Y.
146
147   
148
149    <a name="#_spl_fstdrv_keyword_x2"></a>
150    <h4>x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151      <font size="-1" color="#006633">in</font>
152     
153     
154      <font size="-1" color="#006633">required</font>
155     
156     
157     
158     
159    </h4>
160
161   
162 The input values for which the first derivative values are desired.
163 X can be scalar or an array of values.
164
165   
166   
167
168   
169
170    <h3>Examples</h3>
171 IDL> y2 =  spl_fstdrv(x, y, yscd, x2)
172
173    <h3>Version history</h3>
174   
175    <h4>Version</h4> $Id: spl_fstdrv.pro 134 2006-07-07 10:19:08Z navarro $
176
177    <h4>History</h4>
178  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005
179
180   
181
182   
183   
184   
185   
186   
187
188   
189   
190   
191   
192   
193   
194   
195
196    <font size="-3"><p>&nbsp;</p></font>
197    <hr size="1" color="#CCCCCC"/>
198     
199
200   
201
202    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:20 2006.</font></p>
203
204  </body>
205</html>
Note: See TracBrowser for help on using the repository browser.