main page namespaces classes files
ELL home

src/ell/Walk.hh

Go to the documentation of this file.

#ifndef WALK_HH_
#define WALK_HH_


#include "ell/State.hh"
#include "ell/NeighborGenerator.hh"
#include "ell/StateAcceptor.hh"
#include "ell/WalkAbortionCriterion.hh"
#include "ell/StateCollector.hh"

namespace ell {
    
    

    
    
    class Walk {
    public:
        
            virtual ~Walk() {};
            
        virtual 
            StateCollector*
            walk(   const State* const start, 
                    StateCollector* const scWalk, 
                    StateCollector* scRejected = NULL
                ) const = 0;
        
        static 
            StateCollector* 
            walk(   const State* const start, 
                    StateCollector* const scWalk,
                    const NeighborGenerator* const ng, 
                    const StateAcceptor* const sa, 
                    const WalkAbortionCriterion* const wac, 
                    StateCollector* scRejected = NULL
                );
        
    protected:
    };
    
    
    
    

    class WalkAdaptive : public Walk {
    public:
        
            enum NeighborGenType {SUCCESSIVE, RANDOM};
            
        WalkAdaptive(   const NeighborGenType ngt,
                        const bool isDegenerate = false
                    );
        
        virtual ~WalkAdaptive() {};
        
        static 
            StateCollector* 
            walkAdaptive(
                const State* const start, 
                StateCollector* const scWalk,
                const NeighborGenType ngt,
                StateCollector* const scRejected = NULL,
                const bool isDegenerate = false
                );

        // implements abstract function of superclass
        virtual
            StateCollector* 
            walk(
                const State* const start, 
                StateCollector* const scWalk,
                StateCollector* const scRejected = NULL
                ) const;
                
    protected:
        const NeighborGenType t;

        const bool isDeg;
    };

    
    
    
    class WalkGradient : public Walk{
    public:
            
        WalkGradient( const bool isDegenerate = false );

        virtual ~WalkGradient() {};

        static 
            StateCollector* 
            walkGradient(
                const State* const start, 
                StateCollector* const scWalk,
                const bool isDegenerate = false
                );
        
        // implementation of virtual member function for a gradient walk of an WalkGradient object
        virtual 
            StateCollector* 
            walk(
                const State* const start, 
                StateCollector* const scWalk,
                StateCollector* const scRejected
                ) const;
        
    protected:
        
        const bool isDeg;
    };

    
    

    class WalkMC : public Walk{
    public:
        
        WalkMC( const WalkAbortionCriterion* const wac, 
                    const double beta );
        
        virtual ~WalkMC() {delete wac;};
        
        static 
            StateCollector* 
            walkMC( const State* const start, 
                    StateCollector* const scWalk, 
                    const WalkAbortionCriterion* const wac, 
                    const double beta,
                    StateCollector* const scRejected = NULL
                    );
        
        // implementation of virtual member function for a monte carlo walk of an WalkMC object
        virtual 
            StateCollector* 
            walk(
                const State* const start, 
                StateCollector* const scWalk,
                StateCollector* const scRejected = NULL
            ) const;
                
    protected:
        
        const WalkAbortionCriterion* const wac; 
            
        const double beta;
    };
    
    
    
    
    

    class WalkRandom : public Walk {
    public:
        
            WalkRandom( 
                        const WalkAbortionCriterion* const wac
                    );
            
            virtual ~WalkRandom() {};
            
        static 
            StateCollector* 
            walkRandom( const State* const start, 
                        StateCollector* const scWalk,
                        const WalkAbortionCriterion* const wac, 
                        StateCollector* const scRejected = NULL
                        );
        
        // implementation of virtual member function for a random walk of a WalkRandom object
        virtual 
            StateCollector* 
            walk(   const State* const start, 
                    StateCollector* const scWalk,
                    StateCollector* const scRejected = NULL
                    ) const;
        
    protected:
        
        const WalkAbortionCriterion* const wac;
        
    };

    
    
} // end namespace ell

#endif /*WALK_HH_*/