Algorithm.hh

Go to the documentation of this file.

#ifndef _ALGORITHMHH_
#define _ALGORITHMHH_

#include <map>
#include <string>

#include <openmodeller/om_defs.hh>
#include <openmodeller/CallbackWrapper.hh>
#include <openmodeller/Sampler.hh>
#include <openmodeller/AlgMetadata.hh>
#include <openmodeller/ignorecase_traits.hh>

#include <openmodeller/Configurable.hh>
#include <openmodeller/Configuration.hh>

#include <openmodeller/refcount.hh>

#include <openmodeller/Model.hh>

#include <openmodeller/Normalizer.hh>

class AlgParameter;

// Forward Decl.
class AlgorithmImpl;

typedef ReferenceCountedPointer< AlgorithmImpl > AlgorithmPtr;
typedef ReferenceCountedPointer< const AlgorithmImpl > ConstAlgorithmPtr;

typedef AlgorithmImpl *(*TAlgFactory)();
typedef AlgMetadata *(*TAlgMetadata)();
extern "C"
{
OM_ALG_DLL_EXPORT AlgorithmImpl *algorithmFactory();
OM_ALG_DLL_EXPORT AlgMetadata const *algorithmMetadata();
}

class dllexp AlgorithmImpl : public Configurable, private ReferenceCountedObject
{

  friend class ReferenceCountedPointer<AlgorithmImpl>;
  friend class ReferenceCountedPointer<const AlgorithmImpl>;

public:

  typedef std::map< icstring, std::string > ParamSetType;

  // This constructor should only be used by default constructors
  // of derived classes.
  explicit AlgorithmImpl( AlgMetadata const *metadata );

  virtual ~AlgorithmImpl();
  
  void setParameters( int nparam, AlgParameter const *param );
  void setParameters( const ParamSetType& );
  
  std::string const getID() const { return _metadata ? _metadata->id : 0; }
  
  AlgMetadata const *getMetadata() const { return _metadata; }

  AlgorithmPtr getFreshCopy();
  
  virtual int supportsModelProjection() const { return 1; }
  
  /*
   * Training Methods
   */
  Model createModel( const SamplerPtr& samp, CallbackWrapper *func = 0 );

  void setSampler( const SamplerPtr& samp );
  
  virtual int initialize() = 0;
  
  virtual int iterate() { return 1; };
  
  virtual int finalize() { return 1; }
  
  virtual int done() const { return 1; }
  
  virtual int getConvergence( Scalar * const val ) const { return 0; }
  
  virtual float getProgress() const { return (float) done(); }
  
  /*
   * Model Implementation.
   */
  
  virtual int needNormalization() { return ( _normalizerPtr == 0 ) ? 0 : 1; }

  Normalizer * getNormalizer() const; 

  void setNormalization( const SamplerPtr& samp ) const;
  
  void setNormalization( const EnvironmentPtr& env ) const;
  
  virtual Scalar getValue( const Sample& x ) const = 0;
  
  /*
   * Extract the Model from the Algorithm
   */
  virtual Model getModel() const;
  
  /*
   * Extract and set configuration
   */
  
  ConfigurationPtr getConfiguration() const;
  
  void setConfiguration( const ConstConfigurationPtr & );
  
protected:

  virtual void _getConfiguration( ConfigurationPtr& ) const { return; }
  virtual void _setConfiguration( const ConstConfigurationPtr & ) { return; }
  
  int dimDomain()  { return _samp ? _samp->numIndependent() : 0; }
  
  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:
  
  SamplerPtr _samp;

  Normalizer * _normalizerPtr;

  ParamSetType _param;

private:

  AlgMetadata const *_metadata;

private:
  
  typedef ParamSetType::value_type ParamSetValueType;

};

#endif