Changeset 2730 for trunk/src/CubicSplineInterpolator1D.h

Timestamp:

01/16/13 16:00:28 (11 years ago)

Author:

Takeshi Nakazato

Message:

New Development: No

JIRA Issue: Yes CAS-4770

Ready for Test: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs: List test programs

Put in Release Notes: Yes/No?

Module(s): Module Names change impacts.

Description: Describe your changes here...

Rewrite implementations for locator and interpolator.
Documentation (doxygen format) is added to header files.

File:

• trunk/src/CubicSplineInterpolator1D.h (modified) (1 diff)

trunk/src/CubicSplineInterpolator1D.h

@@ -18 +18 @@
 
 /**
- * Cubic spline interpolation
+ * Implementation of (natural) cubic spline interpolation.
  * @author TakeshiNakazato
  */
 class CubicSplineInterpolator1D : public Interpolator1D {
 public:
+  // Default constructor.
   CubicSplineInterpolator1D();
 
+  // Destructor.
   virtual ~CubicSplineInterpolator1D();
 
+  // Override Interpolator1D::setData.
+  // @see Interpolator1D::setData
+  void setData(double *x, float *y, unsigned int n);
+
+  // Override Interpolator1D::setY.
+  // @see Interpolator1D::setY()
   void setY(float *y, unsigned int n);
+
+  // Perform interpolation.
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @return interpolated value at x.
   float interpolate(double x);
 private:
-  // determine second derivatives of each point based on 
-  // natural cubic spline condition
-  void spline();
+  // Determine second derivatives of each point based on 
+  // natural cubic spline condition (second derivative at each 
+  // end is zero).
+  void evaly2();
 
-  // do interpolation using second derivatives from spline()
-  float splint(double x, unsigned int i);
+  // Do interpolation using second derivatives determined by evaly2().
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @param[in] i location index for x.
+  // @return interpolated value at x.
+  float dospline(double x, unsigned int i);
   
+  // Array to store second derivatives on the data points.
   float *y2_;
+
+  // number of data points for second derivatives
   unsigned int ny2_;
+
+  // Boolean parameter whether buffered values are effective or not.
   bool reusable_;
 };