In this Page, we manage the options for the computation of the Additive BSpline regression. More...

#include <STK_AdditiveBSplineRegressionPage.h>

Inheritance diagram for STK::AdditiveBSplineRegressionPage:

Public Member Functions
	AdditiveBSplineRegressionPage (int const &level)
	constructor.

	AdditiveBSplineRegressionPage (AdditiveBSplineRegressionPage const &page)
	copy constructor.

virtual	~AdditiveBSplineRegressionPage ()
	destructor.

int	nbControlPoints () const
	number of control points

int	degree () const
	degree of the BSpline

Regress::KnotsPosition const &	knotsPositions () const
	get the method for positioning the knots.

virtual bool	validate ()
	validate the options.

virtual AdditiveBSplineRegressionPage *	clone () const
	Create a copy of the AdditiveBSplineRegressionPage.

Public Member Functions inherited from STK::IPage
	IPage (String const &name, int const &level, bool isOptional)
	Constructor.

	IPage (IPage const &page)
	Copy constructor.

virtual	~IPage ()
	Destructor.

String const &	name () const
	name of the IPage.

bool	isOptional () const
	is this Option optional ?.

ContOption const &	options () const
	get the options of the IPage

String const &	msg_error () const
	name of the IPage.

Option &	option (String const &name)
	bookkeeping function.

Option const &	option (String const &name) const
	bookkeeping function.

Option const &	option (int const &pos) const
	get the ith constant option of the IPage

Option &	option (int const &pos)
	get the ith option of the IPage

Option const &	operator[] (int const &pos) const
	get the ith constant option of the IPage

Option &	operator[] (int const &pos)
	get the ith option of the IPage

void	addOption (Option const &opt)
	add an option to the page

void	addPage (IPage const &page)
	add a sub-page as an option to the page

void	read (istream &is)
	read in options from an input steam stream

void	write (ostream &os) const
	write out options in a stream

Protected Attributes
int	nbControlPoints_
	Number of control points.

int	degree_
	degree of the splines

Regress::KnotsPosition	position_
	positions of the knots.

Protected Attributes inherited from STK::IPage
bool	isOptional_
	`true` if the Page is optinal, `false` otherwise

ContOption	options_
	array of the options

String	msg_error_
	Contain the last error message.

Additional Inherited Members
Public Types inherited from STK::IPage
typedef std::vector< Option >	ContOption
	Container for the options.

Detailed Description

In this Page, we manage the options for the computation of the Additive BSpline regression.

The AdditiveBSplineRegression page have the form

 # AdditiveBSplineRegression options
[AdditiveBSplineRegression]
  # number of control point
  nbControlPoints = 7
  # degree of the BSpline
  degree = 3
  # disposition of the knots uniform/periodic
  knotsPositions = uniform

Definition at line 59 of file STK_AdditiveBSplineRegressionPage.h.

Constructor & Destructor Documentation

◆ AdditiveBSplineRegressionPage() [1/2]

STK::AdditiveBSplineRegressionPage::AdditiveBSplineRegressionPage ( int const & level )

constructor.

Parameters

level the level of the option page

Definition at line 51 of file STK_AdditiveBSplineRegressionPage.cpp.

                            : IPage(_T("AdditiveBSplineRegression"), level, true)
                            , nbControlPoints_(3)
                            , degree_(3)
                            , position_(Regress::periodicKnotsPositions_)
 
 
{
  // reserve for the 4 options
  options_.reserve(3);
  // first option : standardize or no the data set
  options_.push_back(Option(_T("nbControlPoints"), Option::integer_, true));
  options_.back().setValue(_T("7"));
  // degree f the spline
  options_.push_back(Option(_T("degree"), Option::integer_, true));
  options_.back().setValue(_T("2"));
  // first option : type of model
  options_.push_back(Option(_T("knotsPositions"), Option::string_, true));
  options_.back().setValue(_T("uniform"));
}

References _T, STK::Option::integer_, STK::IPage::options_, and STK::Option::string_.

◆ AdditiveBSplineRegressionPage() [2/2]

STK::AdditiveBSplineRegressionPage::AdditiveBSplineRegressionPage ( AdditiveBSplineRegressionPage const & page )

copy constructor.

Parameters

page	the page to copy

Definition at line 73 of file STK_AdditiveBSplineRegressionPage.cpp.

                                    : IPage(page)
                                    , nbControlPoints_(page.nbControlPoints_)
                                    , degree_(page.degree_)
                                    , position_(page.position_)
{}

◆ ~AdditiveBSplineRegressionPage()

STK::AdditiveBSplineRegressionPage::~AdditiveBSplineRegressionPage ( )

virtual

destructor.

Definition at line 81 of file STK_AdditiveBSplineRegressionPage.cpp.

82{ }

Member Function Documentation

◆ clone()

virtual AdditiveBSplineRegressionPage * STK::AdditiveBSplineRegressionPage::clone ( ) const

inlinevirtual

Create a copy of the AdditiveBSplineRegressionPage.

Returns: a pointer on the clone of this

Reimplemented from STK::IPage.

Definition at line 93 of file STK_AdditiveBSplineRegressionPage.h.

94 { return new AdditiveBSplineRegressionPage(*this);}

STK::AdditiveBSplineRegressionPage::AdditiveBSplineRegressionPage

AdditiveBSplineRegressionPage(int const &level)

constructor.

Definition STK_AdditiveBSplineRegressionPage.cpp:51

◆ degree()

int STK::AdditiveBSplineRegressionPage::degree ( ) const

inline

degree of the BSpline

Returns: the degree of the spline

Definition at line 80 of file STK_AdditiveBSplineRegressionPage.h.

80{ return degree_;}

References degree_.

◆ knotsPositions()

Regress::KnotsPosition const & STK::AdditiveBSplineRegressionPage::knotsPositions ( ) const

inline

get the method for positioning the knots.

Returns: the method for positioning the knots

Definition at line 84 of file STK_AdditiveBSplineRegressionPage.h.

85 { return position_;}

References position_.

◆ nbControlPoints()

int STK::AdditiveBSplineRegressionPage::nbControlPoints ( ) const

inline

number of control points

Returns: the number of control point

Definition at line 76 of file STK_AdditiveBSplineRegressionPage.h.

76{ return nbControlPoints_;}

References nbControlPoints_.

◆ validate()

bool STK::AdditiveBSplineRegressionPage::validate ( )

virtual

validate the options.

Check if the values are coherent.

Reimplemented from STK::IPage.

Definition at line 85 of file STK_AdditiveBSplineRegressionPage.cpp.

{
  // first option
  nbControlPoints_ = options_[0].get(int());
  if ( (nbControlPoints_ <= 0))
  {
    msg_error_ = BSPLINEERRORCODES[1];
    msg_error_ += "nbControlPoints must be strictly positive\n";
    return false;
  }
  // second option
  degree_ = options_[1].get(int());
  if ( (degree_ <= 0))
  {
    msg_error_ = BSPLINEERRORCODES[1];
    msg_error_ += "degree must be strictly positive\n";
    return false;
  }
  if ( (nbControlPoints_ <= degree_))
  {
    msg_error_ = BSPLINEERRORCODES[1];
    msg_error_ += "nbControlPoints must be strictly greater than degree.\n";
    return false;
  }
 
  // third option
  position_ = Regress::stringToKnotsPosition(options_[2].get(String()));
  if (position_ == Regress::unknown_Knots_Position_ )
  {
    msg_error_ = BSPLINEERRORCODES[1];
    msg_error_ += "knots position is unknown.\n";
    return false;
  }
  // validation done
  return true;
}