main page namespaces classes files
ELL home

src/ell/StatePairCollector.hh

Go to the documentation of this file.

#ifndef STATEPAIRCOLLECTOR_HH_
#define STATEPAIRCOLLECTOR_HH_


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

#include "ell/State.hh"

#include <utility> // contains std::pair definition

namespace ell 
{
    class StatePairCollector
    {
    public: 
        
        typedef std::pair<const State*,const State*> StatePair;
    
        virtual
        ~StatePairCollector() {}
        
        
        virtual void add(const StatePair& s) = 0;
        
        virtual void add(   const State* const s1
                            , const State* const s2) = 0;
        
        virtual size_t size() const = 0;
        
        virtual const StatePair getLastAdded() const = 0;
        
    };
    
} // namespace ell

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


namespace ell
{
    class SPC_Counting : public StatePairCollector
    {
        
    protected:
    
        State*  lastAdded_s1;
        State*  lastAdded_s2;
        size_t      statePairCount;
        
    public: 
    
        SPC_Counting();
        
        virtual
        ~SPC_Counting();
    
        virtual void add(   const StatePair& s );
        
        virtual void add(   const State* const s1
                            , const State* const s2 );
        
        virtual size_t size() const;
         
        virtual const StatePair getLastAdded() const;
        
    protected:
        
        void clearLastAdded();
        
    };
    
      // inline defintion 
    inline void SPC_Counting::clearLastAdded() {
        if (lastAdded_s1 != NULL)
            delete lastAdded_s1;
        if (lastAdded_s2 != NULL)
            delete lastAdded_s2;
    }

    
} // namespace ell


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

#include <list>

namespace ell
{
    class SPC_Listing : public StatePairCollector
    {
    public:
        typedef std::list<StatePair> List;
                
    protected:

        List statePairList;
    
    public: 
    
        SPC_Listing();
        
        virtual
        ~SPC_Listing();
    
        virtual void add(const StatePair& s);
        
        virtual void add(   const State* const s1
                            , const State* const s2 );
        
        virtual size_t size() const;
         
        virtual const StatePair getLastAdded() const;
        
    
        virtual const List& getList() const;
        
    };
    
} // namespace ell


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

#include <ostream>
#include <string>

namespace ell {

    class SPC_Outstream : public SPC_Counting 
    {
    protected:
        std::ostream& out;
        
        const std::string strSep;
        
        const std::string strAppend;

    public:
        
        SPC_Outstream(  std::ostream& out
                        , const std::string& separator
                        , const std::string& toAppend );

        
        virtual
        ~SPC_Outstream();
    
        virtual void add(   const StatePair& s );
        
        virtual void add(   const State* const s1
                            , const State* const s2 );
        
    protected:
        
        void printToStream();

    };
    
    inline void SPC_Outstream::printToStream() {
        out <<lastAdded_s1->toString()
            <<strSep
            <<lastAdded_s2->toString()
            <<strAppend;
    }

} // namespace ell

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


namespace ell
{
    class SPC_MinPair : public SPC_Counting
    {
        
    protected:
        
        const bool pairsAddedInAscOrder;

        State*  minPair_s1;
        State*  minPair_s2;
        const State*    minPair_max;
        
        using SPC_Counting::lastAdded_s1;
        using SPC_Counting::lastAdded_s2;
        
    public: 
        
        SPC_MinPair( const bool pairsAddedInAscOrder = false );
        
        virtual
        ~SPC_MinPair();
    
        virtual void add(   const StatePair& s );
        
        virtual void add(   const State* const s1
                            , const State* const s2 );
         
        virtual const StatePair getMinPair() const;
        
    protected:
        
        void clearMinPair();
        
          // minimal pair
        void checkMinPair();
        
    };
    
      // inline defintion 
    inline void SPC_MinPair::clearMinPair() {
        if (minPair_s1 != NULL)
            delete minPair_s1;
        if (minPair_s2 != NULL)
            delete minPair_s2;
    }

    
} // namespace ell


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


#endif /*STATEPAIRCOLLECTOR_HH_*/