Compute the regression splines coefficients of an additive model. More...

#include <STK_AdditiveBSplineCoefficients.h>

Inheritance diagram for STK::AdditiveBSplineCoefficients< Array >:

Public Types
typedef hidden::Traits< Array >::Row	RowVector

typedef hidden::Traits< Array >::Col	ColVector

Public Member Functions
	AdditiveBSplineCoefficients (Array const *p_data, int nbControlPoints, int degree=3, Regress::KnotsPosition position=Regress::uniformKnotsPositions_)
	Constructor : initialize the data members.

	AdditiveBSplineCoefficients (Array const &data, int nbControlPoints, int degree=3, Regress::KnotsPosition position=Regress::uniformKnotsPositions_)
	Constructor : initialize the data members.

	AdditiveBSplineCoefficients (AdditiveBSplineCoefficients const &coefs)
	Copy constructor.

virtual	~AdditiveBSplineCoefficients ()
	Destructor.

AdditiveBSplineCoefficients *	clone () const
	clone pattern implementation

void	setData (Array const *p_data, int nbControlPoints, int degree=3, Regress::KnotsPosition position=Regress::uniformKnotsPositions_)
	Compute the coefficients of the B-spline curve for the given values.

bool	run ()
	run the computations.

int	degree () const
	give the degree of the B-spline curves.

int	nbKnots () const
	give the number of knots of the B-spline curves.

int	nbControlPoints () const
	give the number of control points of the B-spline curves.

ArrayXX const &	coefficients () const
	give the computed coefficients of the B-spline curves.

ArrayXX	extrapolate (Array const &x) const

Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Protected Attributes
Array const *	p_data_
	the input data set

int	nbKnots_
	number of knots of the B-spline curves.

int	nbControlPoints_
	number of control points of the B-spline curves.

int	degree_
	degree of the B-splines curves.

Regress::KnotsPosition	position_
	Method used in order to position the knots.

Array1D< BSplineCoefficients< ColVector > >	coefs_
	Array with the knots and coefficients in each dimension.

ArrayXX	coefficients_
	Array of the coefficients.

Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.

bool	hasRun_
	`true` if run has been used, `false` otherwise

Additional Inherited Members
Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

virtual void	update ()
	update the runner.

Detailed Description

template<class Array>
class STK::AdditiveBSplineCoefficients< Array >

Compute the regression splines coefficients of an additive model.

The method is described in BSplineCoefficients documentation class and repeated for each variables of the model. The number of control points, the degree and the position of the knots are the same for all variables.

If the input data set is a matrix of size (n,p) then the output matrix of the coefficients Coefficients() is a matrix of size (n, p*nbControlPoints) where p is the number of variables.

Definition at line 56 of file STK_AdditiveBSplineCoefficients.h.

Member Typedef Documentation

◆ ColVector

template<class Array >

typedef hidden::Traits<Array>::Col STK::AdditiveBSplineCoefficients< Array >::ColVector

Definition at line 60 of file STK_AdditiveBSplineCoefficients.h.

◆ RowVector

template<class Array >

typedef hidden::Traits<Array>::Row STK::AdditiveBSplineCoefficients< Array >::RowVector

Definition at line 59 of file STK_AdditiveBSplineCoefficients.h.

Constructor & Destructor Documentation

◆ AdditiveBSplineCoefficients() [1/3]

template<class Array >

STK::AdditiveBSplineCoefficients< Array >::AdditiveBSplineCoefficients	(	Array const *	p_data,
		int	nbControlPoints,
		int	degree = `3`,
		Regress::KnotsPosition	position = `Regress::uniformKnotsPositions_`
	)

inline

Constructor : initialize the data members.

The number of knots is given by the formula nbKnots = nbControlPoints + degree +1.

Parameters

p_data	a pointer on the input data values
nbControlPoints	number of control points
degree	degree of the B-spline curves
position	method to use for positioning the knots

Definition at line 68 of file STK_AdditiveBSplineCoefficients.h.

                               : IRunnerBase()
                               , p_data_(p_data)
                               , nbKnots_(nbControlPoints + degree +1)
                               , nbControlPoints_(nbControlPoints)
                               , degree_(degree)
                               , position_(position)
                               , coefficients_()
    {}

◆ AdditiveBSplineCoefficients() [2/3]

template<class Array >

STK::AdditiveBSplineCoefficients< Array >::AdditiveBSplineCoefficients	(	Array const &	data,
		int	nbControlPoints,
		int	degree = `3`,
		Regress::KnotsPosition	position = `Regress::uniformKnotsPositions_`
	)

inline

Constructor : initialize the data members.

The number of knots is given by the formula nbKnots = nbControlPoints + degree +1.

Parameters

data	the input data values
nbControlPoints	number of control points
degree	degree of the B-spline curves
position	method to use for positioning the knots

Definition at line 88 of file STK_AdditiveBSplineCoefficients.h.

                               : IRunnerBase()
                               , p_data_(&data)
                               , nbKnots_(nbControlPoints + degree +1)
                               , nbControlPoints_(nbControlPoints)
                               , degree_(degree)
                               , position_(position)
                               , coefficients_()
    {}

◆ AdditiveBSplineCoefficients() [3/3]

template<class Array >

STK::AdditiveBSplineCoefficients< Array >::AdditiveBSplineCoefficients ( AdditiveBSplineCoefficients< Array > const & coefs )

inline

Copy constructor.

Parameters

coefs the coefficients to copy

Definition at line 104 of file STK_AdditiveBSplineCoefficients.h.

                               : IRunnerBase(coefs)
                               , p_data_(coefs.p_data_)
                               , nbKnots_(coefs.nbKnots_)
                               , nbControlPoints_(coefs.nbControlPoints_)
                               , degree_(coefs.degree_)
                               , position_(coefs.position_)
                               , coefficients_(coefs.coefficients_)
    {}

◆ ~AdditiveBSplineCoefficients()

template<class Array >

virtual STK::AdditiveBSplineCoefficients< Array >::~AdditiveBSplineCoefficients ( )

inlinevirtual

Destructor.

Definition at line 114 of file STK_AdditiveBSplineCoefficients.h.

114{}

Member Function Documentation

◆ clone()

template<class Array >

AdditiveBSplineCoefficients * STK::AdditiveBSplineCoefficients< Array >::clone ( ) const

inline

clone pattern implementation

Definition at line 116 of file STK_AdditiveBSplineCoefficients.h.

116{ return new AdditiveBSplineCoefficients(*this);}

STK::AdditiveBSplineCoefficients::AdditiveBSplineCoefficients

AdditiveBSplineCoefficients(Array const *p_data, int nbControlPoints, int degree=3, Regress::KnotsPosition position=Regress::uniformKnotsPositions_)

Constructor : initialize the data members.

Definition STK_AdditiveBSplineCoefficients.h:68

◆ coefficients()

template<class Array >

ArrayXX const & STK::AdditiveBSplineCoefficients< Array >::coefficients ( ) const

inline

give the computed coefficients of the B-spline curves.

This is a matrix of size (p_data_->range(), 0:lastControlPoints).

Definition at line 141 of file STK_AdditiveBSplineCoefficients.h.

141{ return coefficients_;}

References STK::AdditiveBSplineCoefficients< Array >::coefficients_.

Referenced by STK::AdditiveBSplineRegression< YArray, XArray, Weights >::coefficients().

◆ degree()

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::degree ( ) const

inline

give the degree of the B-spline curves.

Definition at line 133 of file STK_AdditiveBSplineCoefficients.h.

133{ return degree_;}

References STK::AdditiveBSplineCoefficients< Array >::degree_.

◆ extrapolate()

template<class Array >

ArrayXX STK::AdditiveBSplineCoefficients< Array >::extrapolate ( Array const & x ) const

Returns: the extrapolated coefficients for the x matrix.

Parameters

x	the values to extrapolate

Definition at line 216 of file STK_AdditiveBSplineCoefficients.h.

{
#ifdef STK_REGRESS_VERBOSE
  stk_cout << _T("in AdditiveBSplineCoefficients::extrapolate()\n");
#endif
  if (x.cols() != coefs_.range())
  { STKRUNTIME_ERROR_NO_ARG(AdditiveBSplineBSplineCoefficients::extrapolate(x),x.cols() != coefs_.range());}
    // resize the matrix of coefficient
    ArrayXX coefficients(x.rows(), Range());
    for (int j= coefs_.begin(); j<coefs_.end(); j++)
    { coefficients.merge(coefs_[j].extrapolate(x.col(j)));}
#ifdef STK_REGRESS_VERBOSE
  stk_cout << _T("AdditiveBSplineCoefficients::run() done\n");
#endif
  return coefficients;
}

References _T, STK::MultidimRegression< Array, Weight >::coefs_, STK::MultidimRegression< Array, Weight >::extrapolate(), STK::IArray2D< Derived >::merge(), stk_cout, and STKRUNTIME_ERROR_NO_ARG.

◆ nbControlPoints()

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::nbControlPoints ( ) const

inline

give the number of control points of the B-spline curves.

Definition at line 137 of file STK_AdditiveBSplineCoefficients.h.

137{ return nbControlPoints_;}

References STK::AdditiveBSplineCoefficients< Array >::nbControlPoints_.

◆ nbKnots()

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::nbKnots ( ) const

inline

give the number of knots of the B-spline curves.

Definition at line 135 of file STK_AdditiveBSplineCoefficients.h.

135{ return nbKnots_;}

References STK::AdditiveBSplineCoefficients< Array >::nbKnots_.

◆ run()

template<class Array >

bool STK::AdditiveBSplineCoefficients< Array >::run ( )

virtual

run the computations.

Implements STK::IRunnerBase.

Definition at line 166 of file STK_AdditiveBSplineCoefficients.h.

{
#ifdef STK_REGRESS_VERBOSE
  stk_cout << _T("In AdditiveBSplineCoefficients::run()\n");
#endif
  // check if there exists data
  if (!p_data_)
  {
    msg_error_ = STKERROR_NO_ARG(AdditiveBSplineCoefficients::run,data is not set);
    return false;
  }
  try
  {
    // resize the Array with the marginal coefficients
    coefs_.clear(); // necesssary as coefficient_ is a reference at second call
    coefs_.resize(p_data_->cols());
 
    // resize the matrix of all coefficient
    coefficients_.resize(p_data_->rows(), Range());
    // get dimensions
    for (int i=p_data_->beginCols(); i<p_data_->endCols(); i++)
    {
      // create a reference on the ith column of the data
      ColVector colData(p_data_->col(i), true);
      // set data to the i-th coefficient
      // WARNING: colData will be invalidate
      coefs_[i].setData(colData, nbControlPoints_, degree_, position_);
      // run computation for the i-th coefficient
      if (!coefs_[i].run())
      {
        msg_error_ =coefs_[i].error();
        return false;
      }
      // get coefficients
      coefficients_.merge(coefs_[i].coefficients());
    }
  }
  catch ( Exception const& e)
  {
    msg_error_ = e.error();
    return false;
  }
#ifdef STK_REGRESS_VERBOSE
  stk_cout << _T("AdditiveBSplineCoefficients::run() done\n");
#endif
  return true;
}

References _T, STK::IArray2D< Derived >::clear(), STK::MultidimRegression< Array, Weight >::coefs_, STK::IRunnerBase::error(), STK::IArray2D< Derived >::merge(), STK::IRunnerBase::msg_error_, STK::IArray2D< Derived >::resize(), STK::AdditiveBSplineCoefficients< Array >::run(), STK::IRegression< Array, Array, Weight >::run(), stk_cout, and STKERROR_NO_ARG.

Referenced by STK::AdditiveBSplineCoefficients< Array >::run().

◆ setData()

template<class Array >

void STK::AdditiveBSplineCoefficients< Array >::setData	(	Array const *	p_data,
		int	nbControlPoints,
		int	degree = `3`,
		Regress::KnotsPosition	position = `Regress::uniformKnotsPositions_`
	)

Compute the coefficients of the B-spline curve for the given values.

Parameters

p_data	the input data values
nbControlPoints	number of control points
degree	degree of the B-spline curves
position	method to use for positioning the knots

Definition at line 241 of file STK_AdditiveBSplineCoefficients.h.

{
  p_data_ =p_data;
  nbKnots_ = nbControlPoints + degree +1;
  nbControlPoints_ = nbControlPoints;
  degree_ = degree;
  position_ = position;
}

Member Data Documentation

◆ coefficients_

template<class Array >

ArrayXX STK::AdditiveBSplineCoefficients< Array >::coefficients_

protected

Array of the coefficients.

Definition at line 161 of file STK_AdditiveBSplineCoefficients.h.

Referenced by STK::AdditiveBSplineCoefficients< Array >::coefficients().

◆ coefs_

template<class Array >

Array1D<BSplineCoefficients<ColVector> > STK::AdditiveBSplineCoefficients< Array >::coefs_

protected

Array with the knots and coefficients in each dimension.

Definition at line 159 of file STK_AdditiveBSplineCoefficients.h.

◆ degree_

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::degree_

protected

degree of the B-splines curves.

Definition at line 155 of file STK_AdditiveBSplineCoefficients.h.

Referenced by STK::AdditiveBSplineCoefficients< Array >::degree().

◆ nbControlPoints_

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::nbControlPoints_

protected

number of control points of the B-spline curves.

Definition at line 153 of file STK_AdditiveBSplineCoefficients.h.

Referenced by STK::AdditiveBSplineCoefficients< Array >::nbControlPoints().

◆ nbKnots_

template<class Array >

int STK::AdditiveBSplineCoefficients< Array >::nbKnots_

protected

number of knots of the B-spline curves.

Definition at line 151 of file STK_AdditiveBSplineCoefficients.h.

Referenced by STK::AdditiveBSplineCoefficients< Array >::nbKnots().

◆ p_data_

template<class Array >

Array const* STK::AdditiveBSplineCoefficients< Array >::p_data_

protected

the input data set

Definition at line 149 of file STK_AdditiveBSplineCoefficients.h.

◆ position_

template<class Array >

Regress::KnotsPosition STK::AdditiveBSplineCoefficients< Array >::position_

protected

Method used in order to position the knots.

Definition at line 157 of file STK_AdditiveBSplineCoefficients.h.

The documentation for this class was generated from the following file:

STK_AdditiveBSplineCoefficients.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ColVector

◆ RowVector

Constructor & Destructor Documentation

◆ AdditiveBSplineCoefficients() [1/3]

◆ AdditiveBSplineCoefficients() [2/3]

◆ AdditiveBSplineCoefficients() [3/3]

◆ ~AdditiveBSplineCoefficients()

Member Function Documentation

◆ clone()

◆ coefficients()

◆ degree()

◆ extrapolate()

◆ nbControlPoints()

◆ nbKnots()

◆ run()

◆ setData()

Member Data Documentation

◆ coefficients_

◆ coefs_

◆ degree_

◆ nbControlPoints_

◆ nbKnots_

◆ p_data_

◆ position_