Changeset 2730 for trunk/src/BufferedLinearInterpolator1D.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/BufferedLinearInterpolator1D.h (modified) (1 diff)

trunk/src/BufferedLinearInterpolator1D.h

@@ -18 +18 @@
 
 /**
- * Linear interpolation with some buffers
+ * Linear interpolation with some buffers for acceleration.
  * @author TakeshiNakazato
  */
 class BufferedLinearInterpolator1D : public Interpolator1D {
 public:
+  // Default constructor.
   BufferedLinearInterpolator1D();
 
+  // Destructor.
   virtual ~BufferedLinearInterpolator1D();
 
+  // Set horizontal (x) and vertical (y) data.
+  // @param[in] x pointer to horizontal data.
+  // @param[in] y pointer to vertical data.
+  // @param[in] n number of data.
+  // @see Interpolator1D::setData()
+  void setData(double *x, float *y, unsigned int n);
+
+  // Set horizontal data (x).
+  // @param[in] x pointer to horizontal data.
+  // @param[in] n number of data.
+  // @see Interpolator1D::setX()
   void setX(double *x, unsigned int n);
+
+  // Perform interpolation.
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @return interpolated value at x.
+  // @see Interpolator1D::interpolate()
   float interpolate(double x);
 
 private:
+  // Numerical factor for linear interpolation.
   double factor_;
+
+  // Previous location.
   double xold_;
+
+  // Previous location as an index 
   unsigned int prev_;
+
+  // Boolean parameter whether buffered values are effective or not.
   bool reusable_;
 };