OverlapAmplitudeSet.h

Go to the documentation of this file.

/* Copyright 2019 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_OVERLAP_AMPLITUDE_SET
#define COM_DAFER45_TBTK_OVERLAP_AMPLITUDE_SET

#include "TBTK/OverlapAmplitude.h"
#include "TBTK/IndexedDataTree.h"
#include "TBTK/Serializable.h"
#include "TBTK/TBTKMacros.h"

namespace TBTK{

class OverlapAmplitudeSet : public Serializable{
public:
    OverlapAmplitudeSet();

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

    virtual ~OverlapAmplitudeSet();

    void add(const OverlapAmplitude &overlapAmplitude);

    OverlapAmplitude& get(
        const Index &braIndex,
        const Index &ketIndex
    );

    const OverlapAmplitude& get(
        const Index &braIndex,
        const Index &ketIndex
    ) const;

    bool getAssumeOrthonormalBasis() const;

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

        void operator++();

        OverlapAmplitudeReferenceType operator*();

        bool operator==(const _Iterator &rhs);

        bool operator!=(const _Iterator &rhs);
    private:
        typedef typename std::conditional<
            isConstIterator,
            IndexedDataTree<OverlapAmplitude>::ConstIterator,
            IndexedDataTree<OverlapAmplitude>::Iterator
        >::type IteratorType;

        IteratorType iterator;

        IteratorType iteratorEnd;

        friend class Iterator;
        friend class ConstIterator;

        typedef typename std::conditional<
            isConstIterator,
            const IndexedDataTree<OverlapAmplitude>,
            IndexedDataTree<OverlapAmplitude>
        >::type OverlapAmplitudeTreeType;

        _Iterator(
            OverlapAmplitudeTreeType &overlapAmplitudeTree,
            bool end = false
        );
    };
public:
    class Iterator : public _Iterator<false>{
    private:
        Iterator(
            IndexedDataTree<
                OverlapAmplitude
            > &overlapAmplitudeTree,
            bool end = false
        ) : _Iterator(overlapAmplitudeTree, end){};

        friend class OverlapAmplitudeSet;
    };

    class ConstIterator : public _Iterator<true>{
    private:
        ConstIterator(
            const IndexedDataTree<
                OverlapAmplitude
            > &overlapAmplitudeTree,
            bool end = false
        ) : _Iterator(overlapAmplitudeTree, end){};

        friend class OverlapAmplitudeSet;
    };

    OverlapAmplitudeSet::Iterator begin();

    OverlapAmplitudeSet::ConstIterator begin() const;

    OverlapAmplitudeSet::ConstIterator cbegin() const;

    OverlapAmplitudeSet::Iterator end();

    OverlapAmplitudeSet::ConstIterator end() const;

    OverlapAmplitudeSet::ConstIterator cend() const;

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

    unsigned int getSizeInBytes() const;
private:
    IndexedDataTree<OverlapAmplitude> overlapAmplitudeTree;

    bool assumeOrthonormalBasis;
};

inline void OverlapAmplitudeSet::add(
    const OverlapAmplitude &overlapAmplitude
){
    overlapAmplitudeTree.add(
        overlapAmplitude,
        {
            overlapAmplitude.getBraIndex(),
            overlapAmplitude.getKetIndex()
        }
    );

    assumeOrthonormalBasis = false;
}

inline OverlapAmplitude& OverlapAmplitudeSet::get(
    const Index &braIndex,
    const Index &ketIndex
){
    return overlapAmplitudeTree.get({braIndex, ketIndex});
}

inline const OverlapAmplitude& OverlapAmplitudeSet::get(
    const Index &braIndex,
    const Index &ketIndex
) const{
    return overlapAmplitudeTree.get({braIndex, ketIndex});
}

inline bool OverlapAmplitudeSet::getAssumeOrthonormalBasis() const{
    return assumeOrthonormalBasis;
}

inline unsigned int OverlapAmplitudeSet::getSizeInBytes() const{
    return sizeof(this) - sizeof(overlapAmplitudeTree)
        + overlapAmplitudeTree.getSizeInBytes();
}

template<bool isConstIterator>
OverlapAmplitudeSet::_Iterator<isConstIterator>::_Iterator(
    OverlapAmplitudeTreeType &overlapAmplitudeTree,
    bool end
) :
    iterator(
        end ? overlapAmplitudeTree.end() : overlapAmplitudeTree.begin()
    ),
    iteratorEnd(overlapAmplitudeTree.end())
{
}

template<bool isConstIterator>
void OverlapAmplitudeSet::_Iterator<isConstIterator>::operator++(){
    if(iterator != iteratorEnd)
        ++iterator;
}

template<bool isConstIterator>
typename OverlapAmplitudeSet::_Iterator<
    isConstIterator
>::OverlapAmplitudeReferenceType
OverlapAmplitudeSet::_Iterator<isConstIterator>::operator*(){
    return *iterator;
}

template<bool isConstIterator>
bool OverlapAmplitudeSet::_Iterator<isConstIterator>::operator==(
    const _Iterator<isConstIterator> &rhs
){
    if(iterator == rhs.iterator)
        return true;
    else
        return false;
}

template<bool isConstIterator>
bool OverlapAmplitudeSet::_Iterator<isConstIterator>::operator!=(
    const _Iterator<isConstIterator> &rhs
){
    if(iterator != rhs.iterator)
        return true;
    else
        return false;
}

};  //End of namespace TBTK

#endif