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:

Public Member Functions
String const &	name () const

Protected Member Functions
	ILawBase (String const &name)
	Constructor.
	~ILawBase ()
	destructor.

Protected Attributes
String	name_
	Name of the Law.

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 53 of file STK_Law_ILawBase.h.

Constructor & Destructor Documentation

ILawBase()

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

inlineprotected

Constructor.

Parameters

name	the name of the law

Definition at line 59 of file STK_Law_ILawBase.h.

: name_(name) {}

~ILawBase()

STK::Law::ILawBase::~ILawBase ( )

inlineprotected

destructor.

Definition at line 61 of file STK_Law_ILawBase.h.

{}

Member Function Documentation

name()

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

inline

Returns

the name of the distribution

Definition at line 65 of file STK_Law_ILawBase.h.

{ return name_;}

References name_.

Member Data Documentation

name_

String STK::Law::ILawBase::name_

protected

Name of the Law.

Definition at line 69 of file STK_Law_ILawBase.h.

Referenced by name().

---

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

• STK_Law_ILawBase.h