LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::binomialDistribution::parameters Class Reference

the parameters for the class binomialDistribution More...

#include <ltiBinomialDistribution.h>

Inheritance diagram for lti::binomialDistribution::parameters:
Inheritance graph
[legend]
Collaboration diagram for lti::binomialDistribution::parameters:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
 ~parameters ()
const char * getTypeName () const
parameterscopy (const parameters &other)
parametersoperator= (const parameters &other)
virtual functor::parametersclone () 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

Detailed Description

the parameters for the class binomialDistribution


Constructor & Destructor Documentation

lti::binomialDistribution::parameters::parameters (  ) 

default constructor

Reimplemented from lti::functor::parameters.

lti::binomialDistribution::parameters::parameters ( const parameters other  ) 

copy constructor

Parameters:
other the parameters object to be copied
lti::binomialDistribution::parameters::~parameters (  )  [virtual]

destructor

Reimplemented from lti::functor::parameters.


Member Function Documentation

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

Parameters:
other the parameters object to be copied
Returns:
a reference to this parameters object

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

Parameters:
other the parameters object to be copied
Returns:
a reference to this parameters object
virtual bool lti::binomialDistribution::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::functor::parameters.

virtual bool lti::binomialDistribution::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::functor::parameters.


Member Data Documentation

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.

See also:
upperBound()

The size of the sample for the binomial distribution.

Default 1. This parameter needs to be set for all applications of the functor.


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

Generated on Sat Apr 10 15:28:10 2010 for LTI-Lib by Doxygen 1.6.1