STK::Law::ILawBase Class Reference

Interface base class for all the (univariate/multivariate) probabilities laws. More...

#include <STK_Law_ILawBase.h>

Inheritance diagram for STK::Law::ILawBase:

List of all members.

Public Member Functions
virtual	~ILawBase ()
	Virtual destructor.
String const &	name () const
	Get the name of the law.
virtual void	update ()
	update the quantities specific to the law.
Protected Member Functions
	ILawBase (String const &name)
	Constructor.
Protected Attributes
String	name_
	Name of the Law.
Static Protected Attributes
static RandBase	generator
	Pseudo-random uniform/Gaussian/exponential generator.

---

Detailed Description

Interface base class for all the (univariate/multivariate) probabilities laws.

A general probability law possess a name. The parameters are specific to the law and will be set by reference.

Definition at line 54 of file STK_Law_ILawBase.h.

---

Constructor & Destructor Documentation

STK::Law::ILawBase::ILawBase

(

String const &

name

)

[inline, protected]

Constructor.

Parameters:

name	the name of the law

Definition at line 60 of file STK_Law_ILawBase.h.

                                        : name_(name)
    { }

virtual STK::Law::ILawBase::~ILawBase

(

)

[inline, virtual]

Virtual destructor.

Definition at line 65 of file STK_Law_ILawBase.h.

{ }

---

Member Function Documentation

String const& STK::Law::ILawBase::name

(

)

const [inline]

Get the name of the law.

Returns:

the name of the distribution

Definition at line 70 of file STK_Law_ILawBase.h.

References name_.

{ return name_;}

virtual void STK::Law::ILawBase::update

(

)

[inline, virtual]

update the quantities specific to the law.

If the parameters are modified, these quantities will be updated.

Reimplemented in STK::Law::MultivariateNormal< Container1D >.

Definition at line 75 of file STK_Law_ILawBase.h.

Referenced by STK::GaussianStatModel::run().

{ }

---

Member Data Documentation

RandBase STK::Law::ILawBase::generator [static, protected]

Pseudo-random uniform/Gaussian/exponential generator.

Must be explicitly initialized outside the class with Law::ILawBase::generator, or an other constructor

See also:

RandBase.

Definition at line 82 of file STK_Law_ILawBase.h.

Referenced by STK::Law::Normal::rand(), and STK::Law::Cauchy::rand().

String STK::Law::ILawBase::name_ [protected]

Name of the Law.

Definition at line 85 of file STK_Law_ILawBase.h.

Referenced by name().

---

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

• STK_Law_ILawBase.h