EBGeometry_Vec.hpp

Go to the documentation of this file.

/* EBGeometry
 * Copyright © 2022 Robert Marskar
 * Please refer to Copyright.txt and LICENSE in the EBGeometry root directory.
 */
 
#ifndef EBGeometry_Vec
#define EBGeometry_Vec
 
// Std includes
#include <array>
#include <iostream>
 
// Our includes
#include "EBGeometry_NamespaceHeader.hpp"
 
template <typename T>
class Vec2T
{
public:
  Vec2T();
 
  Vec2T(const Vec2T& u) noexcept;
 
  constexpr Vec2T(const T& a_x, const T& a_y);
 
  ~Vec2T() = default;
 
  T x;
 
  T y;
 
  inline static constexpr Vec2T<T>
  zero() noexcept;
 
  inline static constexpr Vec2T<T>
  one() noexcept;
 
  inline static constexpr Vec2T<T>
  min() noexcept;
 
  inline static constexpr Vec2T<T>
  max() noexcept;
 
  inline static constexpr Vec2T<T>
  infinity() noexcept;
 
  inline constexpr Vec2T<T>&
  operator=(const Vec2T& a_other) noexcept;
 
  inline constexpr Vec2T<T>
  operator+(const Vec2T& a_other) const noexcept;
 
  inline constexpr Vec2T<T>
  operator-(const Vec2T& a_other) const noexcept;
 
  inline constexpr Vec2T<T>
  operator-() const noexcept;
 
  inline constexpr Vec2T<T>
  operator*(const T& s) const noexcept;
 
  inline constexpr Vec2T<T>
  operator/(const T& s) const noexcept;
 
  inline constexpr Vec2T<T>&
  operator+=(const Vec2T& a_other) noexcept;
 
  inline constexpr Vec2T<T>&
  operator-=(const Vec2T& a_other) noexcept;
 
  inline constexpr Vec2T<T>&
  operator*=(const T& s) noexcept;
 
  inline constexpr Vec2T<T>&
  operator/=(const T& s) noexcept;
 
  inline constexpr T
  dot(const Vec2T& a_other) const noexcept;
 
  inline constexpr T
  length() const noexcept;
 
  inline constexpr T
  length2() const noexcept;
};
 
template <typename T>
class Vec3T
{
public:
  friend std::ostream&
  operator<<(std::ostream& os, const Vec3T<T>& vec)
  {
    os << '(' << vec[0] << ',' << vec[1] << ',' << vec[2] << ')';
 
    return os;
  }
 
  Vec3T() noexcept;
 
  Vec3T(const Vec3T<T>& a_u) noexcept;
 
  constexpr Vec3T(const T& a_x, const T& a_y, const T& a_z) noexcept;
 
  ~Vec3T() noexcept = default;
 
  inline static constexpr Vec3T<T>
  zero() noexcept;
 
  inline static constexpr Vec3T<T>
  one() noexcept;
 
  inline static constexpr Vec3T<T>
  unit(const size_t a_dir) noexcept;
 
  inline static constexpr Vec3T<T>
  min() noexcept;
 
  inline static constexpr Vec3T<T>
  max() noexcept;
 
  inline static constexpr Vec3T<T>
  infinity() noexcept;
 
  inline constexpr bool
  lessLX(const Vec3T<T>& u) const noexcept;
 
  inline constexpr T&
  operator[](size_t i) noexcept;
 
  inline constexpr const T&
  operator[](size_t i) const noexcept;
 
  inline constexpr bool
  operator==(const Vec3T<T>& u) const noexcept;
 
  inline constexpr bool
  operator!=(const Vec3T<T>& u) const noexcept;
 
  inline constexpr bool
  operator<(const Vec3T<T>& u) const noexcept;
 
  inline constexpr bool
  operator>(const Vec3T<T>& u) const noexcept;
 
  inline constexpr bool
  operator<=(const Vec3T<T>& u) const noexcept;
 
  inline constexpr bool
  operator>=(const Vec3T<T>& u) const noexcept;
 
  inline constexpr Vec3T<T>&
  operator=(const Vec3T<T>& u) noexcept;
 
  inline constexpr Vec3T<T>
  operator+(const Vec3T<T>& u) const noexcept;
 
  inline constexpr Vec3T<T>
  operator-(const Vec3T<T>& u) const noexcept;
 
  inline constexpr Vec3T<T>
  operator-() const noexcept;
 
  inline constexpr Vec3T<T>
  operator*(const T& s) const noexcept;
 
  inline constexpr Vec3T<T>
  operator*(const Vec3T<T>& s) const noexcept;
 
  inline constexpr Vec3T<T>
  operator/(const T& s) const noexcept;
 
  inline constexpr Vec3T<T>
  operator/(const Vec3T<T>& v) const noexcept;
 
  inline constexpr Vec3T<T>&
  operator+=(const Vec3T<T>& u) noexcept;
 
  inline constexpr Vec3T<T>&
  operator-=(const Vec3T<T>& u) noexcept;
 
  inline constexpr Vec3T<T>&
  operator*=(const T& s) noexcept;
 
  inline constexpr Vec3T<T>&
  operator/=(const T& s) noexcept;
 
  inline constexpr Vec3T<T>
  min(const Vec3T<T>& u) noexcept;
 
  inline constexpr Vec3T<T>
  max(const Vec3T<T>& u) noexcept;
 
  inline constexpr Vec3T<T>
  cross(const Vec3T<T>& u) const noexcept;
 
  inline constexpr T
  dot(const Vec3T<T>& u) const noexcept;
 
  inline size_t
  minDir(const bool a_doAbs) const noexcept;
 
  inline size_t
  maxDir(const bool a_doAbs) const noexcept;
 
  inline constexpr T
  length() const noexcept;
 
  inline constexpr T
  length2() const noexcept;
 
protected:
  std::array<T, 3> m_X;
};
 
template <typename T>
inline constexpr Vec2T<T>
operator*(const T& s, const Vec2T<T>& a_other) noexcept;
 
template <typename T>
inline constexpr Vec2T<T>
operator/(const T& s, const Vec2T<T>& a_other) noexcept;
 
template <typename T>
inline Vec2T<T>
min(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
 
template <typename T>
inline Vec2T<T>
max(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
 
template <typename T>
inline T
dot(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
 
template <typename T>
inline T
length(const Vec2T<T>& v) noexcept;
 
template <class R, typename T>
inline constexpr Vec3T<T>
operator*(const R& s, const Vec3T<T>& u) noexcept;
 
template <typename T>
inline constexpr Vec3T<T>
operator*(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
 
template <class R, typename T>
inline constexpr Vec3T<T>
operator/(const R& s, const Vec3T<T>& u) noexcept;
 
template <typename T>
inline constexpr Vec3T<T>
min(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
 
template <typename T>
inline constexpr Vec3T<T>
max(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
 
template <typename T>
inline constexpr T
dot(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
 
template <typename T>
inline constexpr T
length(const Vec3T<T>& v) noexcept;
 
#include "EBGeometry_NamespaceFooter.hpp"
 
#include "EBGeometry_VecImplem.hpp"
 
#endif