STK::JointGaussianParameters Struct Reference

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

#include <STK_JointGaussianModel.h>

Inheritance diagram for STK::JointGaussianParameters:

Public Member Functions
	JointGaussianParameters ()
	default constructor
	JointGaussianParameters (Range const &range)
	default constructor
	JointGaussianParameters (JointGaussianParameters const &param)
	copy constructor.
	~JointGaussianParameters ()
	destructor
Array2DPoint< Real > const &	mu () const
Array2DPoint< Real > const &	sigma () const
Real const	mu (int const &j) const
Real const	sigma (int const &j) const
void	setMu (int const &j, Real const &mu)
	set the mean of the jth law
void	setSigma (int const &j, Real const &sigma)
	set the standard deviation of the jth law
void	resizeImpl (Range const &range)
	resize the set of parameter
Public Member Functions inherited from STK::IMultiParameters< JointGaussianParameters >
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 >	mu_
Array2DPoint< Real >	sigma_

Additional Inherited Members
Protected Member Functions inherited from STK::IMultiParameters< JointGaussianParameters >
	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 Gaussian model.

Definition at line 52 of file STK_JointGaussianModel.h.

Constructor & Destructor Documentation

JointGaussianParameters() [1/3]

STK::JointGaussianParameters::JointGaussianParameters ( )

inline

default constructor

Definition at line 56 of file STK_JointGaussianModel.h.

: mu_(), sigma_() {}

JointGaussianParameters() [2/3]

STK::JointGaussianParameters::JointGaussianParameters ( Range const &  range )

inline

default constructor

Definition at line 58 of file STK_JointGaussianModel.h.

: mu_(range, 0.), sigma_(range, 1.) {}

JointGaussianParameters() [3/3]

STK::JointGaussianParameters::JointGaussianParameters ( JointGaussianParameters const &  param )

inline

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 60 of file STK_JointGaussianModel.h.

                            : mu_(param.mu_)
                            , sigma_(param.sigma_)
    {}

~JointGaussianParameters()

STK::JointGaussianParameters::~JointGaussianParameters ( )

inline

destructor

Definition at line 65 of file STK_JointGaussianModel.h.

{}

Member Function Documentation

mu() [1/2]

Array2DPoint< Real > const & STK::JointGaussianParameters::mu ( ) const

inline

Returns

the means

Definition at line 67 of file STK_JointGaussianModel.h.

{ return mu_;}

References mu_.

Referenced by setMu().

mu() [2/2]

Real const STK::JointGaussianParameters::mu ( int const &  j ) const

inline

Returns

the mean of the jth law

Definition at line 71 of file STK_JointGaussianModel.h.

{ return mu_[j];}

References mu_.

resizeImpl()

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

inline

resize the set of parameter

Definition at line 79 of file STK_JointGaussianModel.h.

    { mu_.resize(range); mu_ = 0.;
      sigma_.resize(range); sigma_ = 1.;
    }

References mu_, STK::IMultiParameters< JointGaussianParameters >::range(), STK::IArray2D< Derived >::resize(), and sigma_.

setMu()

void STK::JointGaussianParameters::setMu ( int const &  j, Real const &  mu  )

inline

set the mean of the jth law

Definition at line 75 of file STK_JointGaussianModel.h.

{ mu_[j] = mu;}

References mu(), and mu_.

setSigma()

void STK::JointGaussianParameters::setSigma ( int const &  j, Real const &  sigma  )

inline

set the standard deviation of the jth law

Definition at line 77 of file STK_JointGaussianModel.h.

{ sigma_[j] = sigma;}

References sigma(), and sigma_.

sigma() [1/2]

Array2DPoint< Real > const & STK::JointGaussianParameters::sigma ( ) const

inline

Returns

the mean of the jth law

Definition at line 69 of file STK_JointGaussianModel.h.

{ return sigma_;}

References sigma_.

Referenced by setSigma().

sigma() [2/2]

Real const STK::JointGaussianParameters::sigma ( int const &  j ) const

inline

Returns

the standard deviation of the jth law

Definition at line 73 of file STK_JointGaussianModel.h.

{ return sigma_[j];}

References sigma_.

Member Data Documentation

mu_

Array2DPoint<Real> STK::JointGaussianParameters::mu_

protected

Definition at line 85 of file STK_JointGaussianModel.h.

Referenced by mu(), mu(), resizeImpl(), and setMu().

sigma_

Array2DPoint<Real> STK::JointGaussianParameters::sigma_

protected

Definition at line 86 of file STK_JointGaussianModel.h.

Referenced by resizeImpl(), setSigma(), sigma(), and sigma().

---

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

• STK_JointGaussianModel.h