#include <OpenMesh/Core/Math/VectorT.hh>

Inheritance diagram for OpenMesh::VectorT< Scalar, DIM >:

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
template<typename T , typename ... Ts, typename = typename std::enable_if<sizeof...(Ts)+1 == DIM>::type, typename = typename std::enable_if< are_convertible_to<Scalar, T, Ts...>::value>::type>
constexpr	VectorT (T v, Ts... vs)

constexpr	VectorT ()
	default constructor creates uninitialized values.

	VectorT (const Scalar &v)

	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

	VectorT (container &&_array)
	construct from an array

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

template<typename OtherScalar >
std::enable_if< std::is_convertible< decltype(std::declval< Scalar >) *std::declval< OtherScalar >)), Scalar >::value, VectorT< Scalar, DIM > >::type	operator* (const OtherScalar &_s) const
	component-wise multiplication with scalar

template<typename OtherScalar >
std::enable_if< std::is_convertible< decltype(std::declval< Scalar >)/std::declval< OtherScalar >)), Scalar >::value, VectorT< Scalar, DIM > >::type	operator/ (const OtherScalar &_s) const
	component-wise division by with scalar

template<typename OtherScalar >
auto	operator= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< sizeof(decltype(this->values_[0] *_rhs.data())) >=0
	component-wise self-multiplication

template<typename OtherScalar >
auto	operator/= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< sizeof(decltype(this->values_[0]/*_rhs.data())) >=0
	component-wise self-division

template<typename OtherScalar >
auto	operator-= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< sizeof(decltype(this->values_[0] - *_rhs.data())) >=0
	vector difference from this

template<typename OtherScalar >
auto	operator+= (const VectorT< OtherScalar, DIM > &_rhs) -> typename std::enable_if< sizeof(decltype(this->values_[0]+ *_rhs.data())) >=0
	vector self-addition

template<typename OtherScalar >
auto	operator* (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< sizeof(decltype(this->values_[0] **_rhs.data())) >=0
	component-wise vector multiplication

template<typename OtherScalar >
auto	operator/ (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< sizeof(decltype(this->values_[0]/*_rhs.data())) >=0
	component-wise vector division

template<typename OtherScalar >
auto	operator+ (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< sizeof(decltype(this->values_[0]+ *_rhs.data())) >=0
	component-wise vector addition

template<typename OtherScalar >
auto	operator- (const VectorT< OtherScalar, DIM > &_rhs) const -> typename std::enable_if< sizeof(decltype(this->values_[0] - *_rhs.data())) >=0
	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)[0] _rhs[0] -(this)[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)

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

template<>
VectorT< float, 3 >	operator% (const VectorT< float, 3 > &_rhs) const
	cross product for Vec3f

template<>
VectorT< double, 3 >	operator% (const VectorT< double, 3 > &_rhs) const
	cross product for Vec3d

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())

template<typename S = Scalar>
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

Minimum maximum and mean
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

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 vector_type	vectorized (const Scalar &_s)
	store the same value in each component

Static Public Attributes
static constexpr const size_t	size_ = DIM

Private Types
using	container = std::array< Scalar, DIM >

Private Attributes
container	values_

Related Functions
(Note that these are not member functions.)
template<typename Scalar , int DIM>
Scalar	dot (const VectorT< Scalar, DIM > &_v1, const VectorT< Scalar, DIM > &_v2)

template<typename LScalar , typename RScalar , int DIM>
auto	cross (const VectorT< LScalar, DIM > &_v1, const VectorT< RScalar, DIM > &_v2) -> decltype(_v1 % _v2)

template<typename Scalar , int DIM>
void	swap (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2) noexcept(noexcept(_v1.swap(_v2)))

template<typename Scalar , int DIM>
Scalar	norm (const VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM>
Scalar	sqrnorm (const VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM, typename OtherScalar >
VectorT< Scalar, DIM > &	vectorize (VectorT< Scalar, DIM > &_v, OtherScalar const &_val)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	normalize (VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	maximize (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	minimize (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM >	max (const VectorT< Scalar, DIM > &_v1, const VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM >	min (const VectorT< Scalar, DIM > &_v1, const VectorT< Scalar, DIM > &_v2)

template<typename Scalar1 , typename Scalar2 , int N>
VectorT< Scalar1, N >	operator* (Scalar2 _s, const VectorT< Scalar1, N > &_v)

template<typename Scalar , int N>
Scalar	dot (const VectorT< Scalar, N > &_v1, const VectorT< Scalar, N > &_v2)

template<typename Scalar , int N>
VectorT< Scalar, N >	cross (const VectorT< Scalar, N > &_v1, const VectorT< Scalar, N > &_v2)

template<typename Scalar , int DIM>
Scalar	norm (const VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM>
Scalar	sqrnorm (const VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM, typename OtherScalar >
VectorT< Scalar, DIM > &	vectorize (VectorT< Scalar, DIM > &_v, OtherScalar const &_val)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	normalize (VectorT< Scalar, DIM > &_v)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	maximize (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM > &	minimize (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM >	max (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

template<typename Scalar , int DIM>
VectorT< Scalar, DIM >	min (VectorT< Scalar, DIM > &_v1, VectorT< Scalar, DIM > &_v2)

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

Detailed Description

template<typename Scalar, int DIM>
class OpenMesh::VectorT< Scalar, DIM >

A vector is an array of <N> values of type <Scalar>. The actual data is stored in an VectorDataT, this class just adds the necessary operators.

Definition at line 83 of file Vector11T.hh.

Constructor & Destructor Documentation

◆ VectorT()

template<typename Scalar, int DIM>

OpenMesh::VectorT< Scalar, DIM >::VectorT ( const Scalar & v )

inlineexplicit

Creates a vector with all components set to v.

Definition at line 134 of file Vector11T.hh.

Member Function Documentation

◆ cross()

template<typename Scalar, int DIM>

template<typename OtherScalar >

auto OpenMesh::VectorT< Scalar, DIM >::cross ( const VectorT< OtherScalar, DIM > & _rhs ) const -> decltype(*this % _rhs)

inline

cross product: only defined for Vec3* as specialization

See also: OpenMesh::cross and .operator%

Definition at line 388 of file Vector11T.hh.

◆ dot()

template<typename Scalar, int DIM>

template<typename OtherScalar >

auto OpenMesh::VectorT< Scalar, DIM >::dot ( const VectorT< OtherScalar, DIM > & _rhs ) const -> decltype(*this | _rhs)

inline

compute scalar product

See also: OpenMesh::dot and .operator|

Definition at line 408 of file Vector11T.hh.

◆ homogenized()

template<typename Scalar, int DIM>

template<typename S = Scalar, int D = DIM>

auto OpenMesh::VectorT< Scalar, DIM >::homogenized ( ) const -> typename std::enable_if<D == 4, VectorT<decltype(std::declval<S>()/std::declval<S>()), DIM>>::type

inline

Only for 4-component vectors with division operator on their Scalar: Dehomogenization.

Definition at line 148 of file Vector11T.hh.

◆ normalize()

template<typename Scalar, int DIM>

template<typename S = Scalar>

auto OpenMesh::VectorT< Scalar, DIM >::normalize ( ) -> decltype(*this /= std::declval<VectorT<S, DIM>>().norm())

inline

normalize vector, return normalized vector

Definition at line 453 of file Vector11T.hh.

◆ normalized()

template<typename Scalar, int DIM>

template<typename S = Scalar>

auto OpenMesh::VectorT< Scalar, DIM >::normalized ( ) const -> decltype(*this / std::declval<VectorT<S, DIM>>().norm())

inline

return normalized vector

Definition at line 464 of file Vector11T.hh.

◆ operator%()

template<typename Scalar, int DIM>

template<typename OtherScalar >

auto OpenMesh::VectorT< Scalar, DIM >::operator% ( const VectorT< OtherScalar, DIM > & _rhs ) const -> typename std::enable_if<DIM == 3, VectorT<decltype((*this)[0] * _rhs[0] - (*this)[0] * _rhs[0]), DIM>>::type

inline

cross product: only defined for Vec3* as specialization

See also: OpenMesh::cross and .cross()

Definition at line 374 of file Vector11T.hh.

◆ operator|()

template<typename Scalar, int DIM>

template<typename OtherScalar >

auto OpenMesh::VectorT< Scalar, DIM >::operator| ( const VectorT< OtherScalar, DIM > & _rhs ) const -> decltype(*this->data() * *_rhs.data())

inline

compute scalar product

See also: OpenMesh::dot and .dot()

Definition at line 398 of file Vector11T.hh.

Friends And Related Function Documentation

◆ cross() [1/2]

template<typename Scalar , int N>

VectorT< Scalar, N > cross	(	const VectorT< Scalar, N > &	_v1,
		const VectorT< Scalar, N > &	_v2
	)

Definition at line 267 of file VectorT.hh.

◆ cross() [2/2]

template<typename LScalar , typename RScalar , int DIM>

auto cross	(	const VectorT< LScalar, DIM > &	_v1,
		const VectorT< RScalar, DIM > &	_v2
	)		-> decltype(_v1 % _v2)

Definition at line 732 of file Vector11T.hh.

◆ dot() [1/2]

template<typename Scalar , int N>

Scalar dot	(	const VectorT< Scalar, N > &	_v1,
		const VectorT< Scalar, N > &	_v2
	)

Definition at line 258 of file VectorT.hh.

◆ dot() [2/2]

template<typename Scalar , int DIM>

Scalar dot	(	const VectorT< Scalar, DIM > &	_v1,
		const VectorT< Scalar, DIM > &	_v2
	)

Definition at line 724 of file Vector11T.hh.

◆ max() [1/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > max	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 323 of file VectorT.hh.

◆ max() [2/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > max	(	const VectorT< Scalar, DIM > &	_v1,
		const VectorT< Scalar, DIM > &	_v2
	)

Definition at line 789 of file Vector11T.hh.

◆ maximize() [1/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & maximize	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 307 of file VectorT.hh.

◆ maximize() [2/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & maximize	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 775 of file Vector11T.hh.

◆ min() [1/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > min	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 331 of file VectorT.hh.

◆ min() [2/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > min	(	const VectorT< Scalar, DIM > &	_v1,
		const VectorT< Scalar, DIM > &	_v2
	)

Definition at line 796 of file Vector11T.hh.

◆ minimize() [1/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & minimize	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 315 of file VectorT.hh.

◆ minimize() [2/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & minimize	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 782 of file Vector11T.hh.

◆ norm() [1/2]

template<typename Scalar , int DIM>

Scalar norm ( const VectorT< Scalar, DIM > & _v )

Definition at line 275 of file VectorT.hh.

◆ norm() [2/2]

template<typename Scalar , int DIM>

Scalar norm ( const VectorT< Scalar, DIM > & _v )

Definition at line 748 of file Vector11T.hh.

◆ normalize() [1/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & normalize ( VectorT< Scalar, DIM > & _v )

Definition at line 299 of file VectorT.hh.

◆ normalize() [2/2]

template<typename Scalar , int DIM>

VectorT< Scalar, DIM > & normalize ( VectorT< Scalar, DIM > & _v )

Definition at line 768 of file Vector11T.hh.

◆ operator*()

template<typename Scalar1 , typename Scalar2 , int N>

VectorT< Scalar1, N > operator*	(	Scalar2	_s,
		const VectorT< Scalar1, N > &	_v
	)

Definition at line 249 of file VectorT.hh.

◆ sqrnorm() [1/2]

template<typename Scalar , int DIM>

Scalar sqrnorm ( const VectorT< Scalar, DIM > & _v )

Definition at line 283 of file VectorT.hh.

◆ sqrnorm() [2/2]

template<typename Scalar , int DIM>

Scalar sqrnorm ( const VectorT< Scalar, DIM > & _v )

Definition at line 755 of file Vector11T.hh.

◆ swap()

template<typename Scalar , int DIM>

void swap	(	VectorT< Scalar, DIM > &	_v1,
		VectorT< Scalar, DIM > &	_v2
	)

Definition at line 740 of file Vector11T.hh.

◆ vectorize() [1/2]

template<typename Scalar , int DIM, typename OtherScalar >

VectorT< Scalar, DIM > & vectorize	(	VectorT< Scalar, DIM > &	_v,
		OtherScalar const &	_val
	)

Definition at line 291 of file VectorT.hh.

◆ vectorize() [2/2]

template<typename Scalar , int DIM, typename OtherScalar >

VectorT< Scalar, DIM > & vectorize	(	VectorT< Scalar, DIM > &	_v,
		OtherScalar const &	_val
	)

Definition at line 761 of file Vector11T.hh.

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

OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Geometry/Vector11T.hh
OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/Geometry/VectorT.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Related Functions

Component iterators

Detailed Description

template<typename Scalar, int DIM> class OpenMesh::VectorT< Scalar, DIM >

Constructor & Destructor Documentation

◆ VectorT()

Member Function Documentation

◆ cross()

◆ dot()

◆ homogenized()

◆ normalize()

◆ normalized()

◆ operator%()

◆ operator|()

Friends And Related Function Documentation

◆ cross() [1/2]

◆ cross() [2/2]

◆ dot() [1/2]

◆ dot() [2/2]

◆ max() [1/2]

◆ max() [2/2]

◆ maximize() [1/2]

◆ maximize() [2/2]

◆ min() [1/2]

◆ min() [2/2]

◆ minimize() [1/2]

◆ minimize() [2/2]

◆ norm() [1/2]

◆ norm() [2/2]

◆ normalize() [1/2]

◆ normalize() [2/2]

◆ operator*()

◆ sqrnorm() [1/2]

◆ sqrnorm() [2/2]

◆ swap()

◆ vectorize() [1/2]

◆ vectorize() [2/2]

template<typename Scalar, int DIM>
class OpenMesh::VectorT< Scalar, DIM >