Changeset 118 for trunk/SRC/Interpolation/spl_incr.pro

Timestamp:

06/27/06 17:47:06 (18 years ago)

Author:

pinsard

Message:

add $ in Calendar, Grid, Interpolation, Obsolete and Postscript *.pro files, add svn:keywords Id to all these files, some improvements in header

File:

• trunk/SRC/Interpolation/spl_incr.pro (modified) (4 diffs, 1 prop)

trunk/SRC/Interpolation/spl_incr.pro

@@ -12 +12 @@
 ; in a way that interpolated values are also monotonically increasing.
 ;
-; @examples  y2 =  spl_incr(x, y, x2)
-;
-; @param x1 {in}{required}  An n-element (at least 2) input vector that specifies the
-;    tabulate points in a strict ascending order.
-;
-;    @param y1 {in}{required}  f(x) = y. An n-element input vector that specifies the values
+; @examples
+; IDL>  y2 =  spl_incr(x, y, x2)
+;
+; @param x1 {in}{required}  
+; An n-element (at least 2) input vector that specifies the tabulate points in 
+; a strict ascending order.
+;
+; @param y1 {in}{required}  
+; f(x) = y. An n-element input vector that specifies the values
 ;    of the tabulated function F(Xi) corresponding to Xi. As f is
 ;    supposed to be monotonically increasing, y values must be
 ;    monotonically increasing. y can have equal consecutive values.
 ;
-;    @param x2 {in}{required}  The input values for which the interpolated values are
-;    desired. Its values must be strictly monotonically increasing. 
-;
-;
-;
+; @param x2 {in}{required}  
+; The input values for which the interpolated values are
+; desired. Its values must be strictly monotonically increasing. 
+;
+; @param der2
+; @param x 
 ;
 ; @returns 
@@ -38 +42 @@
 ; @examples 
 ;
-;     n = 100L
-;     x = (dindgen(n))^2
-;     y = abs(randomn(0, n))
-;     y[n/2:n/2+1] = 0.
-;     y[n-n/3] = 0.
-;     y[n-n/6:n-n/6+5] = 0.
-;     y = total(y, /cumulative, /double)
-;     x2 = dindgen((n-1)^2)
-;     n2 = n_elements(x2)
-;     print, min(y[1:n-1]-y[0:n-2]) LT 0
-;     y2 = spl_incr( x, y, x2)
-;     splot, x, y, xstyle = 1, ystyle = 1, ysurx=.25, petit = [1, 2, 1], /land
-;     oplot, x2, y2, color = 100
-;     c = y2[1:n2-1] - y2[0:n2-2]
-;     print, min(c) LT 0 
-;     print, min(c, max = ma), ma
-;     splot,c,xstyle=1,ystyle=1, yrange=[-.01,.05], ysurx=.25, petit = [1, 2, 2], /noerase
-;     oplot,[0, n_elements(c)], [0, 0], linestyle = 1
+; IDL> n = 100L
+; IDL> x = (dindgen(n))^2 
+; IDL> y = abs(randomn(0, n))
+; IDL> y[n/2:n/2+1] = 0.
+; IDL> y[n-n/3] = 0.
+; IDL> y[n-n/6:n-n/6+5] = 0.
+; IDL> y = total(y, /cumulative, /double)
+; IDL> x2 = dindgen((n-1)^2)
+; IDL> n2 = n_elements(x2)
+; IDL> print, min(y[1:n-1]-y[0:n-2]) LT 0
+; IDL> y2 = spl_incr( x, y, x2)
+; IDL> splot, x, y, xstyle = 1, ystyle = 1, ysurx=.25, petit = [1, 2, 1], /land
+; IDL> oplot, x2, y2, color = 100
+; IDL> c = y2[1:n2-1] - y2[0:n2-2]
+; IDL> print, min(c) LT 0 
+; IDL> print, min(c, max = ma), ma
+; IDL> splot,c,xstyle=1,ystyle=1, yrange=[-.01,.05], ysurx=.25, petit = [1, 2, 2], /noerase
+; IDL> oplot,[0, n_elements(c)], [0, 0], linestyle = 1
 ;
 ; @history
 ;  Sebastien Masson (smasson\@lodyc.jussieu.fr): May-Dec 2005
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -82 +89 @@
 END
 
+;+
+; @param x1 {in}{required}  
+; An n-element (at least 2) input vector that specifies the tabulate points in 
+; a strict ascending order.
+;
+; @param y1 {in}{required}  
+; f(x) = y. An n-element input vector that specifies the values
+;    of the tabulated function F(Xi) corresponding to Xi. As f is
+;    supposed to be monotonically increasing, y values must be
+;    monotonically increasing. y can have equal consecutive values.
+;
+; @param x2 {in}{required}  
+; The input values for which the interpolated values are
+; desired. Its values must be strictly monotonically increasing. 
+;
+; @param der2
+; @param x 
+;
+;-
 FUNCTION pure_convex, x1, x2, y1, y2, der2, x
 ; 1-(1-X)^n type
@@ -103 +129 @@
 
 ;+
-; @keyword    YP0 The first derivative of the interpolating function at the
+; @param x
+; @param y
+; @param x2
+; @keyword YP0 The first derivative of the interpolating function at the
 ;    point X0. If YP0 is omitted, the second derivative at the
 ;    boundary is set to zero, resulting in a "natural spline."
-; @keyword    YPN_1 The first derivative of the interpolating function at the
+; @keyword YPN_1 The first derivative of the interpolating function at the
 ;    point Xn-1. If YPN_1 is omitted, the second derivative at the
 ;    boundary is set to zero, resulting in a "natural spline."