1.4.0
CCC
 
AGibbs Class Referenceabstract

#include <AGibbs.hpp>

Inheritance diagram for AGibbs:
AStringable GibbsMulti GibbsMultiMono GibbsMMulti GibbsUMulti GibbsUMultiMono GibbsUPropMono

Public Member Functions

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

Constructor & Destructor Documentation

◆ AGibbs() [1/4]

AGibbs::AGibbs ( )

◆ AGibbs() [2/4]

AGibbs::AGibbs ( Db db)

◆ AGibbs() [3/4]

AGibbs::AGibbs ( Db db,
int  npgs,
int  nvar,
int  nburn,
int  niter,
int  seed,
int  flag_order,
bool  flag_decay 
)

◆ AGibbs() [4/4]

AGibbs::AGibbs ( const AGibbs r)

◆ ~AGibbs()

AGibbs::~AGibbs ( )
virtual

Member Function Documentation

◆ allocY()

VectorVectorDouble 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 int AGibbs::calculInitialize ( VectorVectorDouble y,
int  isimu,
int  ipgs 
)
pure virtual

Interface for AGibbs.

Implemented in GibbsMultiMono, and GibbsMulti.

◆ checkGibbs()

virtual int AGibbs::checkGibbs ( const VectorVectorDouble y,
int  isimu,
int  ipgs 
)
pure virtual

Implemented in GibbsMultiMono, and GibbsMulti.

◆ cleanup()

virtual void AGibbs::cleanup ( )
inlinevirtual

Reimplemented in GibbsMMulti.

◆ covmatAlloc()

virtual int AGibbs::covmatAlloc ( bool  verbose,
bool  verboseTimer = false 
)
pure virtual

◆ getDb()

Db* AGibbs::getDb ( ) const
inline

◆ getFlagOrder()

int AGibbs::getFlagOrder ( ) const
inline

◆ getNburn()

int AGibbs::getNburn ( ) const
inline

◆ getNiter()

int AGibbs::getNiter ( ) const
inline

◆ getNpgs()

int AGibbs::getNpgs ( ) const
inline

◆ getNvar()

int AGibbs::getNvar ( ) const
inline

◆ getOptionStats()

bool AGibbs::getOptionStats ( ) const
inline

◆ getRank()

int AGibbs::getRank ( int  ipgs,
int  ivar 
) const

◆ getSampleNumber()

int AGibbs::getSampleNumber ( ) const

◆ getSampleRank()

int AGibbs::getSampleRank ( int  i) const

◆ getSimulate()

virtual double AGibbs::getSimulate ( VectorVectorDouble y,
double  yk,
double  sk,
int  icase,
int  ipgs,
int  ivar,
int  iact,
int  iter 
)
pure virtual

Implemented in GibbsMultiMono, and GibbsMulti.

◆ init()

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

◆ operator=()

AGibbs & AGibbs::operator= ( const AGibbs r)

◆ run()

int AGibbs::run ( VectorVectorDouble y,
int  ipgs0 = 0,
int  isimu0 = 0,
bool  verboseTimer = false,
bool  flagCheck = false 
)

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

Parameters
ySimulation vector (used in input and output)
ipgs0Rank of the current 'pgs'
isimu0Rank of the current simulation
verboseTimerVerbose option for time consumption
flagCheckTrue if the checks must be performed
Returns

◆ setFlagOrder()

void AGibbs::setFlagOrder ( int  flagOrder)
inline

◆ setNburn()

void AGibbs::setNburn ( int  nburn)
inline

◆ setNiter()

void AGibbs::setNiter ( int  niter)
inline

◆ setNpgs()

void AGibbs::setNpgs ( int  npgs)
inline

◆ setNvar()

void AGibbs::setNvar ( int  nvar)
inline

◆ setOptionStats()

void AGibbs::setOptionStats ( int  option_stats)
inline

◆ storeResult()

void AGibbs::storeResult ( const VectorVectorDouble y,
int  isimu,
int  ipgs 
)

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

Parameters
yThe Gaussian vector to be stored
isimuRank of the simulation
ipgsRank of the GS

◆ toString()

String AGibbs::toString ( const AStringFormat strfmt = nullptr) const
overridevirtual

Interface for AStringable.

Reimplemented from AStringable.

◆ update()

virtual void AGibbs::update ( VectorVectorDouble y,
int  isimu,
int  ipgs,
int  iter 
)
pure virtual

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