main page namespaces classes files
BIU home

src/biu/LatticeDescriptor.hh

Go to the documentation of this file.

#ifndef LATTICEDESCRIPTOR_H_
#define LATTICEDESCRIPTOR_H_


#include <string>
#include <vector>
#include "LatticeNeighborhood.hh"

namespace biu
{
    // this definition can potentially improve performance
    // but can be saved by allowing Matrix<T> * vector<T> multiplication
    // and implicit castings IntPoint <-> vector<int>.
    // anyway this should be moved to IntPoint definition
    // or inside of class LatticeModel as private Method
    // /*! matrix point multiplication without typecast */
    // IntPoint operator*(const biu::Automorphism& am, const biu::IntPoint& p);
    
    class LatticeDescriptor {

    private:        

        std::string name;           
    protected:
        
        AutomorphismVec automorphisms;  
        IPointVec       latBase;        
        MoveAlphabet*   moveAlphabet;   
        LatticeNeighborhood*    latNeighborhood;
        
        std::vector<MoveSequence>   symMoveReplacement;
        

        struct NeighborData { 
            const char *name;       
            int vec[3];       
            int mat[3][3];    
            int invmat[3][3]; 
        };
        
        struct AutomorphismData {
            int _0[3];
            int _1[3];
            int _2[3];
        };

        virtual const NeighborData* getNeighborData() const = 0;
        
        virtual unsigned int getNeighborDataSize() const = 0; 

        virtual const AutomorphismData* getAutomorphismData() const = 0;
        
        virtual unsigned int getAutomorphismDataSize() const = 0; 

        
        void initNeighborhood(); 
        
        void initAutomorphisms();
        
    public:
    
        LatticeDescriptor(const std::string& name_);
        LatticeDescriptor(const LatticeDescriptor& toCopy);
        virtual ~LatticeDescriptor();
        
        const Alphabet* const getAlphabet() const { 
            return moveAlphabet; 
        }

        virtual std::string  getName() const;
        
        virtual const LatticeNeighborhood&  getNeighborhood() const;

        virtual bool areNeighbored( const IntPoint &first, 
                                    const IntPoint &second ) const;
        
        virtual const IPointVec&    getBase() const;

        virtual const AutomorphismVec&  getAutomorphisms() const;

        virtual std::string getString(const MoveSequence& moveSeq) const;

        virtual MoveSequence getSequence(const std::string& moveString) const;
        
        virtual MoveSequence normalizeSequence(const MoveSequence& moveSeq) const;
        
        virtual LatticeDescriptor& operator= (const LatticeDescriptor &ld2);

        bool    operator== (const LatticeDescriptor &ld2) const;
        bool    operator!= (const LatticeDescriptor &ld2) const;
        
    };
    
}

#include "LatticeDescriptor.icc"

#endif /*LATTICEDESCRIPTOR_H_*/