icl::math::PolynomialRegression< T >::Result Class Reference

result type More...

#include <PolynomialRegression.h>

Public Member Functions
	Result ()
	empty default constructor More...
	Result (const std::string &xmlfilename)
	constructor with given xml file saved with the save method More...
	Result (const Result &r)
	custom copy constructor More...
Result &	operator= (const Result &r)
	custom assignment operator More...
const Matrix &	getParams () const
	set of parameters (on row for each output dimension) More...
const Matrix &	operator() (const Matrix &xs) const
	applys the parameters to given set of inputs More...
std::vector< const Attrib * >	getAttribs () const
	returns the dummy attrib instances More...
std::string	toString (const std::vector< std::string > &rowLabels=std::vector< std::string >()) const
	creates a human readable string representation of the result More...
void	save (const std::string &xmlFileName) const
	saves the result to an xml-file More...

Private Member Functions
void	setup (const std::string &function)
	sets up the result by the given function More...

Private Attributes
std::vector< const Attrib * >	m_attribs
	list of attribute functions More...
std::string	m_function
	function definition given More...
Matrix	m_params
	set of estimated parameters More...
Matrix	m_xbuf
	internal buffers More...
Matrix	m_resultBuf
int	m_attribMaxIndex
	maximum x-row index used in the attribute list More...

Friends
class	PolynomialRegression
	parent class More...

Detailed Description

template<class T>
class icl::math::PolynomialRegression< T >::Result

result type

Constructor & Destructor Documentation

Result() [1/3]

template<class T >

icl::math::PolynomialRegression< T >::Result::Result ( )

inline

empty default constructor

Result() [2/3]

template<class T >

icl::math::PolynomialRegression< T >::Result::Result

(

const std::string &

xmlfilename

)

constructor with given xml file saved with the save method

Result() [3/3]

template<class T >

icl::math::PolynomialRegression< T >::Result::Result

(

const Result &

r

)

custom copy constructor

Member Function Documentation

getAttribs()

template<class T >

std::vector<const Attrib*> icl::math::PolynomialRegression< T >::Result::getAttribs ( ) const

inline

returns the dummy attrib instances

getParams()

template<class T >

const Matrix& icl::math::PolynomialRegression< T >::Result::getParams ( ) const

inline

set of parameters (on row for each output dimension)

operator()()

template<class T >

const Matrix& icl::math::PolynomialRegression< T >::Result::operator()

(

const Matrix &

xs

)

const

applys the parameters to given set of inputs

inputs are assumed to be the rows of xs! The operator computes p(xs) * a, Where p(xs) is the matrix that contains the attribut values for each input row of xs in its rows.

The output matrix contains the outputs as rows

The input matrix needs to have at least m_attribMaxIndex+1 columns

operator=()

template<class T >

Result& icl::math::PolynomialRegression< T >::Result::operator=

(

const Result &

r

)

custom assignment operator

save()

template<class T >

void icl::math::PolynomialRegression< T >::Result::save

(

const std::string &

xmlFileName

)

const

saves the result to an xml-file

setup()

template<class T >

void icl::math::PolynomialRegression< T >::Result::setup ( const std::string &  function )

private

sets up the result by the given function

toString()

template<class T >

std::string icl::math::PolynomialRegression< T >::Result::toString

(

const std::vector< std::string > &

rowLabels = std::vector< std::string >()

)

const

creates a human readable string representation of the result

Friends And Related Function Documentation

PolynomialRegression

template<class T >

friend class PolynomialRegression

friend

parent class

Member Data Documentation

m_attribMaxIndex

template<class T >

int icl::math::PolynomialRegression< T >::Result::m_attribMaxIndex

mutableprivate

maximum x-row index used in the attribute list

m_attribs

template<class T >

std::vector<const Attrib*> icl::math::PolynomialRegression< T >::Result::m_attribs

private

list of attribute functions

m_function

template<class T >

std::string icl::math::PolynomialRegression< T >::Result::m_function

private

function definition given

m_params

template<class T >

Matrix icl::math::PolynomialRegression< T >::Result::m_params

mutableprivate

set of estimated parameters

m_resultBuf

template<class T >

Matrix icl::math::PolynomialRegression< T >::Result::m_resultBuf

mutableprivate

m_xbuf

template<class T >

Matrix icl::math::PolynomialRegression< T >::Result::m_xbuf

mutableprivate

internal buffers

---

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

• /Users/alneuman/vm/icl/ICLMath/src/ICLMath/PolynomialRegression.h