lti::studentDistribution::parameters Class Reference

The parameters for the class studentDistribution. More...

#include <ltiStudentDistribution.h>

Inheritance diagram for lti::studentDistribution::parameters:

[legend]

Collaboration diagram for lti::studentDistribution::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	useLUT
int	maxDOF
bool	oneSided
float	alpha

---

Detailed Description

The parameters for the class studentDistribution.

---

Constructor & Destructor Documentation

lti::studentDistribution::parameters::parameters

(

)

Default constructor.

Reimplemented from lti::mathFunction::parameters.

lti::studentDistribution::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::mathFunction::parameters.

lti::studentDistribution::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from lti::mathFunction::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::studentDistribution::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::mathFunction::parameters.

parameters& lti::studentDistribution::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::mathFunction::parameters.

const char* lti::studentDistribution::parameters::getTypeName

(

)

const [virtual]

Returns name of this type.

Reimplemented from lti::mathFunction::parameters.

parameters& lti::studentDistribution::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::mathFunction::parameters.

virtual bool lti::studentDistribution::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::mathFunction::parameters.

virtual bool lti::studentDistribution::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::mathFunction::parameters.

---

Member Data Documentation

float lti::studentDistribution::parameters::alpha

The significance level.

Default: 0.05

int lti::studentDistribution::parameters::maxDOF

The maximum degrees of freedom considered in the LUT.

For some common alpha, the an additional entry storing the limit is added. Please note that computing the LUT is expensive.

Default: 30.

bool lti::studentDistribution::parameters::oneSided

If this is true, the significance level is interpreted to belong to a one-sided test.

Otherwise a two-sided test is performed.

Default: false

bool lti::studentDistribution::parameters::useLUT

If this is true a LUT is computed on the first call of accept and used from there on.

Please note that the LUT is only used by accept. The apply method computes the confidence on every call.

Default: false

---

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

• ltiStudentDistribution.h