STK::DiagGaussian_muj_sjParameters Struct Reference

Structure encapsulating the parameters of a DiagGaussian_muj_sj model. More...

#include <STK_ModelDiagGaussian_muj_sj.h>

Public Member Functions
	DiagGaussian_muj_sjParameters ()
	default constructor
	DiagGaussian_muj_sjParameters (Range const &range)
	default constructor
	DiagGaussian_muj_sjParameters (DiagGaussian_muj_sjParameters const &param)
	copy constructor.
	~DiagGaussian_muj_sjParameters ()
	destructor
CPointX const &	mu () const
CPointX const &	sigma () const
Real const	mu (int j) const
Real const	sigma (int j) const
void	resize (Range const &range)
	resize the parameters only if the range is modified, otherwise, stay with the current values.

Public Attributes
CPointX	mu_
CPointX	sigma_
Range	range_

Detailed Description

Structure encapsulating the parameters of a DiagGaussian_muj_sj model.

Definition at line 78 of file STK_ModelDiagGaussian_muj_sj.h.

Constructor & Destructor Documentation

DiagGaussian_muj_sjParameters() [1/3]

STK::DiagGaussian_muj_sjParameters::DiagGaussian_muj_sjParameters ( )

inline

default constructor

Definition at line 81 of file STK_ModelDiagGaussian_muj_sj.h.

: mu_(), sigma_() {}

DiagGaussian_muj_sjParameters() [2/3]

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

inline

default constructor

Definition at line 83 of file STK_ModelDiagGaussian_muj_sj.h.

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

DiagGaussian_muj_sjParameters() [3/3]

STK::DiagGaussian_muj_sjParameters::DiagGaussian_muj_sjParameters ( DiagGaussian_muj_sjParameters const &  param )

inline

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 85 of file STK_ModelDiagGaussian_muj_sj.h.

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

~DiagGaussian_muj_sjParameters()

STK::DiagGaussian_muj_sjParameters::~DiagGaussian_muj_sjParameters ( )

inline

destructor

Definition at line 90 of file STK_ModelDiagGaussian_muj_sj.h.

{}

Member Function Documentation

mu() [1/2]

CPointX const & STK::DiagGaussian_muj_sjParameters::mu ( ) const

inline

Returns

the means

Definition at line 93 of file STK_ModelDiagGaussian_muj_sj.h.

{ return mu_;}

References mu_.

Referenced by STK::ModelDiagGaussian_muj_sj< Data_, WColVector_ >::mean().

mu() [2/2]

Real const STK::DiagGaussian_muj_sjParameters::mu ( int  j ) const

inline

Returns

the mean of the jth law

Definition at line 98 of file STK_ModelDiagGaussian_muj_sj.h.

{ return mu_[j];}

References mu_.

resize()

void STK::DiagGaussian_muj_sjParameters::resize ( Range const &  range )

inline

resize the parameters only if the range is modified, otherwise, stay with the current values.

Parameters

range

the range of the parameters (= range of the variables of the model)

Definition at line 106 of file STK_ModelDiagGaussian_muj_sj.h.

    {
      if (range != range_)
      {
        mu_.resize(range); sigma_.resize(range);
        range_ = range;
      }
    }

References mu_, range_, STK::ICArray< Derived >::resize(), and sigma_.

sigma() [1/2]

CPointX const & STK::DiagGaussian_muj_sjParameters::sigma ( ) const

inline

Returns

the mean of the jth law

Definition at line 95 of file STK_ModelDiagGaussian_muj_sj.h.

{ return sigma_;}

References sigma_.

Referenced by STK::ModelDiagGaussian_muj_sj< Data_, WColVector_ >::sigma().

sigma() [2/2]

Real const STK::DiagGaussian_muj_sjParameters::sigma ( int  j ) const

inline

Returns

the standard deviation of the jth law

Definition at line 100 of file STK_ModelDiagGaussian_muj_sj.h.

{ return sigma_[j];}

References sigma_.

Member Data Documentation

mu_

CPointX STK::DiagGaussian_muj_sjParameters::mu_

Definition at line 114 of file STK_ModelDiagGaussian_muj_sj.h.

Referenced by mu(), mu(), and resize().

range_

Range STK::DiagGaussian_muj_sjParameters::range_

Definition at line 116 of file STK_ModelDiagGaussian_muj_sj.h.

Referenced by resize().

sigma_

CPointX STK::DiagGaussian_muj_sjParameters::sigma_

Definition at line 115 of file STK_ModelDiagGaussian_muj_sj.h.

Referenced by resize(), sigma(), and sigma().

---

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

• STK_ModelDiagGaussian_muj_sj.h