Changeset 1644

Timestamp:

Dec 13, 2008, 9:14:51 AM (12 years ago)

Author:

Jari Häkkinen

Message:

Addresses #466. Changed to VectorBase? passing. Added documentation.

Location:

trunk/yat/regression

Files:

• CSpline.cc (modified) (1 diff)
• CSpline.h (modified) (3 diffs)
• GSLInterpolation.cc (modified) (3 diffs)
• GSLInterpolation.h (modified) (4 diffs)

trunk/yat/regression/CSpline.cc

@@ -29 +29 @@
 
 
-  CSpline::CSpline(const utility::VectorConstView& x,
-                   const utility::VectorConstView& y)
+  CSpline::CSpline(const utility::VectorBase& x, const utility::VectorBase& y)
     : GSLInterpolation(gsl_interp_cspline,x,y)
   {

trunk/yat/regression/CSpline.h

@@ -28 +28 @@
 namespace yat {
 namespace utility {
-  class VectorConstView;
+  class VectorBase;
 }
 namespace regression {
 
   /**
-     @brief Documentation please.
+     \brief Cubic spline with natural boundary conditions.
+
+     The resulting curve is piecewise cubic on each interval, with
+     matching first and second derivatives at the supplied
+     data-points. The second derivative is chosen to be zero at the
+     first point and last point.
+
+     \see Please refer to the base class documentation for genereal
+     introduction to the GSL based interpolation methods.
   */
   class CSpline : public GSLInterpolation
@@ -40 +48 @@
   public:
     /**
-       @brief The default constructor
+       \brief The default constructor
     */
-    CSpline(const utility::VectorConstView& x,
-            const utility::VectorConstView& y);
+    CSpline(const utility::VectorBase& x, const utility::VectorBase& y);
 
     /**
-       @brief The destructor
+       \brief The destructor
     */
     ~CSpline(void);
@@ -52 +59 @@
   private:
     /**
-       Copy Constructor. (not implemented)
+       \brief Copy Constructor. (not implemented)
     */
     CSpline(const CSpline&);

trunk/yat/regression/GSLInterpolation.cc

@@ -22 +22 @@
 #include "GSLInterpolation.h"
 
-#include "yat/utility/VectorConstView.h"
+#include "yat/utility/VectorBase.h"
 
 #include <cassert>
@@ -32 +32 @@
 
   GSLInterpolation::GSLInterpolation(const gsl_interp_type* interpolator_type,
-                                     const utility::VectorConstView& x,
-                                     const utility::VectorConstView& y)
+                                     const utility::VectorBase& x,
+                                     const utility::VectorBase& y)
   {
     assert(x.size()==y.size());
@@ -43 +43 @@
       y_[i]=y(i);
     }
-    interpolator_=gsl_interp_alloc (interpolator_type, size);
+    interpolator_ = gsl_interp_alloc(interpolator_type, size);
     gsl_interp_init(interpolator_, x_, y_, size);
     accelerator_ = gsl_interp_accel_alloc();

trunk/yat/regression/GSLInterpolation.h

@@ -28 +28 @@
 namespace yat {
 namespace utility {
-  class VectorConstView;
+  class VectorBase;
 }
 namespace regression {
 
   /**
-     @brief Documentation please.
+     \brief Base class for interfacing GSL interpolation.
+
+     The GSL interpolation is descibed in
+     http://www.gnu.org/software/gsl/manual/html_node/Interpolation.html. The
+     GSL library provides a variety of interpolation methods,
+     including Cubic splines and Akima splines. Interpolations can be
+     defined for both normal and periodic boundary
+     conditions. Additional functions are available for computing
+     derivatives and integrals of interpolating functions.
+
+     Given a set of data points \f$ (x_1, y_1) \dots (x_n, y_n) \f$
+     the sub classescompute a continuous interpolating function \f$
+     y(x) \f$ such that \f$ y(x_i) = y_i \f$. The interpolation is
+     piecewise smooth, and its behavior at the end-points is
+     determined by the type of interpolation used.
   */
   class GSLInterpolation
@@ -41 +55 @@
 
     /**
-       @brief Documentation please.
+       \brief Calculate the interpolated value for \a x.
+
+       \return The interpolated value of \f$ y \f$ for a given point
+       \a x.
     */
     double evaluate(const double x) const;
@@ -47 +64 @@
   protected:
     /**
-       @brief The default constructor
+       \brief The default constructor
+
+       Initializion of the interpolation object for the data \f$ (x,
+       y) \f$ where \a x and \a y are vector like objects of the same
+       size. The content of \a x and \a y are copied for internal
+       storage. \a x is always assumed to be strictly ordered, with
+       increasing \a x values; the behavior for other arrangements is
+       not defined.
     */
-    GSLInterpolation(const gsl_interp_type*, const utility::VectorConstView& x,
-                     const utility::VectorConstView& y);
+    GSLInterpolation(const gsl_interp_type*, const utility::VectorBase& x,
+                     const utility::VectorBase& y);
 
     /**
-       @brief The destructor
+       \brief The destructor
     */
     virtual ~GSLInterpolation(void);
@@ -59 +83 @@
   private:
     /**
-       Copy Constructor. (not implemented)
+       \brief Copy Constructor. (not implemented)
     */
     GSLInterpolation(const GSLInterpolation&);