vec3.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 - 2026 NeoN authors
//
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Kokkos_Core.hpp> // IWYU pragma: keep
 
#include "NeoN/core/primitives/scalar.hpp"
#include "NeoN/core/primitives/label.hpp"
#include "NeoN/core/primitives/traits.hpp"
 
 
namespace NeoN
{
 
 
class Vec3
{
public:
 
    KOKKOS_INLINE_FUNCTION
    Vec3()
    {
        cmpts_[0] = 0.0;
        cmpts_[1] = 0.0;
        cmpts_[2] = 0.0;
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3(scalar x, scalar y, scalar z)
    {
        cmpts_[0] = x;
        cmpts_[1] = y;
        cmpts_[2] = z;
    }
 
    KOKKOS_INLINE_FUNCTION
    explicit Vec3(const scalar constValue)
    {
        cmpts_[0] = constValue;
        cmpts_[1] = constValue;
        cmpts_[2] = constValue;
    }
 
    scalar* data() { return cmpts_; }
 
    const scalar* data() const { return cmpts_; }
 
    constexpr size_t size() const { return 3; }
 
    KOKKOS_INLINE_FUNCTION
    scalar& operator[](const size_t i) { return cmpts_[i]; }
 
    KOKKOS_INLINE_FUNCTION
    scalar operator[](const size_t i) const { return cmpts_[i]; }
 
    KOKKOS_INLINE_FUNCTION
    scalar& operator()(const size_t i) { return cmpts_[i]; }
 
    KOKKOS_INLINE_FUNCTION
    scalar operator()(const size_t i) const { return cmpts_[i]; }
 
    KOKKOS_INLINE_FUNCTION
    bool operator==(const Vec3& rhs) const
    {
        return cmpts_[0] == rhs(0) && cmpts_[1] == rhs(1) && cmpts_[2] == rhs(2);
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3 operator+(const Vec3& rhs) const
    {
        return Vec3(cmpts_[0] + rhs(0), cmpts_[1] + rhs(1), cmpts_[2] + rhs(2));
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3& operator+=(const Vec3& rhs)
    {
        cmpts_[0] += rhs(0);
        cmpts_[1] += rhs(1);
        cmpts_[2] += rhs(2);
        return *this;
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3 operator-(const Vec3& rhs) const
    {
        return Vec3(cmpts_[0] - rhs(0), cmpts_[1] - rhs(1), cmpts_[2] - rhs(2));
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3& operator-=(const Vec3& rhs)
    {
        cmpts_[0] -= rhs(0);
        cmpts_[1] -= rhs(1);
        cmpts_[2] -= rhs(2);
        return *this;
    }
 
    KOKKOS_INLINE_FUNCTION
    Vec3 operator*(const scalar& rhs) const
    {
        return Vec3(cmpts_[0] * rhs, cmpts_[1] * rhs, cmpts_[2] * rhs);
    }
 
 
    KOKKOS_INLINE_FUNCTION
    Vec3 operator*(const label& rhs) const
    {
        return Vec3(cmpts_[0] * rhs, cmpts_[1] * rhs, cmpts_[2] * rhs);
    }
 
 
    KOKKOS_INLINE_FUNCTION
    Vec3& operator*=(const scalar& rhs)
    {
        cmpts_[0] *= rhs;
        cmpts_[1] *= rhs;
        cmpts_[2] *= rhs;
        return *this;
    }
 
private:
 
    scalar cmpts_[3];
};
 
 
KOKKOS_INLINE_FUNCTION
Vec3 operator*(const scalar& sclr, Vec3 rhs)
{
    rhs *= sclr;
    return rhs;
}
 
// TODO replace by compProd, innerProd, outerProd
KOKKOS_INLINE_FUNCTION
Vec3 operator*(const Vec3& lhs, Vec3 rhs)
{
    return {lhs[0] * rhs[0], lhs[1] * rhs[1], lhs[2] * rhs[2]};
}
 
KOKKOS_INLINE_FUNCTION
scalar operator&(const Vec3& lhs, Vec3 rhs)
{
    return lhs[0] * rhs[0] + lhs[1] * rhs[1] + lhs[2] * rhs[2];
}
 
KOKKOS_INLINE_FUNCTION
Vec3 operator^(const Vec3& lhs, Vec3 rhs)
{
    return {
        lhs[1] * rhs[2] - lhs[2] * rhs[1],
        lhs[2] * rhs[0] - lhs[0] * rhs[2],
        lhs[0] * rhs[1] - lhs[1] * rhs[0]
    };
}
 
KOKKOS_INLINE_FUNCTION
Vec3 cross(const Vec3& lhs, const Vec3& rhs) { return lhs ^ rhs; }
 
 
KOKKOS_INLINE_FUNCTION
Vec3 operator/(const Vec3& lhs, scalar rhs) { return {lhs[0] / rhs, lhs[1] / rhs, lhs[2] / rhs}; }
 
 
KOKKOS_INLINE_FUNCTION
scalar mag(const Vec3& vec) { return sqrt(vec[0] * vec[0] + vec[1] * vec[1] + vec[2] * vec[2]); }
 
std::ostream& operator<<(std::ostream& out, const Vec3& vec);
 
 
template<>
KOKKOS_INLINE_FUNCTION Vec3 one<Vec3>()
{
    return Vec3(1.0, 1.0, 1.0);
}
 
template<>
KOKKOS_INLINE_FUNCTION Vec3 zero<Vec3>()
{
    return Vec3(0.0, 0.0, 0.0);
}
 
template<>
KOKKOS_INLINE_FUNCTION Vec3 inv<Vec3>(Vec3 in)
{
    return Vec3(1.0 / in[0], 1.0 / in[1], 1.0 / in[2]);
}
 
 
} // namespace NeoN