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

trunk/src/PolynomialInterpolator1D.h

@@ -18 +18 @@
 
 /**
- * Polynomial interpolation
+ * Implementation of polynomial interpolation.
  * @author TakeshiNakazato
  */
 class PolynomialInterpolator1D : public Interpolator1D {
 public:
+  // Default constructor.
   PolynomialInterpolator1D();
 
+  // Destructor.
   virtual ~PolynomialInterpolator1D();
 
+  // Perform interpolation.
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @return interpolated value at x.
   float interpolate(double x);
 private:
-  float polint(double x, unsigned int loc, unsigned int left, unsigned int n);
+  // Perform polynomial interpolation. 
+  // If (number of data points) >  (polynomial order + 1), polynomial 
+  // interpolation must be done in the sub-region that contains x. 
+  // This method takes arguments that specifies sub-region to be used. 
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @param[in] left the leftmost index of sub-region.
+  // @param[in] n number of data points of sub-region.
+  // @return interpolated value at x.
+  float dopoly(double x, unsigned int left, unsigned int n);
 };