TransmissionRate.h

/* 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_TRANSMISSION_RATE
#define COM_DAFER45_TBTK_TRANSMISSION_RATE

#include "TBTK/Property/EnergyResolvedProperty.h"

namespace TBTK{
namespace Property{

class TransmissionRate : public EnergyResolvedProperty<double>{
public:
    TransmissionRate(double lowerBound, double upperBound, int resolution);

    TransmissionRate(
        double lowerBound,
        double upperBound,
        int resolution,
        const double *data
    );

    TransmissionRate(const std::string &serialization, Mode mode);

    TransmissionRate& operator+=(const TransmissionRate &rhs);

    TransmissionRate operator+(const TransmissionRate &rhs) const;

    TransmissionRate& operator-=(const TransmissionRate &rhs);

    TransmissionRate operator-(const TransmissionRate &rhs) const;

    TransmissionRate& operator*=(const TransmissionRate &rhs);

    TransmissionRate operator*(const TransmissionRate &rhs) const;

    TransmissionRate& operator*=(const double &rhs);

    TransmissionRate operator*(const double &rhs) const;

    friend TransmissionRate operator*(
        const double &lhs,
        const TransmissionRate &rhs
    ){
        return rhs*lhs;
    }

    TransmissionRate& operator/=(const TransmissionRate &rhs);

    TransmissionRate operator/(const TransmissionRate &rhs) const;

    TransmissionRate& operator/=(const double &rhs);

    TransmissionRate operator/(const double &rhs) const;

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

inline TransmissionRate& TransmissionRate::operator+=(
    const TransmissionRate &rhs
){
    EnergyResolvedProperty::operator+=(rhs);

    return *this;
}

inline TransmissionRate TransmissionRate::operator+(
    const TransmissionRate &rhs
) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate += rhs;
}

inline TransmissionRate& TransmissionRate::operator-=(
    const TransmissionRate &rhs
){
    EnergyResolvedProperty::operator-=(rhs);

    return *this;
}

inline TransmissionRate TransmissionRate::operator-(
    const TransmissionRate &rhs
) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate -= rhs;
}

inline TransmissionRate TransmissionRate::operator*(
    const TransmissionRate &rhs
) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate *= rhs;
}

inline TransmissionRate& TransmissionRate::operator*=(const double &rhs){
    EnergyResolvedProperty::operator*=(rhs);

    return *this;
}

inline TransmissionRate TransmissionRate::operator*(const double &rhs) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate *= rhs;
}

inline TransmissionRate TransmissionRate::operator/(
    const TransmissionRate &rhs
) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate /= rhs;
}

inline TransmissionRate& TransmissionRate::operator/=(const double &rhs){
    EnergyResolvedProperty::operator/=(rhs);

    return *this;
}

inline TransmissionRate TransmissionRate::operator/(const double &rhs) const{
    TransmissionRate transmissionRate = *this;

    return transmissionRate /= rhs;
}

};  //End namespace Property
};  //End namespace TBTK

#endif