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

trunk/src/Interpolator1D.h

@@ -23 +23 @@
 class Interpolator1D {
 public:
+  // Default constructor.
   Interpolator1D();
 
+  // Destructor.
   virtual ~Interpolator1D();
 
+  // 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.
   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.
   void setX(double *x, unsigned int n);
+
+  // Set vertical data (y).
+  // @param[in] y pointer to vertical data.
+  // @param[in] n number of data.
   void setY(float *y, unsigned int n);
+
+  // Reset object.
   void reset();
 
-  // currently only effective for polynomial interpolation
+  // Set order for polynomial interpolation.
+  // @param order order of the polynomial.
+  // 
+  // This method is effective only for polynomial interpolation.
   void setOrder(unsigned int order) {order_ = order;}
 
+  // Perform interpolation.
+  // @param[in] x horizontal location where the value is evaluated 
+  //              by interpolation.
+  // @return interpolated value at x.
   virtual float interpolate(double x) = 0;
 
 protected:
-  int locate(double x);
+  // Locate x.
+  // @param[in] x horizontal location.
+  // @return location as an index.
+  // @see Locator::locate()
+  unsigned int locate(double x);
+
+  // Query function whether the object is ready to interpolate.
+  // @return true if object is ready else false.
   bool isready();
+
+  // Fuctory method to create appropriate Locator object.
   void createLocator();
 
+  // Order of the polynomial (only effective for polynomial interpolation).
   unsigned int order_;
+
+  // Number of data points.
   unsigned int n_;
+
+  // Horizontal data.
   double *x_;
+
+  // Vertical data.
   float *y_;
+
+  // Pointer to the Locator object.
   Locator *locator_;
 };