STK::MultiLaw::JointCauchy< RowVector > Class Template Reference

Implement the Joint Cauchy probability law. More...

#include <STK_MultiLaw_JointCauchy.h>

Inheritance diagram for STK::MultiLaw::JointCauchy< RowVector >:

Public Types
typedef JointProbability< RowVector, Law::Cauchy >	Base
Public Types inherited from STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >
typedef RowVector::Type	Type
typedef IMultiLaw< RowVector >	Base

Public Member Functions
	JointCauchy ()
	default constructor
	JointCauchy (int const &nbVar)
	constructor
virtual	~JointCauchy ()
	destructor
Real const &	location (int const &j) const
Real const &	scale (int const &j) const
void	setLocation (int const &j, Real const &location)
	set the location of the jth law
void	setScale (int const &j, Real const &scale)
	set the scale of the jth law
Public Member Functions inherited from STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >
	JointProbability (String const &name)
	Constructor.
	JointProbability (String const &name, int nbVar)
	Constructor.
virtual	~JointProbability ()
	destructor
Array1D< Law > const &	JointLaw () const
Law const &	law (int const &j) const
Law &	law (int const &j)
Law const &	atLaw (int const &j) const
Law &	atLaw (int const &j)
void	resize (int const &nbVar)
	resize the joint probability
virtual Real	pdf (RowVector const &x) const
	compute the probability distribution function (density) of the multivariate law.
virtual Real	lpdf (RowVector const &x) const
	compute the log probability distribution function Give the value of the log-pdf at the point x.
virtual void	rand (RowVector &x) const
	simulate a realization of the joint law and store the result in x.
Public Member Functions inherited from STK::MultiLaw::IMultiLaw< RowVector >
virtual	~IMultiLaw ()
	destructor.
Public Member Functions inherited from STK::Law::ILawBase
String const &	name () const

Additional Inherited Members
Protected Member Functions inherited from STK::MultiLaw::IMultiLaw< RowVector >
	IMultiLaw (String const &name)
	Constructor.
Protected Member Functions inherited from STK::Law::ILawBase
	ILawBase (String const &name)
	Constructor.
	~ILawBase ()
	destructor.
Protected Attributes inherited from STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >
Array1D< Law >	jointLaw_
	Array with the marginal laws.
Protected Attributes inherited from STK::Law::ILawBase
String	name_
	Name of the Law.

Detailed Description

template<class RowVector>
class STK::MultiLaw::JointCauchy< RowVector >

Implement the Joint Cauchy probability law.

Definition at line 50 of file STK_MultiLaw_JointCauchy.h.

Member Typedef Documentation

Base

template<class RowVector >

typedef JointProbability<RowVector, Law::Cauchy> STK::MultiLaw::JointCauchy< RowVector >::Base

Definition at line 53 of file STK_MultiLaw_JointCauchy.h.

Constructor & Destructor Documentation

JointCauchy() [1/2]

template<class RowVector >

STK::MultiLaw::JointCauchy< RowVector >::JointCauchy ( )

inline

default constructor

Definition at line 55 of file STK_MultiLaw_JointCauchy.h.

: Base(_T("JointCauchy")) {}

JointCauchy() [2/2]

template<class RowVector >

STK::MultiLaw::JointCauchy< RowVector >::JointCauchy ( int const &  nbVar )

inline

constructor

Definition at line 57 of file STK_MultiLaw_JointCauchy.h.

              : Base(_T("JointCauchy"), nbVar) {}

~JointCauchy()

template<class RowVector >

virtual STK::MultiLaw::JointCauchy< RowVector >::~JointCauchy ( )

inlinevirtual

destructor

Definition at line 60 of file STK_MultiLaw_JointCauchy.h.

{}

Member Function Documentation

location()

template<class RowVector >

Real const & STK::MultiLaw::JointCauchy< RowVector >::location ( int const &  j ) const

inline

Returns

the location of the jth law

Definition at line 62 of file STK_MultiLaw_JointCauchy.h.

{ return this->law(j).location();}

References STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >::law().

Referenced by STK::MultiLaw::JointCauchy< RowVector >::setLocation().

scale()

template<class RowVector >

Real const & STK::MultiLaw::JointCauchy< RowVector >::scale ( int const &  j ) const

inline

Returns

the scale of the jth law

Definition at line 64 of file STK_MultiLaw_JointCauchy.h.

{ return this->law(j).scale();}

References STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >::law().

Referenced by STK::MultiLaw::JointCauchy< RowVector >::setScale().

setLocation()

template<class RowVector >

void STK::MultiLaw::JointCauchy< RowVector >::setLocation ( int const &  j, Real const &  location  )

inline

set the location of the jth law

Definition at line 66 of file STK_MultiLaw_JointCauchy.h.

    { this->law(j).setMu(location);}

References STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >::law(), and STK::MultiLaw::JointCauchy< RowVector >::location().

setScale()

template<class RowVector >

void STK::MultiLaw::JointCauchy< RowVector >::setScale ( int const &  j, Real const &  scale  )

inline

set the scale of the jth law

Definition at line 69 of file STK_MultiLaw_JointCauchy.h.

    { this->law(j).setScale(scale);}

References STK::MultiLaw::JointProbability< RowVector, Law::Cauchy >::law(), and STK::MultiLaw::JointCauchy< RowVector >::scale().

---

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

• STK_MultiLaw_JointCauchy.h