vector.hpp

/*
 Copyright (c) 2026 ETIB Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
#pragma once
 
#include <cmath>
#include <stdexcept>
#include <string>
#include <type_traits>
#include <utility>
#include <ostream>
 
#include <glm/exponential.hpp>
#include <glm/geometric.hpp>
#include <glm/vector_relational.hpp>
 
#include <glm/vec2.hpp>
#include <glm/vec3.hpp>
#include <glm/vec4.hpp>
 
// Basic macros for component access - can be used for readability in client
// code
#define VEC_X 0
#define VEC_Y 1
#define VEC_Z 2
#define VEC_W 3
 
namespace utility::math
{
 
    using glm::cross;
    using glm::distance;
    using glm::dot;
    using glm::faceforward;
    using glm::length;
    using glm::normalize;
    using glm::reflect;
    using glm::refract;
 
    using glm::exp;
    using glm::exp2;
    using glm::inversesqrt;
    using glm::log;
    using glm::log2;
    using glm::pow;
    using glm::sqrt;
 
    template<typename Type>
    concept CanBeVectorComponent =
        std::is_floating_point_v<Type> || std::is_integral_v<Type>;
 
    template<CanBeVectorComponent VectorComponentType,
             std::size_t VectorDimension>
    class Vector: public glm::vec<VectorDimension, VectorComponentType>
    {
        public:
        Vector(void)
            : glm::vec<VectorDimension, VectorComponentType>(0)
        {
        }
 
        explicit Vector(const glm::vec<VectorDimension, VectorComponentType> &v)
            : glm::vec<VectorDimension, VectorComponentType>(v)
        {
        }
 
        Vector(std::initializer_list<VectorComponentType> values)
        {
            if (values.size() != VectorDimension) {
                throw std::invalid_argument("Vector requires exactly "
                                            + std::to_string(VectorDimension)
                                            + " components");
            }
            const auto it = values.begin();
            for (std::size_t i = 0; i < VectorDimension; ++i) {
                (*this)[i] = *(it + i);
            }
        }
 
        explicit Vector(VectorComponentType value)
            : glm::vec<VectorDimension, VectorComponentType>(value)
        {
        }
 
        Vector(const Vector &other) = default;
 
        Vector(Vector &&other) noexcept = default;
 
        ~Vector(void) = default;
 
        Vector &operator=(const Vector &other) = default;
 
        Vector &operator=(Vector &&other) noexcept = default;
 
        Vector operator+(const Vector &rhs) const noexcept
        {
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                + static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs));
        }
 
        Vector &operator+=(const Vector &rhs) noexcept
        {
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) +=
                static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs);
            return *this;
        }
 
        Vector operator-(const Vector &rhs) const noexcept
        {
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                - static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs));
        }
 
        Vector &operator-=(const Vector &rhs) noexcept
        {
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) -=
                static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs);
            return *this;
        }
 
        Vector operator*(VectorComponentType scalar) const noexcept
        {
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                * scalar);
        }
 
        Vector &operator*=(VectorComponentType scalar) noexcept
        {
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) *= scalar;
            return *this;
        }
 
        Vector operator/(VectorComponentType scalar) const
        {
            if (scalar == VectorComponentType { 0 }) {
                throw std::invalid_argument("Vector division by zero");
            }
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                / scalar);
        }
 
        Vector &operator/=(VectorComponentType scalar)
        {
            if (scalar == VectorComponentType { 0 }) {
                throw std::invalid_argument("Vector division by zero");
            }
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) /= scalar;
            return *this;
        }
 
        Vector operator*(const Vector &rhs) const noexcept
        {
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                * static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs));
        }
 
        Vector &operator*=(const Vector &rhs) noexcept
        {
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) *=
                static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs);
            return *this;
        }
 
        Vector operator/(const Vector &rhs) const
        {
            for (std::size_t i = 0; i < VectorDimension; ++i) {
                if (rhs[i] == VectorComponentType { 0 }) {
                    throw std::invalid_argument("Vector division by zero");
                }
            }
            return Vector(
                static_cast<const glm::vec<VectorDimension, VectorComponentType>
                                &>(*this)
                / static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs));
        }
 
        Vector &operator/=(const Vector &rhs)
        {
            for (std::size_t i = 0; i < VectorDimension; ++i) {
                if (rhs[i] == VectorComponentType { 0 }) {
                    throw std::invalid_argument("Vector division by zero");
                }
            }
            *static_cast<glm::vec<VectorDimension, VectorComponentType> *>(
                this) /=
                static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    rhs);
            return *this;
        }
 
        bool operator==(const Vector &rhs) const noexcept
        {
            return static_cast<
                       const glm::vec<VectorDimension, VectorComponentType> &>(
                       *this)
                == static_cast<
                       const glm::vec<VectorDimension, VectorComponentType> &>(
                       rhs);
        }
 
        bool equalsEpsilon(const Vector &rhs,
                           VectorComponentType epsilon = VectorComponentType {
                               1e-5 }) const
        {
            for (std::size_t i = 0; i < VectorDimension; ++i) {
                if (std::abs((*this)[i] - rhs[i]) > epsilon) {
                    return false;
                }
            }
            return true;
        }
 
        bool operator!=(const Vector &rhs) const noexcept
        {
            return !(*this == rhs);
        }
 
        Vector operator-() const noexcept
        {
            return Vector(
                -static_cast<
                    const glm::vec<VectorDimension, VectorComponentType> &>(
                    *this));
        }
 
        friend Vector operator*(VectorComponentType scalar, const Vector &vec)
        {
            return vec * scalar;
        }
    };
 
    template<CanBeVectorComponent VectorComponentType,
             std::size_t VectorDimension>
    VectorComponentType
        dot(const Vector<VectorComponentType, VectorDimension> &lhs,
            const Vector<VectorComponentType, VectorDimension> &rhs)
    {
        return glm::dot(
            static_cast<const glm::vec<VectorDimension, VectorComponentType> &>(
                lhs),
            static_cast<const glm::vec<VectorDimension, VectorComponentType> &>(
                rhs));
    }
 
    template<CanBeVectorComponent VectorComponentType>
    Vector<VectorComponentType, 3>
        cross(const Vector<VectorComponentType, 3> &lhs,
              const Vector<VectorComponentType, 3> &rhs)
    {
        return Vector<VectorComponentType, 3>(glm::cross(
            static_cast<const glm::vec<3, VectorComponentType> &>(lhs),
            static_cast<const glm::vec<3, VectorComponentType> &>(rhs)));
    }
 
    template<CanBeVectorComponent VectorComponentType,
             std::size_t VectorDimension>
    Vector<VectorComponentType, VectorDimension>
        normalize(const Vector<VectorComponentType, VectorDimension> &vector)
    {
        return Vector<VectorComponentType, VectorDimension>(glm::normalize(
            static_cast<const glm::vec<VectorDimension, VectorComponentType> &>(
                vector)));
    }
 
    using Vector2F = Vector<float, 2>;
 
    using Vector2D = Vector<double, 2>;
 
    using Vector2I = Vector<int, 2>;
 
    using Vector2UI = Vector<unsigned int, 2>;
 
    using Vector3F = Vector<float, 3>;
 
    using Vector3D = Vector<double, 3>;
 
    using Vector3I = Vector<int, 3>;
 
    using Vector3UI = Vector<unsigned int, 3>;
 
    using Vector4F = Vector<float, 4>;
 
    using Vector4D = Vector<double, 4>;
 
    using Vector4I = Vector<int, 4>;
 
    using Vector4UI = Vector<unsigned int, 4>;
 
    std::ostream &operator<<(std::ostream &stream, const Vector2F &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector2D &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector2I &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector2UI &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector3F &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector3D &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector3I &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector3UI &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector4F &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector4D &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector4I &vector);
 
    std::ostream &operator<<(std::ostream &stream, const Vector4UI &vector);
 
}    // namespace utility::math