BSpline2d.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Stephan Aiche, Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <vector>
 
#include <OpenMS/config.h>
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/CONCEPT/Macros.h>
 
// forward declaration of impl class BSpline
namespace eol_bspline
{
template <class T>
class BSpline;
}
 
namespace OpenMS
{
  class OPENMS_DLLAPI BSpline2d
  {
public:
 
    // Note: Don't change boundary condition constants as these are passed through to the eol-bspline implementation.
    enum BoundaryCondition
    {
      BC_ZERO_ENDPOINTS = 0,
      BC_ZERO_FIRST = 1,
      BC_ZERO_SECOND = 2
    };
 
    BSpline2d(const std::vector<double>& x, const std::vector<double>& y,
              double wavelength = 0, BoundaryCondition boundary_condition = BC_ZERO_SECOND, 
              Size num_nodes = 0);
 
    virtual ~BSpline2d();
 
    bool solve(const std::vector<double>& y);
 
    double eval(const double x) const;
 
    double derivative(const double x) const;
 
    bool ok() const;
 
    static void debug(bool enable);
 
private:
 
    // Pointer to actual implementation. Note: This class follows the PIMPL idiom hiding the actual 
    // B-spline implementation behind this pointer to avoid any dependency of the interface to the 
    // implementation. Thus, the eol splines are only required during compilation of OpenMS and 
    // not when linking against OpenMS.
    eol_bspline::BSpline<double>* spline_;
  };
 
}