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