main page namespaces classes files
BIU home

src/biu/LatticeFrame.hh

Go to the documentation of this file.

#ifndef LATTICEFRAME_HH_
#define LATTICEFRAME_HH_


#include "LatticeModel.hh"

namespace biu
{
    

    class LatticeFrame : public LatticeModel
    {
    private:
        unsigned int    frameSize;      
        unsigned int    frameSizeP2;    
    public:
    
        typedef int index_type;         
        
        LatticeFrame(   const LatticeDescriptor* const _latDescriptor, 
                        const unsigned int frameSize);
                        
        LatticeFrame(const LatticeFrame& toCopy);
        virtual ~LatticeFrame();

        unsigned int getFrameSize() const { return frameSize; }
        
        void setFrameSize(const unsigned int frameSize_);
        
        IntPoint getCenter() const  { 
            unsigned int cen = frameSize/2 ; 
            return IntPoint(cen, cen, cen); 
        }
        
        index_type getMaxIndex() const { 
            return getIndex(IntPoint(frameSize-1,frameSize-1,frameSize-1));
        }

        bool isInFrame(const IntPoint& point) const;
        
        index_type getIndex(const IntPoint& point) const;
        
        IntPoint getPoint(const index_type& index) const;
        
        MoveSequence 
        indicesToAbsMoves(const std::vector<index_type> indVec) const;
        
        std::vector<index_type> getIndexedNeighborhood() const;
        
        bool    operator== (const LatticeFrame &lf2) const;
        bool    operator!= (const LatticeFrame &lf2) const;
        
    }; // class LatticeFrame

        typedef std::set<biu::LatticeFrame::index_type> IndexSet;
        typedef std::vector<biu::LatticeFrame::index_type> IndexVec;

    std::ostream & operator <<(std::ostream &os, IndexSet& x);
    std::ostream & operator <<(std::ostream &os, IndexVec& x);

}   // namespace biu

#endif /*LATTICEFRAME_HH_*/