EBGeometry
Compact, header-only C++ library for fast evaluation of signed distance functions
Loading...
Searching...
No Matches
EBGeometry_Vec.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2022 Robert Marskar <robert.marskar@sintef.no>
2//
3// SPDX-License-Identifier: GPL-3.0-or-later
4
12#ifndef EBGEOMETRY_VEC_HPP
13#define EBGEOMETRY_VEC_HPP
14
15// Std includes
16#include <algorithm>
17#include <array>
18#include <cstddef>
19#include <limits>
20#include <ostream>
21#include <type_traits>
22
23// Our includes
24#include "EBGeometry_Macros.hpp"
25
26namespace EBGeometry {
27
35template <typename T>
36class Vec2T
37{
38public:
39 static_assert(std::is_floating_point_v<T>, "Vec2T<T>: T must be a floating-point type");
43 constexpr Vec2T() noexcept;
44
50 constexpr Vec2T(const Vec2T& u) noexcept = default;
51
58 constexpr Vec2T(const T& a_x, const T& a_y) noexcept;
59
63 ~Vec2T() = default;
64
68 T x;
69
73 T y;
74
79 [[nodiscard]] inline static constexpr Vec2T<T>
80 zeros() noexcept;
81
86 [[nodiscard]] inline static constexpr Vec2T<T>
87 ones() noexcept;
88
93 [[nodiscard]] inline static constexpr Vec2T<T>
94 min() noexcept;
95
100 [[nodiscard]] inline static constexpr Vec2T<T>
101 max() noexcept;
102
107 [[nodiscard]] inline static constexpr Vec2T<T>
108 infinity() noexcept;
109
115 constexpr Vec2T<T>&
116 operator=(const Vec2T& a_other) noexcept = default;
117
123 [[nodiscard]] inline constexpr Vec2T<T>
124 operator+(const Vec2T& a_other) const noexcept;
125
131 [[nodiscard]] inline constexpr Vec2T<T>
132 operator-(const Vec2T& a_other) const noexcept;
133
138 [[nodiscard]] inline constexpr Vec2T<T>
139 operator-() const noexcept;
140
146 [[nodiscard]] inline constexpr Vec2T<T>
147 operator*(const T& s) const noexcept;
148
154 [[nodiscard]] inline constexpr Vec2T<T>
155 operator/(const T& s) const noexcept;
156
162 inline constexpr Vec2T<T>&
163 operator+=(const Vec2T& a_other) noexcept;
164
170 inline constexpr Vec2T<T>&
171 operator-=(const Vec2T& a_other) noexcept;
172
178 inline constexpr Vec2T<T>&
179 operator*=(const T& s) noexcept;
180
186 inline constexpr Vec2T<T>&
187 operator/=(const T& s) noexcept;
188
194 [[nodiscard]] inline constexpr T
195 dot(const Vec2T& a_other) const noexcept;
196
202 [[nodiscard]] inline constexpr T
203 length() const noexcept;
204
210 [[nodiscard]] inline constexpr T
211 length2() const noexcept;
212};
213
223template <typename T>
224class Vec3T
225{
226public:
227 static_assert(std::is_floating_point_v<T>, "Vec3T<T>: T must be a floating-point type");
228
235 friend std::ostream&
236 operator<<(std::ostream& os, const Vec3T<T>& vec)
237 {
238 os << '(' << vec[0] << ',' << vec[1] << ',' << vec[2] << ')';
239
240 return os;
241 }
242
246 constexpr Vec3T() noexcept;
247
253 constexpr Vec3T(const Vec3T<T>& a_u) noexcept = default;
254
262 constexpr Vec3T(const T& a_x, const T& a_y, const T& a_z) noexcept;
263
267 ~Vec3T() noexcept = default;
268
273 [[nodiscard]] inline static constexpr Vec3T<T>
274 zeros() noexcept;
275
280 [[nodiscard]] inline static constexpr Vec3T<T>
281 ones() noexcept;
282
288 [[nodiscard]] inline static constexpr Vec3T<T>
289 unit(const size_t a_dir) noexcept;
290
295 [[nodiscard]] inline static constexpr Vec3T<T>
296 min() noexcept;
297
302 [[nodiscard]] inline static constexpr Vec3T<T>
303 max() noexcept;
304
309 [[nodiscard]] inline static constexpr Vec3T<T>
310 infinity() noexcept;
311
320 [[nodiscard]] inline constexpr bool
321 lessLX(const Vec3T<T>& u) const noexcept;
322
328 inline constexpr T&
329 operator[](size_t i) noexcept;
330
336 [[nodiscard]] inline constexpr const T&
337 operator[](size_t i) const noexcept;
338
344 [[nodiscard]] inline constexpr bool
345 operator==(const Vec3T<T>& u) const noexcept;
346
352 [[nodiscard]] inline constexpr bool
353 operator!=(const Vec3T<T>& u) const noexcept;
354
363 [[nodiscard]] inline constexpr bool
364 operator<(const Vec3T<T>& u) const noexcept;
365
373 [[nodiscard]] inline constexpr bool
374 operator>(const Vec3T<T>& u) const noexcept;
375
384 [[nodiscard]] inline constexpr bool
385 operator<=(const Vec3T<T>& u) const noexcept;
386
395 [[nodiscard]] inline constexpr bool
396 operator>=(const Vec3T<T>& u) const noexcept;
397
403 constexpr Vec3T<T>&
404 operator=(const Vec3T<T>& u) noexcept = default;
405
411 [[nodiscard]] inline constexpr Vec3T<T>
412 operator+(const Vec3T<T>& u) const noexcept;
413
419 [[nodiscard]] inline constexpr Vec3T<T>
420 operator-(const Vec3T<T>& u) const noexcept;
421
426 [[nodiscard]] inline constexpr Vec3T<T>
427 operator+() const noexcept;
428
433 [[nodiscard]] inline constexpr Vec3T<T>
434 operator-() const noexcept;
435
442 [[nodiscard]] inline constexpr Vec3T<T>
443 operator*(const T& s) const noexcept;
444
451 [[nodiscard]] inline constexpr Vec3T<T>
452 operator*(const Vec3T<T>& s) const noexcept;
453
459 [[nodiscard]] inline constexpr Vec3T<T>
460 operator/(const T& s) const noexcept;
461
467 [[nodiscard]] inline constexpr Vec3T<T>
468 operator/(const Vec3T<T>& v) const noexcept;
469
476 inline constexpr Vec3T<T>&
477 operator+=(const Vec3T<T>& u) noexcept;
478
485 inline constexpr Vec3T<T>&
486 operator-=(const Vec3T<T>& u) noexcept;
487
494 inline constexpr Vec3T<T>&
495 operator*=(const T& s) noexcept;
496
503 inline constexpr Vec3T<T>&
504 operator/=(const T& s) noexcept;
505
511 [[nodiscard]] inline constexpr Vec3T<T>
512 cross(const Vec3T<T>& u) const noexcept;
513
519 [[nodiscard]] inline constexpr T
520 dot(const Vec3T<T>& u) const noexcept;
521
527 [[nodiscard]] inline size_t
528 minDir(const bool a_doAbs) const noexcept;
529
537 [[nodiscard]] inline size_t
538 maxDir(const bool a_doAbs) const noexcept;
539
544 [[nodiscard]] inline constexpr T
545 length() const noexcept;
546
551 [[nodiscard]] inline constexpr T
552 length2() const noexcept;
553
554protected:
558 std::array<T, 3> m_X;
559};
560
568template <typename T>
569[[nodiscard]] inline constexpr Vec2T<T>
570operator*(const T& s, const Vec2T<T>& a_other) noexcept;
571
580template <typename T>
581[[nodiscard]] inline constexpr Vec2T<T>
582operator/(const T& s, const Vec2T<T>& a_other) noexcept;
583
591template <typename T>
592[[nodiscard]] inline Vec2T<T>
593min(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
594
602template <typename T>
603[[nodiscard]] inline Vec2T<T>
604max(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
605
613template <typename T>
614[[nodiscard]] inline T
615dot(const Vec2T<T>& u, const Vec2T<T>& v) noexcept;
616
623template <typename T>
624[[nodiscard]] inline T
625length(const Vec2T<T>& v) noexcept;
626
635template <class R, typename T>
636[[nodiscard]] inline constexpr Vec3T<T>
637operator*(const R& s, const Vec3T<T>& u) noexcept;
638
646template <typename T>
647[[nodiscard]] inline constexpr Vec3T<T>
648operator*(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
649
659template <class R, typename T>
660[[nodiscard]] inline constexpr Vec3T<T>
661operator/(const R& s, const Vec3T<T>& u) noexcept;
662
670template <typename T>
671[[nodiscard]] inline constexpr Vec3T<T>
672min(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
673
681template <typename T>
682[[nodiscard]] inline constexpr Vec3T<T>
683max(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
684
693template <typename T>
694[[nodiscard]] inline constexpr Vec3T<T>
695clamp(const Vec3T<T>& v, const Vec3T<T>& lo, const Vec3T<T>& hi) noexcept;
696
704template <typename T>
705[[nodiscard]] inline constexpr T
706dot(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
707
715template <typename T>
716[[nodiscard]] inline constexpr Vec3T<T>
717cross(const Vec3T<T>& u, const Vec3T<T>& v) noexcept;
718
725template <typename T>
726[[nodiscard]] inline constexpr T
727length(const Vec3T<T>& v) noexcept;
728
729} // namespace EBGeometry
730
731#include "EBGeometry_VecImplem.hpp"
732
733#endif
EBGeometry_Macros.hpp
Utility macros for EBGeometry.
EBGeometry::Vec2T
Two-dimensional vector class with arithmetic operators.
Definition EBGeometry_Vec.hpp:37
EBGeometry::Vec2T::dot
constexpr T dot(const Vec2T &a_other) const noexcept
Dot product.
EBGeometry::Vec2T::y
T y
Second component in the vector.
Definition EBGeometry_Vec.hpp:73
EBGeometry::Vec2T::infinity
static constexpr Vec2T< T > infinity() noexcept
Return a vector with infinite components.
EBGeometry::Vec2T::x
T x
First component in the vector.
Definition EBGeometry_Vec.hpp:68
EBGeometry::Vec2T::zeros
static constexpr Vec2T< T > zeros() noexcept
Return av vector with x = y = 0.
EBGeometry::Vec2T::length2
constexpr T length2() const noexcept
Compute square of vector.
EBGeometry::Vec2T::min
static constexpr Vec2T< T > min() noexcept
Return the most-negative representable vector.
EBGeometry::Vec2T::length
constexpr T length() const noexcept
Compute length of vector.
EBGeometry::Vec2T::max
static constexpr Vec2T< T > max() noexcept
Return the most-positive representable vector.
EBGeometry::Vec2T::Vec2T
constexpr Vec2T() noexcept
Default constructor. Sets the vector to the zero vector.
EBGeometry::Vec2T::ones
static constexpr Vec2T< T > ones() noexcept
Return a vector with x = y = 1.
EBGeometry::Vec3T
Three-dimensional vector class with arithmetic operators.
Definition EBGeometry_Vec.hpp:225
EBGeometry::Vec3T::Vec3T
constexpr Vec3T() noexcept
Default constructor. Sets the vector to the zero vector.
EBGeometry
Namespace containing all of EBGeometry's functionality.
Definition EBGeometry_AnalyticDistanceFunctions.hpp:31
EBGeometry::clamp
constexpr Vec3T< T > clamp(const Vec3T< T > &v, const Vec3T< T > &lo, const Vec3T< T > &hi) noexcept
Component-wise clamp of a 3D vector.
EBGeometry::cross
constexpr Vec3T< T > cross(const Vec3T< T > &u, const Vec3T< T > &v) noexcept
Cross product of two 3D vectors.
Generated by doxygen 1.9.8