BlockStructureDescriptor.h

/* Copyright 2018 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef COM_DAFER45_TBTK_BLOCK_STRUCTURE_DESCRIPTOR
#define COM_DAFER45_TBTK_BLOCK_STRUCTURE_DESCRIPTOR

#include "TBTK/HoppingAmplitudeSet.h"

namespace TBTK{

class BlockStructureDescriptor{
public:
    BlockStructureDescriptor();

    BlockStructureDescriptor(
        const HoppingAmplitudeSet &hoppingAmplitudeSet
    );

    unsigned int getNumBlocks() const;

    unsigned int getNumStatesInBlock(unsigned int block) const;

    unsigned int getBlockIndex(unsigned int state) const;

    unsigned int getFirstStateInBlock(unsigned int block) const;
private:
    std::vector<unsigned int> numStatesInBlock;

    std::vector<unsigned int> stateToBlockMap;

    std::vector<unsigned int> blockToStateMap;
};

inline unsigned int BlockStructureDescriptor::getNumBlocks() const{
    return numStatesInBlock.size();
}

inline unsigned int BlockStructureDescriptor::getNumStatesInBlock(
    unsigned int block
) const{
    return numStatesInBlock[block];
}

inline unsigned int BlockStructureDescriptor::getBlockIndex(
    unsigned int state
) const{
    return stateToBlockMap[state];
}

inline unsigned int BlockStructureDescriptor::getFirstStateInBlock(
    unsigned int block
) const{
    return blockToStateMap[block];
}

}; //End of namesapce TBTK

#endif