STK::JointBernoulliParameters Class Reference

Structure encapsulating the parameters of a Joint Bernoulli model. More...

#include <STK_JointBernoulliModel.h>

Inheritance diagram for STK::JointBernoulliParameters:

Public Member Functions
	JointBernoulliParameters ()
	default constructor
	JointBernoulliParameters (Range const &size)
	constructor with fixed size
	JointBernoulliParameters (JointBernoulliParameters const &param)
	copy constructor.
	~JointBernoulliParameters ()
	destructor
Real const	prob (int const &j) const
Real const	lnProb (int const &j) const
Real const	ln1mProb (int const &j) const
void	setProb (int const &j, Real const &prob)
	set the probability of success of the jth law
void	resizeImpl (Range const &range)
	resize the set of parameter
Public Member Functions inherited from STK::IMultiParameters< JointBernoulliParameters >
Range const &	range () const
void	resize (Range const &range)
	resize the parameters only if the range is modified, otherwise, stay with the current values.
Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Protected Attributes
Array2DPoint< Real >	prob_
Array2DPoint< Real >	lnProb_
Array2DPoint< Real >	ln1mProb_

Additional Inherited Members
Protected Member Functions inherited from STK::IMultiParameters< JointBernoulliParameters >
	IMultiParameters ()
	default constructor.
	IMultiParameters (Range const &range)
	constructor with specified range
	IMultiParameters (IMultiParameters const &param)
	copy constructor.
	~IMultiParameters ()
	Destructor.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

Structure encapsulating the parameters of a Joint Bernoulli model.

Definition at line 51 of file STK_JointBernoulliModel.h.

Constructor & Destructor Documentation

JointBernoulliParameters() [1/3]

STK::JointBernoulliParameters::JointBernoulliParameters ( )

inline

default constructor

Definition at line 55 of file STK_JointBernoulliModel.h.

{}

JointBernoulliParameters() [2/3]

STK::JointBernoulliParameters::JointBernoulliParameters ( Range const &  size )

inline

constructor with fixed size

Definition at line 57 of file STK_JointBernoulliModel.h.

                            : prob_(size, 0.5)
                            , lnProb_(size, -Const::_LN2_)
                            , ln1mProb_(size, -Const::_LN2_)
    {}

JointBernoulliParameters() [3/3]

STK::JointBernoulliParameters::JointBernoulliParameters ( JointBernoulliParameters const &  param )

inline

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 63 of file STK_JointBernoulliModel.h.

                            : prob_(param.prob_)
                            , lnProb_(param.lnProb_)
                            , ln1mProb_(param.ln1mProb_)
    {}

~JointBernoulliParameters()

STK::JointBernoulliParameters::~JointBernoulliParameters ( )

inline

destructor

Definition at line 69 of file STK_JointBernoulliModel.h.

{}

Member Function Documentation

ln1mProb()

Real const STK::JointBernoulliParameters::ln1mProb ( int const &  j ) const

inline

Returns

the probability of success of the jth law

Definition at line 75 of file STK_JointBernoulliModel.h.

{ return ln1mProb_[j];}

References ln1mProb_.

lnProb()

Real const STK::JointBernoulliParameters::lnProb ( int const &  j ) const

inline

Returns

the probability of success of the jth law

Definition at line 73 of file STK_JointBernoulliModel.h.

{ return lnProb_[j];}

References lnProb_.

prob()

Real const STK::JointBernoulliParameters::prob ( int const &  j ) const

inline

Returns

the probability of success of the jth law

Definition at line 71 of file STK_JointBernoulliModel.h.

{ return prob_[j];}

References prob_.

Referenced by setProb().

resizeImpl()

void STK::JointBernoulliParameters::resizeImpl ( Range const &  range )

inline

resize the set of parameter

Definition at line 85 of file STK_JointBernoulliModel.h.

    { prob_.resize(range); lnProb_.resize(range); ln1mProb_.resize(range);}

References ln1mProb_, lnProb_, prob_, STK::IMultiParameters< JointBernoulliParameters >::range(), and STK::IArray2D< Derived >::resize().

setProb()

void STK::JointBernoulliParameters::setProb ( int const &  j, Real const &  prob  )

inline

set the probability of success of the jth law

Definition at line 77 of file STK_JointBernoulliModel.h.

    { prob_[j] = prob;
      if (prob>0) { lnProb_[j] = std::log(prob);}
      else        { lnProb_[j] = -Arithmetic<Real>::infinity();}
      if (prob<1) { ln1mProb_[j] = std::log(1.-prob);}
      else        { ln1mProb_[j] = -Arithmetic<Real>::infinity();}
    }

References ln1mProb_, lnProb_, prob(), and prob_.

Member Data Documentation

ln1mProb_

Array2DPoint<Real> STK::JointBernoulliParameters::ln1mProb_

protected

Definition at line 91 of file STK_JointBernoulliModel.h.

Referenced by ln1mProb(), resizeImpl(), and setProb().

lnProb_

Array2DPoint<Real> STK::JointBernoulliParameters::lnProb_

protected

Definition at line 90 of file STK_JointBernoulliModel.h.

Referenced by lnProb(), resizeImpl(), and setProb().

prob_

Array2DPoint<Real> STK::JointBernoulliParameters::prob_

protected

Definition at line 89 of file STK_JointBernoulliModel.h.

Referenced by prob(), resizeImpl(), and setProb().

---

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

• STK_JointBernoulliModel.h