Ignore:
Timestamp:
06/12/06 10:29:56 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Interpolation *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/spl_fstdrv.html

    r89 r101  
    8787      </div> 
    8888 
    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="_spl_fstdrv"> 
    103  
    104           <h2><a class="top" href="#container">top</a>spl_fstdrv </h2> 
    105          
    106           <p class="header"> 
    107             <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> 
    108          
    109           <div class="comments"> 
    110  NAME:spl_fstdrv 
    111  
    112  PURPOSE: SPL_FSTDRV returns the values of the first derivative of 
     89      <div id="file_comments"> SPL_FSTDRV returns the values of the first derivative of 
    11390 the interpolating function at the points X2i. it is a double 
    11491 precision array. 
     
    11996 of X2. The interpolation method is based on cubic spline, corrected 
    12097 in a way that interpolated value are also in ascending order 
    121  
    122  CATEGORY: 
    123  
    124  CALLING SEQUENCE: y2 =  spl_fstdrv(x, y, yscd, x2) 
    125  
    126  INPUTS: 
    127  
    128     x: An n-element (at least 2) input vector that specifies the 
     98</div> 
     99 
     100       
     101 
     102       
     103 
     104       
     105 
     106       
     107 
     108      <div id="routine_details"> 
     109         
     110 
     111        <div class="routine_details" id="_spl_fstdrv"> 
     112 
     113          <h2><a class="top" href="#container">top</a>spl_fstdrv </h2> 
     114         
     115          <p class="header"> 
     116            <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> 
     117         
     118          <div class="comments"> 
     119</div> 
     120 
     121          <h3>Return value</h3><div class="value">  
     122 
     123    y2: f'(x2) = y2.  
     124 
     125</div> 
     126 
     127           
     128            <h3>Parameters</h3> 
     129         
     130             
     131            <h4 id="_spl_fstdrv_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     132              <span class="attr">in</span> 
     133               
     134               
     135              <span class="attr">required</span> 
     136               
     137               
     138               
     139               
     140            </h4> 
     141         
     142          <div class="comments">  An n-element (at least 2) input vector that specifies the 
    129143    tabulate points in ascending order. 
    130  
    131     y: f(x) = y. An n-element input vector that specifies the values 
     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">  f(x) = y. An n-element input vector that specifies the values 
    132158    of the tabulated function F(Xi) corresponding to Xi. 
    133  
    134     yscd: The output from SPL_INIT for the specified X and Y. 
    135  
    136     x2: The input values for which the first derivative values are 
     159</div> 
     160             
     161            <h4 id="_spl_fstdrv_param_yscd">yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     162              <span class="attr">in</span> 
     163               
     164               
     165              <span class="attr">required</span> 
     166               
     167               
     168               
     169               
     170            </h4> 
     171         
     172          <div class="comments">  The output from SPL_INIT for the specified X and Y. 
     173</div> 
     174             
     175            <h4 id="_spl_fstdrv_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     176              <span class="attr">in</span> 
     177               
     178               
     179              <span class="attr">required</span> 
     180               
     181               
     182               
     183               
     184            </h4> 
     185         
     186          <div class="comments">  The input values for which the first derivative values are 
    137187    desired. X can be scalar or an array of values. 
    138  
    139  KEYWORD PARAMETERS: none 
    140  
    141  OUTPUTS:  
    142  
    143     y2: f'(x2) = y2.  
    144  
    145  COMMON BLOCKS: none 
    146  
    147  SIDE EFFECTS: ? 
    148  
    149  RESTRICTIONS: ? 
    150  
    151  EXAMPLE: 
    152  
    153  MODIFICATION HISTORY:</div> 
    154  
    155            
    156  
    157            
    158             <h3>Parameters</h3> 
    159          
    160              
    161             <h4 id="_spl_fstdrv_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    162                
    163                
    164                
    165                
    166                
    167                
    168                
    169                
    170             </h4> 
    171          
    172           <div class="comments"></div> 
    173              
    174             <h4 id="_spl_fstdrv_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    175                
    176                
    177                
    178                
    179                
    180                
    181                
    182                
    183             </h4> 
    184          
    185           <div class="comments"></div> 
    186              
    187             <h4 id="_spl_fstdrv_param_yscd">yscd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    188                
    189                
    190                
    191                
    192                
    193                
    194                
    195                
    196             </h4> 
    197          
    198           <div class="comments"></div> 
    199              
    200             <h4 id="_spl_fstdrv_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    201                
    202                
    203                
    204                
    205                
    206                
    207                
    208                
    209             </h4> 
    210          
    211           <div class="comments"></div> 
    212              
    213  
    214            
    215  
    216            
    217  
    218            
    219            
    220            
    221            
    222            
     188</div> 
     189             
     190 
     191           
     192 
     193           
     194 
     195          <h3>Examples</h3><div class="value">  y2 =  spl_fstdrv(x, y, yscd, x2) 
     196</div> 
     197          <h3>Version history</h3> 
     198           
     199           
     200          <h4>History</h4><div class="value"> 
     201  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005</div> 
    223202           
    224203           
Note: See TracChangeset for help on using the changeset viewer.