main page namespaces classes files
ELL home

src/ell/Basin.hh

Go to the documentation of this file.

#ifndef BASIN_HH_
#define BASIN_HH_

//##############################################################################
//##############################################################################

#include "ell/State.hh"
#include "ell/StateCollector.hh" 
#include "ell/StatePairCollector.hh" 

namespace ell
{


    class Basin {

        
    public:
        
        virtual
        ~Basin();
        
        virtual
        double enumerate(   const State* const localMin,
                            StateCollector* scBasin,
                            StatePairCollector* scSurface = NULL) = 0;
        
    };
    
} // namespace ell

//##############################################################################
//##############################################################################


namespace ell {
    
    class Basin_FME : public Basin {
    protected:
        const double maxE;
        const double deltaE;
        const size_t maxToStore;
        
    public:
        
        class QueueVal {
        public:
        
            CSequence minNeigh;
            double minNeighE;
            size_t minNeighGWE;
            
            QueueVal();
            ~QueueVal();
        };

        
    public:
        
        Basin_FME(  const double maxE
                    , const double deltaE 
                    , const size_t maxToStore 
                );
        
        virtual
        ~Basin_FME();
        
        virtual
        double enumerate(   const State* const localMin,
                            StateCollector* scBasin,
                            StatePairCollector* scSurface = NULL);
        
        
        static double flood(    const State* const localMin, 
                                StateCollector* scBasin,
                                const double maxE, 
                                const double deltaE, 
                                const size_t maxToStore, 
                                StatePairCollector* scSurface = NULL
                            );
    };
    
} // namespace ell


//##############################################################################
//##############################################################################



namespace ell {
    
    class Basin_F : public Basin {
    protected:
        const double maxE;
        const double deltaE;
        const size_t maxToStore;
        
    public:
        
        class QueueVal {
        public:
        
            CSequence minNeigh;
            double minNeighE;
            size_t minNeighGWE;
            
            QueueVal();
            ~QueueVal();
        };

        
    public:
        
        Basin_F(    const double maxE
                    , const double deltaE 
                    , const size_t maxToStore 
                );
        
        virtual
        ~Basin_F();
        
        virtual
        double enumerate(   const State* const localMin,
                            StateCollector* scBasin,
                            StatePairCollector* scSurface = NULL);
        
        
        static double flood(    const State* const localMin, 
                                StateCollector* scBasin,
                                const double maxE, 
                                const double deltaE, 
                                const size_t maxToStore, 
                                StatePairCollector* scSurface = NULL
                            );
    };
    
} // namespace ell


//##############################################################################
//##############################################################################


#endif /*BASIN_HH_*/