NDEVR
API Documentation
Vertex< t_dims, t_type, t_vector_type >

A point in N-dimensional space, used primarily for spatial location information. More...

Inheritance diagram for Vertex< t_dims, t_type, t_vector_type >:
[legend]
Collaboration diagram for Vertex< t_dims, t_type, t_vector_type >:
[legend]

Additional Inherited Members

Public Member Functions inherited from Vector< t_dims, t_type >
template<uint01 tdims = t_dims>
constexpr Vector (const t_type &prefix, typename std::enable_if< tdims >=2, const Vector< t_dims - 1, t_type > & >::type vector)
 Creates a vector where the prefix scaler is combined with the suffix vector.
template<uint01 tdims = t_dims>
constexpr Vector (const t_type &prefix_a, const t_type &prefix_b, typename std::enable_if< tdims >=3, const Vector< tdims - 1, t_type > & >::type vector)
 Creates a vector where the prefix scaler values are combined with the suffix vector.
constexpr Vector (const t_type &scaler) noexcept
template<uint01 tdims = t_dims>
constexpr Vector (const t_type &x, const t_type &y, const t_type &z, typename std::enable_if< tdims==4, const t_type & >::type w)
 Sets values in each dimension to the respective value in the passed in scaler.
template<uint01 tdims = t_dims>
constexpr Vector (const t_type &x, const t_type &y, const typename std::enable_if< tdims==3, const t_type & >::type z)
 Sets values in each dimension to the respective value in the passed in scaler.
template<uint01 tdims = t_dims>
constexpr Vector (const t_type &x, typename std::enable_if< tdims==2, const t_type & >::type y)
 Sets values in each dimension to the respective value in the passed in scaler.
constexpr Vector (const t_type(&vector)[t_dims])
 Given a container of statically determined array, transforms it to a vector.
template<uint01 tdims = t_dims>
constexpr Vector (const Vector< getMax(tdims - 2, 0), t_type > &vector, const t_type &suffix_a, typename std::enable_if< tdims >=3, const t_type & >::type suffix_b)
 Creates a vector where the prefix vector is combined with the suffix scalers.
template<class t_vec_type>
constexpr Vector (const Vector< t_dims, t_vec_type > &vector) noexcept
template<uint01 tdims = t_dims>
constexpr Vector (const Vector< tdims - 1, t_type > &vector, typename std::enable_if< tdims >=2, const t_type & >::type suffix)
 Creates a vector where the prefix vector is combined with the suffix scalers.
template<class t_new_type>
constexpr decltype(auto) as () const
 Returns the vector as a new time of vector.
template<LocationValues t_max_min>
constexpr uint01 dimensionalIndex () const
 Used with template arguments MAX or MIN, Gets the dimensional index for the value that is either max or min.
template<LocationValues t_max_min>
constexpr t_type dimensionalValue () const
 Used with template arguments MAX or MIN, Gets the dimensional value for the value that is either max or min.
template<class t_magnitude_type = t_type>
constexpr t_magnitude_type magnitude () const
 Vectors are commonly used to model forces such as wind, sea current, gravity, and electromagnetism.
constexpr t_type magnitudeSquared () const
 Vectors are commonly used to model forces such as wind, sea current, gravity, and electromagnetism.
template<class t_norm_type = t_type>
constexpr Vector< t_dims, t_norm_type > normalized (Vector< t_dims, t_norm_type > value_if_nan=Constant< Vector< t_dims, t_norm_type > >::Invalid) const
 Gets the normalized, or unit length representation of this vector.
template<uint01 tdims = t_dims, typename = typename std::enable_if<tdims == 1>::type>
constexpr operator t_type & ()
 For Single dimensional objects, they may also be considered a scaler, thus allow implicit conversion from a vector to a scaler when the dimension of the vector is 1.
constexpr Vector< t_dims, t_type > operator- () const
 Negation operator.
constexpr Vector< t_dims, t_type > & operator= (const t_type &scaler)
 Assignment operator.
constexpr t_type & operator[] (uint01 dimension_index)
 Accesses the value of a certain dimension.
constexpr t_type product () const
 Returns the product, or value of each dimension multiplied together.
constexpr t_type sum () const
 Returns the sum, or value of each dimension added together.
Static Public Member Functions inherited from Vector< t_dims, t_type >
static constexpr uint01 NumberOfDimensions ()
 Number of dimensions in this vector class.
static constexpr t_type Type ()
 Returns the type of this class.
Protected Attributes inherited from Vector< t_dims, t_type >
t_type m_values [t_dims]
 The values[t dims].

Detailed Description

template<uint01 t_dims, class t_type, class t_vector_type = Vector<t_dims, t_type>>
class Vertex< t_dims, t_type, t_vector_type >

A point in N-dimensional space, used primarily for spatial location information.


See also
Vector, Ray, Bounds, LineSegment

Definition at line 43 of file Vertex.hpp.


The documentation for this class was generated from the following file: