HoppingAmplitudeSet.h

Go to the documentation of this file.

/* Copyright 2016 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_HOPPING_AMPLITUDE_SET
#define COM_DAFER45_TBTK_HOPPING_AMPLITUDE_SET

#include "TBTK/HoppingAmplitude.h"
#include "TBTK/HoppingAmplitudeTree.h"
#include "TBTK/IndexTree.h"
#include "TBTK/Serializable.h"
#include "TBTK/SparseMatrix.h"
#include "TBTK/Streams.h"
#include "TBTK/TBTKMacros.h"

#include <complex>
#include <vector>

namespace TBTK{

class HoppingAmplitudeSet :
    virtual public Serializable,
    private HoppingAmplitudeTree
{
public:
    using HoppingAmplitudeTree::add;
    using HoppingAmplitudeTree::getHoppingAmplitudes;
    using HoppingAmplitudeTree::getBasisIndex;
    using HoppingAmplitudeTree::getPhysicalIndex;
    using HoppingAmplitudeTree::getBasisSize;
    using HoppingAmplitudeTree::isProperSubspace;
    using HoppingAmplitudeTree::getSubspaceIndices;
    using HoppingAmplitudeTree::getSubspaceIndex;
    using HoppingAmplitudeTree::getIndexList;
    using HoppingAmplitudeTree::getIndexListMultiplePatterns;

    HoppingAmplitudeSet();

    HoppingAmplitudeSet(const std::vector<unsigned int> &capacity);

    HoppingAmplitudeSet(const std::string &serializeation, Mode mode);

    virtual ~HoppingAmplitudeSet();

    void construct();

    bool getIsConstructed() const;

    int getFirstIndexInBlock(const Index &blockIndex) const;

    int getLastIndexInBlock(const Index &blockIndex) const;

    IndexTree getIndexTree() const;

    IndexTree getIndexTree(const Index &subspace) const;

    SparseMatrix<std::complex<double>> getSparseMatrix() const;

    class Iterator;
    class ConstIterator;
private:
    template<bool isConstIterator>
    class _Iterator{
    public:
        typedef typename std::conditional<
            isConstIterator,
            const HoppingAmplitude&,
            HoppingAmplitude&
        >::type HoppingAmplitudeReferenceType;

        void operator++();

        HoppingAmplitudeReferenceType operator*();

        bool operator==(const _Iterator &rhs) const;

        bool operator!=(const _Iterator &rhs) const;

        int getMinBasisIndex() const;

        int getMaxBasisIndex() const;

        int getNumBasisIndices() const;
    private:
        typedef typename std::conditional<
            isConstIterator,
            HoppingAmplitudeTree::ConstIterator,
            HoppingAmplitudeTree::Iterator
        >::type HoppingAmplitudeTreeIteratorType;

        typedef typename std::conditional<
            isConstIterator,
            const HoppingAmplitudeTree*,
            HoppingAmplitudeTree*
        >::type HoppingAmplitudeTreePointerType;

        HoppingAmplitudeTreeIteratorType iterator;

        friend class Iterator;
        friend class ConstIterator;

        _Iterator(
            HoppingAmplitudeTreePointerType hoppingAmplitudeTree,
            bool end = false
        );
    };
public:
    class Iterator : public _Iterator<false>{
    private:
        Iterator(
            HoppingAmplitudeTree *hoppingAmplitudeTree,
            bool end = false
        ) : _Iterator<false>(hoppingAmplitudeTree, end){};

        friend class HoppingAmplitudeSet;
    };

    class ConstIterator : public _Iterator<true>{
    private:
        ConstIterator(
            const HoppingAmplitudeTree *hoppingAmplitudeTree,
            bool end = false
        ) : _Iterator<true>(hoppingAmplitudeTree, end){};

        friend class HoppingAmplitudeSet;
    };

    Iterator begin();

    ConstIterator begin() const;

    ConstIterator cbegin() const;

    Iterator begin(const Index &subspace);

    ConstIterator begin(const Index &subspace) const;

    ConstIterator cbegin(const Index &subspace) const;

    Iterator end();

    ConstIterator end() const;

    ConstIterator cend() const;

    Iterator end(const Index &subspace);

    ConstIterator end(const Index &subspace) const;

    ConstIterator cend(const Index &subspace) const;

    void print();

    void tabulate(
        std::complex<double> **amplitudes,
        int **indices,
        int *numHoppingAmplitudes,
        int *maxIndexSize
    ) const;

    virtual std::string serialize(Mode mode) const;

    unsigned int getSizeInBytes() const;
private:
    bool isConstructed;
};

inline void HoppingAmplitudeSet::construct(){
    TBTKAssert(
        !isConstructed,
        "HoppingAmplitudeSet::construct()",
        "HoppingAmplitudeSet is already constructed.",
        ""
    );

    HoppingAmplitudeTree::generateBasisIndices();
    isConstructed = true;
}

inline bool HoppingAmplitudeSet::getIsConstructed() const{
    return isConstructed;
}

inline int HoppingAmplitudeSet::getFirstIndexInBlock(
    const Index &blockIndex
) const{
    return HoppingAmplitudeTree::getFirstIndexInSubspace(blockIndex);
}

inline int HoppingAmplitudeSet::getLastIndexInBlock(
    const Index &blockIndex
) const{
    return HoppingAmplitudeTree::getLastIndexInSubspace(blockIndex);
}

inline SparseMatrix<std::complex<double>> HoppingAmplitudeSet::getSparseMatrix(
) const{
    TBTKAssert(
        isConstructed,
        "HoppingAmplitudeSet::getSparseMatrix()",
        "HoppingAmplitudeSet has to be constructed first.",
        ""
    );

    SparseMatrix<std::complex<double>> sparseMatrix(
        SparseMatrix<std::complex<double>>::StorageFormat::CSC
    );

    for(
        ConstIterator iterator = begin();
        iterator != end();
        ++iterator
    ){
        sparseMatrix.add(
            getBasisIndex((*iterator).getToIndex()),
            getBasisIndex((*iterator).getFromIndex()),
            (*iterator).getAmplitude()
        );
    }
    sparseMatrix.construct();

    return sparseMatrix;
}

inline HoppingAmplitudeSet::Iterator HoppingAmplitudeSet::begin(){
    return Iterator(this);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::begin() const{
    return ConstIterator(this);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::cbegin() const{
    return ConstIterator(this);
}

inline HoppingAmplitudeSet::Iterator HoppingAmplitudeSet::begin(
    const Index &subspace
){
    return Iterator(getSubTree(subspace));
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::begin(
    const Index &subspace
) const{
    return ConstIterator(getSubTree(subspace));
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::cbegin(
    const Index &subspace
) const{
    return ConstIterator(getSubTree(subspace));
}

inline HoppingAmplitudeSet::Iterator HoppingAmplitudeSet::end(){
    return Iterator(this, true);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::end() const{
    return ConstIterator(this, true);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::cend() const{
    return ConstIterator(this, true);
}

inline HoppingAmplitudeSet::Iterator HoppingAmplitudeSet::end(
    const Index &subspace
){
    return Iterator(getSubTree(subspace), true);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::end(
    const Index &subspace
) const{
    return ConstIterator(getSubTree(subspace), true);
}

inline HoppingAmplitudeSet::ConstIterator HoppingAmplitudeSet::cend(
    const Index &subspace
) const{
    return ConstIterator(getSubTree(subspace), true);
}

template<bool isConstIterator>
inline bool HoppingAmplitudeSet::_Iterator<isConstIterator>::operator==(
    const _Iterator &rhs
) const{
    return iterator == rhs.iterator;
}

template<bool isConstIterator>
inline bool HoppingAmplitudeSet::_Iterator<isConstIterator>::operator!=(
    const _Iterator &rhs
) const{
    return iterator != rhs.iterator;
}

inline unsigned int HoppingAmplitudeSet::getSizeInBytes() const{
    unsigned int size = sizeof(*this) - sizeof(HoppingAmplitudeTree);
    size += HoppingAmplitudeTree::getSizeInBytes();

    return size;
}

template<bool isConstIterator>
inline void HoppingAmplitudeSet::_Iterator<isConstIterator>::operator++(){
    ++iterator;
}

template<bool isConstIterator>
inline typename HoppingAmplitudeSet::_Iterator<
    isConstIterator
>::HoppingAmplitudeReferenceType HoppingAmplitudeSet::_Iterator<
    isConstIterator
>::operator*(){
    return *iterator;
}

template<bool isConstIterator>
inline int HoppingAmplitudeSet::_Iterator<isConstIterator>::getMinBasisIndex() const{
    return iterator.getMinBasisIndex();
}

template<bool isConstIterator>
inline int HoppingAmplitudeSet::_Iterator<isConstIterator>::getMaxBasisIndex() const{
    return iterator.getMaxBasisIndex();
}

template<bool isConstIterator>
inline int HoppingAmplitudeSet::_Iterator<isConstIterator>::getNumBasisIndices() const{
    return iterator.getNumBasisIndices();
}

template<bool isConstIterator>
inline HoppingAmplitudeSet::_Iterator<isConstIterator>::_Iterator(
    HoppingAmplitudeTreePointerType hoppingAmplitudeTree,
    bool end
) :
    iterator(
        (
            end ?
            hoppingAmplitudeTree->end()
            : hoppingAmplitudeTree->begin()
        )
    )
{
}

};  //End of namespace TBTK

#endif