1c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This file is part of Eigen, a lightweight C++ template library 2c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// for linear algebra. 3c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 4c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 20010-2011 Hauke Heibel <hauke.heibel@gmail.com> 5c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 6c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This Source Code Form is subject to the terms of the Mozilla 7c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Public License v. 2.0. If a copy of the MPL was not distributed 8c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// with this file, You can obtain one at http://mozilla.org/MPL/2.0/. 9c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 10c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#ifndef EIGEN_SPLINES_FWD_H 11c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#define EIGEN_SPLINES_FWD_H 12c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 13c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#include <Eigen/Core> 14c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 15c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathnamespace Eigen 16c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 17c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template <typename Scalar, int Dim, int Degree = Dynamic> class Spline; 18c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 19c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template < typename SplineType, int DerivativeOrder = Dynamic > struct SplineTraits {}; 20c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 21c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** 22c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \ingroup Splines_Module 23c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \brief Compile-time attributes of the Spline class for Dynamic degree. 24c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath **/ 25c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template <typename _Scalar, int _Dim, int _Degree> 26c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath struct SplineTraits< Spline<_Scalar, _Dim, _Degree>, Dynamic > 27c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 28c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef _Scalar Scalar; /*!< The spline curve's scalar type. */ 29c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { Dimension = _Dim /*!< The spline curve's dimension. */ }; 30c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { Degree = _Degree /*!< The spline curve's degree. */ }; 31c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 32c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { OrderAtCompileTime = _Degree==Dynamic ? Dynamic : _Degree+1 /*!< The spline curve's order at compile-time. */ }; 33c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { NumOfDerivativesAtCompileTime = OrderAtCompileTime /*!< The number of derivatives defined for the current spline. */ }; 34c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 35c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store non-zero basis functions. */ 36c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,1,OrderAtCompileTime> BasisVectorType; 37c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 38c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store the values of the basis function derivatives. */ 39c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,Dynamic,Dynamic,RowMajor,NumOfDerivativesAtCompileTime,OrderAtCompileTime> BasisDerivativeType; 40c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 41c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store the spline's derivative values. */ 42c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,Dimension,Dynamic,ColMajor,Dimension,NumOfDerivativesAtCompileTime> DerivativeType; 43c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 44c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The point type the spline is representing. */ 45c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,Dimension,1> PointType; 46c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 47c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store knot vectors. */ 48c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,1,Dynamic> KnotVectorType; 49c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 50c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type representing the spline's control points. */ 51c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<Scalar,Dimension,Dynamic> ControlPointVectorType; 52c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath }; 53c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 54c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** 55c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \ingroup Splines_Module 56c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \brief Compile-time attributes of the Spline class for fixed degree. 57c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 58c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * The traits class inherits all attributes from the SplineTraits of Dynamic degree. 59c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath **/ 60c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template < typename _Scalar, int _Dim, int _Degree, int _DerivativeOrder > 61c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath struct SplineTraits< Spline<_Scalar, _Dim, _Degree>, _DerivativeOrder > : public SplineTraits< Spline<_Scalar, _Dim, _Degree> > 62c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 63c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { OrderAtCompileTime = _Degree==Dynamic ? Dynamic : _Degree+1 /*!< The spline curve's order at compile-time. */ }; 64c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { NumOfDerivativesAtCompileTime = _DerivativeOrder==Dynamic ? Dynamic : _DerivativeOrder+1 /*!< The number of derivatives defined for the current spline. */ }; 65c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 66c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store the values of the basis function derivatives. */ 67c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<_Scalar,Dynamic,Dynamic,RowMajor,NumOfDerivativesAtCompileTime,OrderAtCompileTime> BasisDerivativeType; 68c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 69c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief The data type used to store the spline's derivative values. */ 70c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Array<_Scalar,_Dim,Dynamic,ColMajor,_Dim,NumOfDerivativesAtCompileTime> DerivativeType; 71c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath }; 72c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 73c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief 2D float B-spline with dynamic degree. */ 74c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Spline<float,2> Spline2f; 75c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 76c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief 3D float B-spline with dynamic degree. */ 77c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Spline<float,3> Spline3f; 78c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 79c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief 2D double B-spline with dynamic degree. */ 80c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Spline<double,2> Spline2d; 81c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 82c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** \brief 3D double B-spline with dynamic degree. */ 83c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef Spline<double,3> Spline3d; 84c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 85c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 86c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#endif // EIGEN_SPLINES_FWD_H 87