openModeller  Version 1.5.0
CsmKG Class Reference

#include <csmkg.hh>

Inheritance diagram for CsmKG:
Inheritance graph
Collaboration diagram for CsmKG:
Collaboration graph

Public Member Functions

 CsmKG ()
 
 ~CsmKG ()
 
- Public Member Functions inherited from Csm
 Csm (AlgMetadata const *metadata)
 
 ~Csm ()
 
virtual int initialize ()
 
int iterate ()
 
int done () const
 
Scalar getValue (const Sample &x) const
 
int getConvergence (Scalar *const val) const
 
- Public Member Functions inherited from AlgorithmImpl
 AlgorithmImpl (AlgMetadata const *metadata)
 
virtual ~AlgorithmImpl ()
 
void setParameters (int nparam, AlgParameter const *param)
 
void setParameters (const ParamSetType &)
 
std::string const getID () const
 
AlgMetadata const * getMetadata () const
 
AlgorithmPtr getFreshCopy ()
 
virtual int supportsModelProjection () const
 
Model createModel (const SamplerPtr &samp, CallbackWrapper *func=0)
 
void setSampler (const SamplerPtr &samp)
 
virtual int finalize ()
 
virtual float getProgress () const
 
virtual int needNormalization ()
 
NormalizergetNormalizer () const
 
void setNormalization (const SamplerPtr &samp) const
 
void setNormalization (const EnvironmentPtr &env) const
 
virtual Model getModel () const
 
ConfigurationPtr getConfiguration () const
 
void setConfiguration (const ConstConfigurationPtr &)
 
- Public Member Functions inherited from Configurable
virtual ~Configurable ()
 

Private Member Functions

int discardComponents ()
 

Additional Inherited Members

- Public Types inherited from AlgorithmImpl
typedef std::map< icstring,
std::string > 
ParamSetType
 
- Protected Member Functions inherited from Csm
int SamplerToMatrix ()
 
bool csm1 ()
 
int calculateMeanAndSd (gsl_matrix *theMatrix, gsl_vector *theMeanVector, gsl_vector *theStdDevVector)
 
int center ()
 
void displayVector (const gsl_vector *v, const char *name, const bool roundFlag=true) const
 
void displayMatrix (const gsl_matrix *m, const char *name, const bool roundFlag=true) const
 
gsl_matrix * transpose (gsl_matrix *m)
 
double product (gsl_vector *va, gsl_vector *vb) const
 
gsl_matrix * product (gsl_matrix *a, gsl_matrix *b) const
 
gsl_matrix * autoCovariance (gsl_matrix *m)
 
virtual void _getConfiguration (ConfigurationPtr &config) const
 
virtual void _setConfiguration (const ConstConfigurationPtr &config)
 
- Protected Member Functions inherited from AlgorithmImpl
int dimDomain ()
 
int getParameter (std::string const &name, std::string *value)
 
int getParameter (std::string const &name, double *value)
 
int getParameter (std::string const &name, float *value)
 
int getParameter (std::string const &name, int *value)
 
- Protected Attributes inherited from Csm
int _initialized
 
int _done
 
gsl_matrix * _gsl_environment_matrix
 
gsl_matrix * _gsl_covariance_matrix
 
gsl_vector * _gsl_avg_vector
 
gsl_vector * _gsl_stddev_vector
 
gsl_vector * _gsl_eigenvalue_vector
 
gsl_matrix * _gsl_eigenvector_matrix
 
int _layer_count
 
int _retained_components_count
 
int _localityCount
 
int minComponentsInt
 
bool verboseDebuggingBool
 
- Protected Attributes inherited from AlgorithmImpl
SamplerPtr _samp
 
Normalizer_normalizerPtr
 
ParamSetType _param
 

Detailed Description

CsmKG = Csm kaiser-gutman cutoff for discarded components

Author
Tim Sutton

Definition at line 41 of file csmkg.hh.

Constructor & Destructor Documentation

CsmKG::CsmKG ( )

Constructor for Csm

Constructor for CsmKG

Parameters
Sampleris class that will fetch environment variable values at each occurrence / locality

Definition at line 117 of file csmkg.cpp.

References Csm::_initialized.

CsmKG::~CsmKG ( )

This is the descructor for the Csm class

Definition at line 124 of file csmkg.cpp.

Member Function Documentation

int CsmKG::discardComponents ( )
privatevirtual

Discard unwanted components. This is a pure virtual function - it must be implemented by the derived class. Currently two derived classes are expected to be implemented - one for kaiser-gutman cutoff and one for broken-stick cutoff.

Note
This method must be called after center
Returns
0 on error

Implements Csm.

Definition at line 139 of file csmkg.cpp.

References Csm::_gsl_eigenvalue_vector, Csm::_gsl_eigenvector_matrix, Csm::_layer_count, and Csm::_retained_components_count.


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