HoppingAmplitude.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
#define COM_DAFER45_TBTK_HOPPING_AMPLITUDE

#include "Index.h"

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

namespace TBTK{

class HoppingAmplitude{
public:
    Index fromIndex;

    Index toIndex;

    HoppingAmplitude(
        Index fromIndex,
        Index toIndex,
        std::complex<double> amplitude
    );

    HoppingAmplitude(
        Index fromIndex,
        Index toIndex,
        std::complex<double> (*amplitudeCallback)(Index, Index)
    );

    HoppingAmplitude(
        std::complex<double> amplitude,
        Index toIndex,
        Index fromIndex
    );

    HoppingAmplitude(
        std::complex<double> (*amplitudeCallback)(Index, Index),
        Index toIndex,
        Index fromIndex
    );

    HoppingAmplitude(
        std::complex<double> amplitude,
        Index toIndex,
        Index fromIndex,
        Index toUnitCell
    );

    HoppingAmplitude(
        std::complex<double> (*amplitudeCallback)(Index, Index),
        Index toIndex,
        Index fromIndex,
        Index toUnitCell
    );

    HoppingAmplitude(const HoppingAmplitude &ha);

    HoppingAmplitude getHermitianConjugate() const;

    void print();

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

    std::complex<double> (*amplitudeCallback)(
        Index toIndex,
        Index fromIndex
    );
};

inline std::complex<double> HoppingAmplitude::getAmplitude() const{
    if(amplitudeCallback)
        return amplitudeCallback(toIndex, fromIndex);
    else
        return amplitude;
}

};  //End of namespace TBTK

#endif