Interface base class for all basis function. More...

#include <STK_IBasis.h>

Inheritance diagram for STK::IBasis< Data, Coefs >:

Public Types
typedef Data::Type	Type

Public Member Functions
	IBasis ()
	default constructor

	IBasis (Data const *p_data, int dim, bool useDataValues=true)
	constructor

	IBasis (Data const &data, int dim, bool useDataValues=true)
	constructor

	IBasis (IBasis const &basis)
	copy constructor.

virtual	~IBasis ()
	destructor

int	dim () const

Coefs const &	coefficients () const

Type	minValue () const

Type	maxValue () const

void	setData (Data const &data)
	Set the data set.

void	setDim (int dim)

void	setMinValue (Type const &minValue)

void	setMaxValue (Type const &maxValue)

bool	initializeStep ()
	Initialize the parameters minValue_ and maxValue_ using data set.

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

virtual bool	run ()=0
	run the computations.

Protected Member Functions
virtual void	update ()
	update IBasis if a parameter or a new data set is set, update the state of this runner.

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

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

Protected Attributes
Data const *	p_data_
	the input data set

int	dim_
	number of dimension to build

bool	useDataValues_

Type	minValue_
	Minimal value of the data.

Type	maxValue_
	Maximal value of the data.

Coefs	coefficients_
	Array2D 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

Detailed Description

template<class Data, class Coefs = ArrayXX>
class STK::IBasis< Data, Coefs >

Interface base class for all basis function.

Definition at line 48 of file STK_IBasis.h.

Member Typedef Documentation

◆ Type

template<class Data , class Coefs = ArrayXX>

typedef Data::Type STK::IBasis< Data, Coefs >::Type

Definition at line 51 of file STK_IBasis.h.

Constructor & Destructor Documentation

◆ IBasis() [1/4]

template<class Data , class Coefs >

STK::IBasis< Data, Coefs >::IBasis ( )

default constructor

Definition at line 125 of file STK_IBasis.h.

                           : IRunnerBase()
                            , p_data_(0)
                            , dim_()
                            , useDataValues_(true)
                            , minValue_( Arithmetic<Type>::max())
                            , maxValue_(-Arithmetic<Type>::max())
                            , coefficients_()
{}

◆ IBasis() [2/4]

template<class Data , class Coefs >

STK::IBasis< Data, Coefs >::IBasis	(	Data const *	p_data,
		int	dim,
		bool	useDataValues = `true`
	)

constructor

Parameters

p_data	pointer on the data set (can be null)
dim	dimension of the basis
useDataValues	if `true` use data in order to find the minValue_ and maxValue_, use values set otherwise.

Definition at line 135 of file STK_IBasis.h.

                           : IRunnerBase()
                           , p_data_(p_data)
                           , dim_(dim)
                           , useDataValues_(useDataValues)
                           , minValue_( Arithmetic<Type>::max())
                           , maxValue_(-Arithmetic<Type>::max())
                           , coefficients_()
{}

◆ IBasis() [3/4]

template<class Data , class Coefs >

STK::IBasis< Data, Coefs >::IBasis	(	Data const &	data,
		int	dim,
		bool	useDataValues = `true`
	)

constructor

Parameters

data	reference on the data set
dim	dimension of the basis
useDataValues	if `true` use data in order to find the minValue_ and maxValue_, use values set otherwise.

Definition at line 145 of file STK_IBasis.h.

                           : IRunnerBase()
                           , p_data_(&data)
                           , dim_(dim)
                           , useDataValues_(useDataValues)
                           , minValue_( Arithmetic<Type>::max())
                           , maxValue_(-Arithmetic<Type>::max())
                           , coefficients_()
{}

◆ IBasis() [4/4]

template<class Data , class Coefs >

STK::IBasis< Data, Coefs >::IBasis ( IBasis< Data, Coefs > const & basis )

copy constructor.

Parameters

basis the basis to copy

Definition at line 156 of file STK_IBasis.h.

                           : IRunnerBase(basis)
                           , p_data_(basis.p_data_)
                           , dim_(basis.dim_)
                           , useDataValues_(basis.useDataValues_)
                           , minValue_(basis.minValue_)
                           , maxValue_(basis.maxValue_)
                           , coefficients_(basis.coefficients_)
{}

◆ ~IBasis()

template<class Data , class Coefs = ArrayXX>

virtual STK::IBasis< Data, Coefs >::~IBasis ( )

inlinevirtual

destructor

Definition at line 73 of file STK_IBasis.h.

73{}

Member Function Documentation

◆ coefficients()

template<class Data , class Coefs = ArrayXX>

Coefs const & STK::IBasis< Data, Coefs >::coefficients ( ) const

inline

Returns: the matrix with the coefficients of the basis curve.

Definition at line 79 of file STK_IBasis.h.

79{ return coefficients_;}

References STK::IBasis< Data, Coefs >::coefficients_.

Referenced by STK::BSplineRegression< YArray, XVector, Weights >::coefficients().

◆ dim()

template<class Data , class Coefs = ArrayXX>

int STK::IBasis< Data, Coefs >::dim ( ) const

inline

Returns: the dimension of the basis

Definition at line 77 of file STK_IBasis.h.

77{ return dim_;}

References STK::IBasis< Data, Coefs >::dim_.

Referenced by STK::IBasis< Data, Coefs >::setDim().

◆ initializeStep()

template<class Data , class Coefs >

bool STK::IBasis< Data, Coefs >::initializeStep ( )

Initialize the parameters minValue_ and maxValue_ using data set.

Definition at line 181 of file STK_IBasis.h.

{
  // resize and initialize coeficients
  coefficients_.resize(p_data_->range(), Range(0, dim_)) =0;
  // compute min and max value
  if (useDataValues_)
  {
    minValue_ =  Arithmetic<Type>::max();
    maxValue_ = -Arithmetic<Type>::max();
    for (int i=p_data_->begin(); i< p_data_->end(); i++)
    {
      minValue_ = std::min(minValue_, (*p_data_)[i]);
      maxValue_ = std::max(maxValue_, (*p_data_)[i]);
    }
  }
  // if all value are equals
  if (minValue_ == maxValue_)
  {
    msg_error_ = STKERROR_NO_ARG(IBasis::initializeStep,All values are equal);
    return false;
  }
  // if values are incorrect
  if (minValue_ > maxValue_)
  {
    msg_error_ = STKERROR_NO_ARG(IBasis::initializeStep,minValue_ greater than maxValue_);
    return false;
  }
  return true;
}

References STK::IBasis< Data, Coefs >::initializeStep(), STK::IRunnerBase::msg_error_, and STKERROR_NO_ARG.

Referenced by STK::IBasis< Data, Coefs >::initializeStep().

◆ maxValue()

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::maxValue ( ) const

inline

Returns: the maximal value of the data

Definition at line 83 of file STK_IBasis.h.

83{ return maxValue_;}

References STK::IBasis< Data, Coefs >::maxValue_.

Referenced by STK::IBasis< Data, Coefs >::setMaxValue().

◆ minValue()

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::minValue ( ) const

inline

Returns: the minimal value of the data

Definition at line 81 of file STK_IBasis.h.

81{ return minValue_;}

References STK::IBasis< Data, Coefs >::minValue_.

Referenced by STK::IBasis< Data, Coefs >::setMinValue().

◆ setData()

template<class Data , class Coefs = ArrayXX>

void STK::IBasis< Data, Coefs >::setData ( Data const & data )

inline

Set the data set.

Parameters

data	the input data values

Definition at line 89 of file STK_IBasis.h.

    {
      p_data_ = &data;
      update();
    }

References STK::IBasis< Data, Coefs >::p_data_, and STK::IBasis< Data, Coefs >::update().

◆ setDim()

template<class Data , class Coefs = ArrayXX>

void STK::IBasis< Data, Coefs >::setDim ( int dim )

inline

Parameters

dim	number of dimension

Definition at line 95 of file STK_IBasis.h.

95{ dim_ = dim; update();}

References STK::IBasis< Data, Coefs >::dim(), STK::IBasis< Data, Coefs >::dim_, and STK::IBasis< Data, Coefs >::update().

◆ setMaxValue()

template<class Data , class Coefs = ArrayXX>

void STK::IBasis< Data, Coefs >::setMaxValue ( Type const & maxValue )

inline

Parameters

maxValue maximal value of the data

Definition at line 99 of file STK_IBasis.h.

99{ maxValue_ = maxValue;}

STK::IBasis::maxValue

Type maxValue() const

Definition STK_IBasis.h:83

References STK::IBasis< Data, Coefs >::maxValue(), and STK::IBasis< Data, Coefs >::maxValue_.

◆ setMinValue()

template<class Data , class Coefs = ArrayXX>

void STK::IBasis< Data, Coefs >::setMinValue ( Type const & minValue )

inline

Parameters

minValue minimal value of the data

Definition at line 97 of file STK_IBasis.h.

97{ minValue_ = minValue;}

STK::IBasis::minValue

Type minValue() const

Definition STK_IBasis.h:81

References STK::IBasis< Data, Coefs >::minValue(), and STK::IBasis< Data, Coefs >::minValue_.

◆ update()

template<class Data , class Coefs >

void STK::IBasis< Data, Coefs >::update ( )

protectedvirtual

update IBasis if a parameter or a new data set is set, update the state of this runner.

Reimplemented from STK::IRunnerBase.

Definition at line 170 of file STK_IBasis.h.

{
  if (useDataValues_)
  {
    minValue_ =  Arithmetic<Type>::max();
    maxValue_ = -Arithmetic<Type>::max();
  }
  hasRun_ = false;
}

References STK::IRunnerBase::hasRun_.

Referenced by STK::IBasis< Data, Coefs >::setData(), and STK::IBasis< Data, Coefs >::setDim().

Member Data Documentation

◆ coefficients_

template<class Data , class Coefs = ArrayXX>

Coefs STK::IBasis< Data, Coefs >::coefficients_

protected

Array2D of the coefficients.

Definition at line 121 of file STK_IBasis.h.

Referenced by STK::IBasis< Data, Coefs >::coefficients().

◆ dim_

template<class Data , class Coefs = ArrayXX>

int STK::IBasis< Data, Coefs >::dim_

protected

number of dimension to build

Definition at line 112 of file STK_IBasis.h.

Referenced by STK::IBasis< Data, Coefs >::dim(), and STK::IBasis< Data, Coefs >::setDim().

◆ maxValue_

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::maxValue_

protected

Maximal value of the data.

Definition at line 118 of file STK_IBasis.h.

Referenced by STK::IBasis< Data, Coefs >::maxValue(), and STK::IBasis< Data, Coefs >::setMaxValue().

◆ minValue_

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::minValue_

protected

Minimal value of the data.

Definition at line 116 of file STK_IBasis.h.

Referenced by STK::IBasis< Data, Coefs >::minValue(), and STK::IBasis< Data, Coefs >::setMinValue().

◆ p_data_

template<class Data , class Coefs = ArrayXX>

Data const* STK::IBasis< Data, Coefs >::p_data_

protected

the input data set

Definition at line 110 of file STK_IBasis.h.

Referenced by STK::IBasis< Data, Coefs >::setData().

◆ useDataValues_

template<class Data , class Coefs = ArrayXX>

bool STK::IBasis< Data, Coefs >::useDataValues_

protected

Definition at line 114 of file STK_IBasis.h.

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

STK_IBasis.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Type

Constructor & Destructor Documentation

◆ IBasis() [1/4]

◆ IBasis() [2/4]

◆ IBasis() [3/4]

◆ IBasis() [4/4]

◆ ~IBasis()

Member Function Documentation

◆ coefficients()

◆ dim()

◆ initializeStep()

◆ maxValue()

◆ minValue()

◆ setData()

◆ setDim()

◆ setMaxValue()

◆ setMinValue()

◆ update()

Member Data Documentation

◆ coefficients_

◆ dim_

◆ maxValue_

◆ minValue_

◆ p_data_

◆ useDataValues_