source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_fstdrv.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.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>spl_fstdrv.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="spl_fstdrv.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="../../../Interpolation//spl_fstdrv.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="quadrilateral2square.html">&lt;&lt;prev file</a> | <a href="spl_incr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="spl_fstdrv.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">Interpolation/</a></h1>
82      <h2 class="pro_file">spl_fstdrv.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 returns the values of the first derivative of
91 the interpolating function at the points X2i. It is a double
92 precision array.
93
94 Given the arrays X and Y, which tabulate a function (with the X[i]
95 and Y[i] in ascending order), and given an input value X2, the
96 <a href="..//Interpolation/spl_incr.html">spl_incr</a> function returns an interpolated value for the given
97 values of X2. The interpolation method is based on cubic spline, corrected
98 in a way that interpolated value are also in ascending order.
99</div>
100
101     
102
103     
104
105     
106
107     
108
109      <div id="routine_details">
110       
111
112        <div class="routine_details" id="_spl_fstdrv">
113
114          <h2><a class="top" href="#container">top</a>spl_fstdrv </h2>
115       
116          <p class="header">
117            <span class="result">result = </span>spl_fstdrv(<span class="result"><a href="#_spl_fstdrv_param_x">x</a>, <a href="#_spl_fstdrv_param_y">y</a>, <a href="#_spl_fstdrv_param_yscd">yscd</a>, <a href="#_spl_fstdrv_param_x2">x2</a></span>)</p>
118       
119          <div class="comments">
120</div>
121
122          <h3>Return value</h3><div class="preformat">
123 y2: f'(x2) = y2.
124</div>
125
126         
127            <h3>Parameters</h3>
128       
129           
130            <h4 id="_spl_fstdrv_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131              <span class="attr">in</span>
132             
133             
134              <span class="attr">required</span>
135             
136             
137             
138             
139            </h4>
140       
141          <div class="comments">
142 An n-elements (at least 2) input vector that specifies the
143 tabulate points in ascending order.
144</div>
145           
146            <h4 id="_spl_fstdrv_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147              <span class="attr">in</span>
148             
149             
150              <span class="attr">required</span>
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments">
158 f(x) = y. An n-elements input vector that specifies the values
159 of the tabulated function F(Xi) corresponding to Xi.
160</div>
161           
162            <h4 id="_spl_fstdrv_param_yscd">yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163              <span class="attr">in</span>
164             
165             
166              <span class="attr">required</span>
167             
168             
169             
170             
171            </h4>
172       
173          <div class="comments">
174 The output from <a href="/Applications/itt/idl64/help/online_help/SPL_INIT.html">SPL_INIT</a> for the specified X and Y.
175</div>
176           
177            <h4 id="_spl_fstdrv_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178              <span class="attr">in</span>
179             
180             
181              <span class="attr">required</span>
182             
183              <span class="attr">type:</span> <span class="value"> scalar or array</span>
184             
185             
186            </h4>
187       
188          <div class="comments">
189 The input values for which the first derivative values are desired.
190</div>
191           
192
193         
194
195         
196
197          <h3>Examples</h3><div class="preformat">
198
199   IDL> y2 =  spl_fstdrv(x, y, yscd, x2)
200</div>
201          <h3>Version history</h3>
202         
203          <h4>Version</h4><div class="preformat">
204 $Id: spl_fstdrv.pro 372 2008-08-08 12:31:53Z pinsard $
205</div>
206          <h4>History</h4><div class="preformat">
207 Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005
208</div>
209         
210         
211         
212         
213         
214         
215         
216       
217         
218         
219         
220         
221         
222         
223         
224       
225          <h3>Statistics</h3>
226          <table class="statistics">
227            <tr><td>McCabe cyclic</td><td>           4</td></tr>
228            <tr><td>McCabe essential</td><td>           1</td></tr>
229            <tr><td>McCabe modular design</td><td>           1</td></tr>
230          </table>
231         
232       
233        </div>
234       
235      </div>
236
237     
238
239      <div id="tagline">Produced by IDLdoc 2.0.</div>
240
241    </div>
242
243  </body>
244</html>
Note: See TracBrowser for help on using the repository browser.