OverlapAmplitude.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
#define COM_DAFER45_TBTK_OVERLAP_AMPLITUDE

#include "TBTK/Index.h"
#include "TBTK/PseudoSerializable.h"
#include "TBTK/Serializable.h"

#include <complex>
#include <initializer_list>
#include <vector>

namespace TBTK{

class OverlapAmplitude : public PseudoSerializable{
public:
    class AmplitudeCallback{
    public:
        virtual std::complex<double> getOverlapAmplitude(
            const Index &braIndex,
            const Index &ketIndex
        ) const = 0;
    };

    OverlapAmplitude();

    OverlapAmplitude(
        std::complex<double> amplitude,
        const Index &braIndex,
        const Index &ketIndex
    );

    OverlapAmplitude(
        const AmplitudeCallback &amplitudeCallback,
        const Index &braIndex,
        const Index &ketIndex
    );

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

    std::complex<double> getAmplitude() const;

    const Index& getBraIndex() const;

    const Index& getKetIndex() const;

    bool getIsCallbackDependent() const;

    const AmplitudeCallback& getAmplitudeCallback() const;

    std::string toString() const;

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

    unsigned int getSizeInBytes() const;
private:
    std::complex<double> amplitude;

    const AmplitudeCallback *amplitudeCallback;

    Index braIndex;

    Index ketIndex;

};

inline OverlapAmplitude::OverlapAmplitude(){
    amplitudeCallback = nullptr;
}

inline std::complex<double> OverlapAmplitude::getAmplitude() const{
    if(amplitudeCallback){
        return amplitudeCallback->getOverlapAmplitude(
            braIndex,
            ketIndex
        );
    }
    else{
        return amplitude;
    }
}

inline const Index& OverlapAmplitude::getBraIndex() const{
    return braIndex;
}

inline const Index& OverlapAmplitude::getKetIndex() const{
    return ketIndex;
}

inline bool OverlapAmplitude::getIsCallbackDependent() const{
    if(amplitudeCallback == nullptr)
        return false;
    else
        return true;
}

inline const OverlapAmplitude::AmplitudeCallback&
OverlapAmplitude::getAmplitudeCallback() const{
    if(amplitudeCallback != nullptr){
        return *amplitudeCallback;
    }
    else{
        TBTKExit(
            "OverlapAmplitude::getAmplitudeCallback()",
            "Tried to access AmplitudeCallback from an"
            << " OverlapAmplitude without an AmplitudeCallback.",
            ""
        );
    }
}

inline std::string OverlapAmplitude::toString() const{
    std::string str;
    str += "("
            + std::to_string(real(amplitude))
            + ", " + std::to_string(imag(amplitude))
        + ")"
        + ", " + braIndex.toString()
        + ", " + ketIndex.toString();

    return str;
}

inline unsigned int OverlapAmplitude::getSizeInBytes() const{
    return sizeof(OverlapAmplitude)
        - sizeof(braIndex)
        - sizeof(ketIndex)
        + braIndex.getSizeInBytes()
        + ketIndex.getSizeInBytes();
}

};  //End of namespace TBTK

#endif