|
Developer Documentation
|
Public Types | |
| typedef Scalar | value_type |
| the type of the scalar used in this template | |
| typedef VectorT< Scalar, DIM > | vector_type |
| type of this vector | |
Public Member Functions | |
| constexpr | VectorT () |
| default constructor creates uninitialized values. | |
| VectorT (const Scalar &v) | |
| template<typename ... T, typename = typename std::enable_if<sizeof...(T) == DIM>::type, typename = typename std::enable_if< are_convertible_to<Scalar, T...>::value>::type> | |
| constexpr | VectorT (T... vs) |
| VectorT (const VectorT &rhs)=default | |
| VectorT (VectorT &&rhs)=default | |
| VectorT & | operator= (const VectorT &rhs)=default |
| VectorT & | operator= (VectorT &&rhs)=default |
| template<typename S = Scalar, int D = DIM> | |
| auto | homogenized () const -> typename std::enable_if< D==4, VectorT< decltype(std::declval< S >()/std::declval< S >()), DIM > >::type |
| template<typename Iterator , typename = decltype( *std::declval<Iterator&>(), void(), ++std::declval<Iterator&>(), void())> | |
| VectorT (Iterator it) | |
| construct from a value array or any other iterator | |
| template<typename otherScalarType , typename = typename std::enable_if< std::is_convertible<otherScalarType, Scalar>::value>> | |
| VectorT (const VectorT< otherScalarType, DIM > &_rhs) | |
| copy & cast constructor (explicit) | |
| template<typename OtherScalar , typename = typename std::enable_if< std::is_convertible<OtherScalar, Scalar>::value>> | |
| vector_type & | operator= (const VectorT< OtherScalar, DIM > &_rhs) |
| cast from vector with a different scalar type | |
| Scalar * | data () |
| access to Scalar array | |
| const Scalar * | data () const |
| access to const Scalar array | |
| Scalar & | operator[] (size_t _i) |
| get i'th element read-write | |
| const Scalar & | operator[] (size_t _i) const |
| get i'th element read-only | |
| bool | operator== (const vector_type &_rhs) const |
| component-wise comparison | |
| bool | operator!= (const vector_type &_rhs) const |
| component-wise comparison | |
| template<typename OtherScalar > | |
| auto | operator*= (const OtherScalar &_s) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0] *_s), Scalar >::value, VectorT< Scalar, DIM > & >::type |
| component-wise self-multiplication with scalar | |
| template<typename OtherScalar > | |
| auto | operator/= (const OtherScalar &_s) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0]/_s), Scalar >::value, VectorT< Scalar, DIM > & >::type |
| component-wise self-division by scalar | |
| VectorT< Scalar, DIM > ::type | operator* (const OtherScalar &_s) const |
| VectorT< Scalar, DIM > ::type | operator/ (const OtherScalar &_s) const |
| template<typename OtherScalar > | |
| auto | operator*= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0] **_rhs.data()), Scalar >::value, vector_type & >::type |
| component-wise self-multiplication | |
| template<typename OtherScalar > | |
| auto | operator/= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0]/*_rhs.data()), Scalar >::value, vector_type & >::type |
| component-wise self-division | |
| template<typename OtherScalar > | |
| auto | operator-= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0] - *_rhs.data()), Scalar >::value, vector_type & >::type |
| vector difference from this | |
| template<typename OtherScalar > | |
| auto | operator+= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< std::is_convertible< decltype(this->values_[0]+ *_rhs.data()), Scalar >::value, vector_type & >::type |
| vector self-addition | |
| template<typename OtherScalar > | |
| auto | operator* (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< std::is_convertible< decltype(this->values_[0] **_rhs.data()), Scalar >::value, vector_type >::type |
| component-wise vector multiplication | |
| template<typename OtherScalar > | |
| auto | operator/ (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< std::is_convertible< decltype(this->values_[0]/*_rhs.data()), Scalar >::value, vector_type >::type |
| component-wise vector division | |
| template<typename OtherScalar > | |
| auto | operator+ (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< std::is_convertible< decltype(this->values_[0]+ *_rhs.data()), Scalar >::value, vector_type >::type |
| component-wise vector addition | |
| template<typename OtherScalar > | |
| auto | operator- (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< std::is_convertible< decltype(this->values_[0] - *_rhs.data()), Scalar >::value, vector_type >::type |
| component-wise vector difference | |
| vector_type | operator- (void) const |
| unary minus | |
| template<typename OtherScalar > | |
| auto | operator% (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< DIM==3, VectorT< decltype(this->values_[0] *_rhs[0] - this->values_[0] *_rhs[0]), DIM > >::type |
| template<typename OtherScalar > | |
| auto | cross (const VectorT< OtherScalar, DIM > &_rhs) const -> decltype(*this % _rhs) |
| template<typename OtherScalar > | |
| auto | operator| (const VectorT< OtherScalar, DIM > &_rhs) const -> decltype(*this->data() **_rhs.data()) |
| template<typename OtherScalar > | |
| auto | dot (const VectorT< OtherScalar, DIM > &_rhs) const -> decltype(*this|_rhs) |
Euclidean norm calculations | |
| template<typename S = Scalar> | |
| decltype(std::declval< S >() *std::declval< S >()) | sqrnorm () const |
| compute squared euclidean norm | |
| template<typename S = Scalar> | |
| auto | norm () const -> decltype(std::sqrt(std::declval< VectorT< S, DIM > >().sqrnorm())) |
| compute euclidean norm | |
| template<typename S = Scalar> | |
| auto | length () const -> decltype(std::declval< VectorT< S, DIM > >().norm()) |
| compute squared euclidean norm | |
| template<typename S = Scalar> | |
| auto | normalize () -> decltype(*this/=std::declval< VectorT< S, DIM > >().norm()) |
| template<typename S = Scalar> | |
| auto | normalized () const -> decltype(*this/std::declval< VectorT< S, DIM > >().norm()) |
| vector_type &::type | normalize_cond () |
| compute squared euclidean norm | |
Non-Euclidean norm calculations | |
| Scalar | l1_norm () const |
| compute L1 (Manhattan) norm | |
| Scalar | l8_norm () const |
| compute l8_norm | |
Static Public Member Functions | |
| static constexpr int | dim () |
| returns dimension of the vector (deprecated) | |
| static constexpr size_t | size () |
| returns dimension of the vector | |
Static Public Attributes | |
| static constexpr const size_t | size_ = DIM |
Private Types | |
| using | container = std::array< Scalar, DIM > |
Private Attributes | |
| container | values_ |
Component iterators | |
| using | iterator = typename container::iterator |
| using | const_iterator = typename container::const_iterator |
| using | reverse_iterator = typename container::reverse_iterator |
| using | const_reverse_iterator = typename container::const_reverse_iterator |
| iterator | begin () noexcept |
| const_iterator | begin () const noexcept |
| const_iterator | cbegin () const noexcept |
| iterator | end () noexcept |
| const_iterator | end () const noexcept |
| const_iterator | cend () const noexcept |
| reverse_iterator | rbegin () noexcept |
| const_reverse_iterator | rbegin () const noexcept |
| const_reverse_iterator | crbegin () const noexcept |
| reverse_iterator | rend () noexcept |
| const_reverse_iterator | rend () const noexcept |
| const_reverse_iterator | crend () const noexcept |
Minimum maximum and mean | |
| static vector_type | vectorized (const Scalar &_s) |
| store the same value in each component | |
| Scalar | max () const |
| return the maximal component | |
| Scalar | max_abs () const |
| return the maximal absolute component | |
| Scalar | min () const |
| return the minimal component | |
| Scalar | min_abs () const |
| return the minimal absolute component | |
| Scalar | mean () const |
| return arithmetic mean | |
| Scalar | mean_abs () const |
| return absolute arithmetic mean | |
| vector_type & | minimize (const vector_type &_rhs) |
| minimize values: same as *this = min(*this, _rhs), but faster | |
| bool | minimized (const vector_type &_rhs) |
| minimize values and signalize coordinate minimization | |
| vector_type & | maximize (const vector_type &_rhs) |
| maximize values: same as *this = max(*this, _rhs), but faster | |
| bool | maximized (const vector_type &_rhs) |
| maximize values and signalize coordinate maximization | |
| vector_type | min (const vector_type &_rhs) const |
| component-wise min | |
| vector_type | max (const vector_type &_rhs) const |
| component-wise max | |
| template<typename Functor > | |
| vector_type | apply (const Functor &_func) const |
| component-wise apply function object with Scalar operator()(Scalar). | |
| vector_type & | vectorize (const Scalar &_s) |
| store the same value in each component (e.g. to clear all entries) | |
| bool | operator< (const vector_type &_rhs) const |
| lexicographical comparison | |
| void | swap (VectorT &_other) noexcept(noexcept(std::swap(values_, _other.values_))) |
| swap with another vector | |
Definition at line 78 of file Vector11T.hh.
| using OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::const_iterator = typename container::const_iterator |
Definition at line 660 of file Vector11T.hh.
| using OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::const_reverse_iterator = typename container::const_reverse_iterator |
Definition at line 662 of file Vector11T.hh.
|
private |
Definition at line 84 of file Vector11T.hh.
| using OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::iterator = typename container::iterator |
Definition at line 659 of file Vector11T.hh.
| using OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::reverse_iterator = typename container::reverse_iterator |
Definition at line 661 of file Vector11T.hh.
| typedef Scalar OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::value_type |
the type of the scalar used in this template
Definition at line 92 of file Vector11T.hh.
| typedef VectorT<Scalar, DIM> OpenVolumeMesh::Geometry::VectorT< Scalar, DIM >::vector_type |
type of this vector
Definition at line 95 of file Vector11T.hh.
|
inlineconstexpr |
default constructor creates uninitialized values.
Definition at line 112 of file Vector11T.hh.
|
inlineexplicit |
Creates a vector with all components set to v.
Definition at line 117 of file Vector11T.hh.
|
inlineconstexpr |
Definition at line 126 of file Vector11T.hh.
|
inlineexplicit |
construct from a value array or any other iterator
Definition at line 164 of file Vector11T.hh.
|
inlineexplicit |
copy & cast constructor (explicit)
Definition at line 172 of file Vector11T.hh.
|
inline |
component-wise apply function object with Scalar operator()(Scalar).
Definition at line 623 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 665 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 664 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 666 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 670 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 674 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 678 of file Vector11T.hh.
|
inline |
cross product: only defined for Vec3* as specialization
Definition at line 382 of file Vector11T.hh.
|
inline |
access to Scalar array
Definition at line 193 of file Vector11T.hh.
|
inline |
access to const Scalar array
Definition at line 196 of file Vector11T.hh.
|
inlinestaticconstexpr |
returns dimension of the vector (deprecated)
Definition at line 98 of file Vector11T.hh.
|
inline |
compute scalar product
Definition at line 401 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 669 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 668 of file Vector11T.hh.
|
inline |
Only for 4-component vectors with division operator on their Scalar: Dehomogenization.
Definition at line 144 of file Vector11T.hh.
|
inline |
compute L1 (Manhattan) norm
Definition at line 492 of file Vector11T.hh.
|
inline |
compute l8_norm
Definition at line 498 of file Vector11T.hh.
|
inline |
compute squared euclidean norm
Definition at line 435 of file Vector11T.hh.
|
inline |
return the maximal component
Definition at line 510 of file Vector11T.hh.
|
inline |
component-wise max
Definition at line 613 of file Vector11T.hh.
|
inline |
return the maximal absolute component
Definition at line 515 of file Vector11T.hh.
|
inline |
maximize values: same as *this = max(*this, _rhs), but faster
Definition at line 580 of file Vector11T.hh.
|
inline |
maximize values and signalize coordinate maximization
Definition at line 591 of file Vector11T.hh.
|
inline |
return arithmetic mean
Definition at line 538 of file Vector11T.hh.
|
inline |
return absolute arithmetic mean
Definition at line 543 of file Vector11T.hh.
|
inline |
return the minimal component
Definition at line 524 of file Vector11T.hh.
|
inline |
component-wise min
Definition at line 608 of file Vector11T.hh.
|
inline |
return the minimal absolute component
Definition at line 529 of file Vector11T.hh.
|
inline |
minimize values: same as *this = min(*this, _rhs), but faster
Definition at line 552 of file Vector11T.hh.
|
inline |
minimize values and signalize coordinate minimization
Definition at line 563 of file Vector11T.hh.
|
inline |
compute euclidean norm
Definition at line 426 of file Vector11T.hh.
|
inline |
normalize vector, return normalized vector
Definition at line 446 of file Vector11T.hh.
|
inline |
compute squared euclidean norm
Definition at line 473 of file Vector11T.hh.
|
inline |
return normalized vector
Definition at line 457 of file Vector11T.hh.
|
inline |
component-wise comparison
Definition at line 220 of file Vector11T.hh.
|
inline |
cross product: only defined for Vec3* as specialization
Definition at line 367 of file Vector11T.hh.
|
inline |
Definition at line 256 of file Vector11T.hh.
|
inline |
component-wise vector multiplication
Definition at line 322 of file Vector11T.hh.
|
inline |
component-wise self-multiplication with scalar
Definition at line 228 of file Vector11T.hh.
|
inline |
component-wise self-multiplication
Definition at line 274 of file Vector11T.hh.
|
inline |
component-wise vector addition
Definition at line 340 of file Vector11T.hh.
|
inline |
vector self-addition
Definition at line 310 of file Vector11T.hh.
|
inline |
component-wise vector difference
Definition at line 349 of file Vector11T.hh.
|
inline |
unary minus
Definition at line 357 of file Vector11T.hh.
|
inline |
vector difference from this
Definition at line 298 of file Vector11T.hh.
|
inline |
Definition at line 266 of file Vector11T.hh.
|
inline |
component-wise vector division
Definition at line 331 of file Vector11T.hh.
|
inline |
component-wise self-division by scalar
Definition at line 240 of file Vector11T.hh.
|
inline |
component-wise self-division
Definition at line 286 of file Vector11T.hh.
|
inline |
lexicographical comparison
Definition at line 642 of file Vector11T.hh.
|
inline |
cast from vector with a different scalar type
Definition at line 183 of file Vector11T.hh.
|
inline |
component-wise comparison
Definition at line 215 of file Vector11T.hh.
|
inline |
get i'th element read-write
Definition at line 201 of file Vector11T.hh.
|
inline |
get i'th element read-only
Definition at line 207 of file Vector11T.hh.
|
inline |
compute scalar product
Definition at line 391 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 673 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 672 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 677 of file Vector11T.hh.
|
inlinenoexcept |
Definition at line 676 of file Vector11T.hh.
|
inlinestaticconstexpr |
returns dimension of the vector
Definition at line 103 of file Vector11T.hh.
|
inline |
compute squared euclidean norm
Definition at line 414 of file Vector11T.hh.
|
inlinenoexcept |
swap with another vector
Definition at line 649 of file Vector11T.hh.
|
inline |
store the same value in each component (e.g. to clear all entries)
Definition at line 631 of file Vector11T.hh.
|
inlinestatic |
store the same value in each component
Definition at line 637 of file Vector11T.hh.
|
staticconstexpr |
Definition at line 107 of file Vector11T.hh.
|
private |
Definition at line 85 of file Vector11T.hh.