VectorSpaceArithmetic.hpp

Go to the documentation of this file.

// This file is part of GQCG-GQCP.
//
// Copyright (C) 2017-2020  the GQCG developers
//
// GQCG-GQCP is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GQCG-GQCP is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with GQCG-GQCP.  If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
 
#include "Utilities/CRTP.hpp"
 
 
namespace GQCP {
 
 
template <typename T, typename Scalar>
class VectorSpaceArithmetic:
    public CRTP<T> {
public:
    /*
     *  MARK: Pure virtual functions
     */
 
    virtual T& operator+=(const T& rhs) = 0;
 
    virtual T& operator*=(const Scalar& a) = 0;
 
 
    /*
     *  MARK: Canonical implementations of operators
     */
 
    friend T operator+(T lhs, const T& rhs) {
        lhs += rhs;
        return lhs;
    }
 
 
    T& operator-=(const T& rhs) {
        *this += (-rhs);
        return this->derived();
    }
 
 
    friend T operator-(T lhs, const T& rhs) {
        lhs -= rhs;
        return lhs;
    }
 
 
    friend T operator*(const Scalar& a, T rhs) {
        return rhs *= a;
    }
 
 
    friend T operator*(T lhs, const Scalar& a) {
        return lhs *= a;
    }
 
    friend T operator/(T lhs, const Scalar& a) {
        return lhs *= Scalar {1} / a;
    }
 
    T operator-() const {
        return Scalar {-1} * this->derived();
    }
};
 
}  // namespace GQCP