latest version v1.9 - last update 10 Apr 2010 |
the parameters for the class binomialDistribution More...
#include <ltiBinomialDistribution.h>
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 | |
int | sampleSize |
int | events |
double | confidence |
double | accuracy |
double | baseProbability |
the parameters for the class binomialDistribution
lti::binomialDistribution::parameters::parameters | ( | ) |
default constructor
Reimplemented from lti::functor::parameters.
lti::binomialDistribution::parameters::parameters | ( | const parameters & | other | ) |
copy constructor
other | the parameters object to be copied |
lti::binomialDistribution::parameters::~parameters | ( | ) | [virtual] |
destructor
Reimplemented from lti::functor::parameters.
virtual functor::parameters* lti::binomialDistribution::parameters::clone | ( | ) | const [virtual] |
returns a pointer to a clone of the parameters
Implements lti::functor::parameters.
parameters& lti::binomialDistribution::parameters::copy | ( | const parameters & | other | ) |
copy the contents of a parameters object
other | the parameters object to be copied |
Reimplemented from lti::discreteRandomDistribution::parameters.
const char* lti::binomialDistribution::parameters::getTypeName | ( | ) | const [virtual] |
returns name of this type
Reimplemented from lti::functor::parameters.
parameters& lti::binomialDistribution::parameters::operator= | ( | const parameters & | other | ) |
copy the contents of a parameters object
other | the parameters object to be copied |
virtual bool lti::binomialDistribution::parameters::read | ( | ioHandler & | handler, | |
const bool | complete = true | |||
) | [virtual] |
read the parameters from the given ioHandler
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. |
Reimplemented from lti::functor::parameters.
virtual bool lti::binomialDistribution::parameters::write | ( | ioHandler & | handler, | |
const bool | complete = true | |||
) | const [virtual] |
write the parameters in the given ioHandler
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. |
Reimplemented from lti::functor::parameters.
The accuracy in the iterative calculation of the upperBound().
The default is 0.0001.
The base probability of a event.
Default 0.5.
Here called confidence probability.
Default 0.95. It is needed for the calculation of the quantile() and the upperBound().
The number of positive events.
Default 0. It only needs to be set for evaluating the upper bound for the base probability if the method not having this argument is used.
The size of the sample for the binomial distribution.
Default 1. This parameter needs to be set for all applications of the functor.