gstlrn::AGibbs Class Reference

#include <AGibbs.hpp>

Inheritance diagram for gstlrn::AGibbs:

Public Member Functions
	AGibbs ()
	AGibbs (Db *db)
	AGibbs (Db *db, Id npgs, Id nvar, Id nburn, Id niter, Id seed, Id flag_order, bool flag_decay)
	AGibbs (const AGibbs &r)
AGibbs &	operator= (const AGibbs &r)
virtual	~AGibbs ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface for AStringable.
virtual Id	calculInitialize (1 &y, Id isimu, Id ipgs)=0
	Interface for AGibbs.
virtual void	update (1 &y, Id isimu, Id ipgs, Id iter)=0
virtual Id	covmatAlloc (bool verbose, bool verboseTimer=false)=0
virtual double	getSimulate (1 &y, double yk, double sk, Id icase, Id ipgs, Id ivar, Id iact, Id iter)=0
virtual Id	checkGibbs (const 1 &y, Id isimu, Id ipgs)=0
virtual void	cleanup ()
void	init (Id npgs, Id nvar, Id nburn, Id niter, Id seed=3241, Id flag_order=0, bool flag_decay=true)
Id	run (1 &y, Id ipgs0=0, Id isimu0=0, bool verboseTimer=false, bool flagCheck=false)
Id	getNvar () const
void	setNvar (Id nvar)
Id	getNpgs () const
void	setNpgs (Id npgs)
Id	getNburn () const
void	setNburn (Id nburn)
Id	getNiter () const
void	setNiter (Id niter)
Id	getFlagOrder () const
void	setFlagOrder (Id flagOrder)
bool	getOptionStats () const
void	setOptionStats (Id option_stats)
Db *	getDb () const
	allocY () const
void	storeResult (const 1 &y, Id isimu, Id ipgs)
Id	getNSample () const
Id	getSampleRank (Id i) const
Id	getRank (Id ipgs, Id ivar) const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Constructor & Destructor Documentation

AGibbs() [1/4]

gstlrn::AGibbs::AGibbs

(

)

AGibbs() [2/4]

gstlrn::AGibbs::AGibbs

(

Db *

db

)

AGibbs() [3/4]

gstlrn::AGibbs::AGibbs	(	Db *	db,
		Id	npgs,
		Id	nvar,
		Id	nburn,
		Id	niter,
		Id	seed,
		Id	flag_order,
		bool	flag_decay
	)

AGibbs() [4/4]

gstlrn::AGibbs::AGibbs

(

const AGibbs &

r

)

~AGibbs()

gstlrn::AGibbs::~AGibbs ( )

virtual

Member Function Documentation

allocY()

gstlrn::AGibbs::allocY

(

)

const

Returns a Vector of Vector Double used to store one simulation. Its first dimension is set to 'npgs' * 'nvar' Its second dimension if set to the number of samples

Returns

calculInitialize()

virtual Id gstlrn::AGibbs::calculInitialize ( 1 &  y, Id  isimu, Id  ipgs  )

pure virtual

Interface for AGibbs.

Implemented in gstlrn::GibbsMulti, and gstlrn::GibbsMultiMono.

checkGibbs()

virtual Id gstlrn::AGibbs::checkGibbs ( const 1 &  y, Id  isimu, Id  ipgs  )

pure virtual

Implemented in gstlrn::GibbsMulti, and gstlrn::GibbsMultiMono.

cleanup()

virtual void gstlrn::AGibbs::cleanup ( )

inlinevirtual

Reimplemented in gstlrn::GibbsMMulti.

covmatAlloc()

virtual Id gstlrn::AGibbs::covmatAlloc ( bool  verbose, bool  verboseTimer = false  )

pure virtual

Implemented in gstlrn::GibbsMMulti, gstlrn::GibbsUMulti, gstlrn::GibbsUMultiMono, and gstlrn::GibbsUPropMono.

getDb()

Db * gstlrn::AGibbs::getDb ( ) const

inline

getFlagOrder()

Id gstlrn::AGibbs::getFlagOrder ( ) const

inline

getNburn()

Id gstlrn::AGibbs::getNburn ( ) const

inline

getNiter()

Id gstlrn::AGibbs::getNiter ( ) const

inline

getNpgs()

Id gstlrn::AGibbs::getNpgs ( ) const

inline

getNSample()

Id gstlrn::AGibbs::getNSample

(

)

const

getNvar()

Id gstlrn::AGibbs::getNvar ( ) const

inline

getOptionStats()

bool gstlrn::AGibbs::getOptionStats ( ) const

inline

getRank()

Id gstlrn::AGibbs::getRank	(	Id	ipgs,
		Id	ivar
	)		const

getSampleRank()

Id gstlrn::AGibbs::getSampleRank

(

Id

i

)

const

getSimulate()

virtual double gstlrn::AGibbs::getSimulate ( 1 &  y, double  yk, double  sk, Id  icase, Id  ipgs, Id  ivar, Id  iact, Id  iter  )

pure virtual

Implemented in gstlrn::GibbsMulti, and gstlrn::GibbsMultiMono.

init()

void gstlrn::AGibbs::init	(	Id	npgs,
		Id	nvar,
		Id	nburn,
		Id	niter,
		Id	seed = 3241,
		Id	flag_order = 0,
		bool	flag_decay = true
	)

operator=()

AGibbs & gstlrn::AGibbs::operator=

(

const AGibbs &

r

)

run()

Id gstlrn::AGibbs::run	(	1 &	y,
		Id	ipgs0 = 0,
		Id	isimu0 = 0,
		bool	verboseTimer = false,
		bool	flagCheck = false
	)

Simulate a vector for the current 'ipgs' and current 'isimu'

Parameters

y	Simulation vector (used in input and output)
ipgs0	Rank of the current 'pgs'
isimu0	Rank of the current simulation
verboseTimer	Verbose option for time consumption
flagCheck	True if the checks must be performed

Returns

setFlagOrder()

void gstlrn::AGibbs::setFlagOrder ( Id  flagOrder )

inline

setNburn()

void gstlrn::AGibbs::setNburn ( Id  nburn )

inline

setNiter()

void gstlrn::AGibbs::setNiter ( Id  niter )

inline

setNpgs()

void gstlrn::AGibbs::setNpgs ( Id  npgs )

inline

setNvar()

void gstlrn::AGibbs::setNvar ( Id  nvar )

inline

setOptionStats()

void gstlrn::AGibbs::setOptionStats ( Id  option_stats )

inline

storeResult()

void gstlrn::AGibbs::storeResult	(	const 1 &	y,
		Id	isimu,
		Id	ipgs
	)

Store the Gaussian array in ELoc::GAUS variable. This should be performed once for all GS and all variables

Parameters

y	The Gaussian vector to be stored
isimu	Rank of the simulation
ipgs	Rank of the GS

toString()

String gstlrn::AGibbs::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface for AStringable.

Reimplemented from gstlrn::AStringable.

update()

virtual void gstlrn::AGibbs::update ( 1 &  y, Id  isimu, Id  ipgs, Id  iter  )

pure virtual

Implemented in gstlrn::GibbsMMulti, gstlrn::GibbsUMulti, gstlrn::GibbsUMultiMono, and gstlrn::GibbsUPropMono.

---

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

• include/Gibbs/AGibbs.hpp
• src/Gibbs/AGibbs.cpp