source: trunk/yat/regression/CSplinePeriodicInterpolation.h @ 1647

#ifndef _theplu_yat_regression_cspline_periodic_interpolation_
#define _theplu_yat_regression_cspline_periodic_interpolation_

// $Id: CSplinePeriodicInterpolation.h 1647 2008-12-13 08:45:44Z jari $

/*
  Copyright (C) 2008 Jari Häkkinen

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "GSLInterpolation.h"

namespace theplu {
namespace yat {
namespace utility {
  class VectorBase;
}
namespace regression {

  /**
     \brief Cubic spline with periodic boundary conditions.

     The resulting curve is piecewise cubic on each interval, with
     matching first and second derivatives at the supplied
     data-points. The derivatives at the first and last points are
     also matched. Note that the last point in the data must have the
     same y-value as the first point, otherwise the resulting periodic
     interpolation will have a discontinuity at the boundary.

     \see Please refer to the base class documentation for genereal
     introduction to the GSL based interpolation methods.
  */
  class CSplinePeriodicInterpolation : public GSLInterpolation
  {

  public:
    /**
       \brief The default constructor
    */
    CSplinePeriodicInterpolation(const utility::VectorBase& x,
                                 const utility::VectorBase& y);

    /**
       \brief The destructor
    */
    ~CSplinePeriodicInterpolation(void);

  private:
    /**
       \brief Copy Constructor. (not implemented)
    */
    CSplinePeriodicInterpolation(const CSplinePeriodicInterpolation&);

  };

}}} // of namespaces regression, yat, and theplu

#endif