Multi-purpose 2D vector class. More...

#include <cvb/point_2d.hpp>

Public Member Functions
	Point2D () noexcept=default
	Creates a default point at (0, 0).

	Point2D (T x, T y) noexcept
	Create a point from the x and y component.

	Point2D (Angle phi, T r) noexcept
	Create a PointD vector from radial coordinates.

template<std::size_t N>
	Point2D (const T(&list)[N]) noexcept
	Construct a point with an initializer list.

T	X () const noexcept
	Gets the x-component of the point.

void	SetX (T x) noexcept
	Sets the x-component of the point.

T	Y () const noexcept
	Gets the y-component of the point.

void	SetY (T y)
	Sets the y-component of the point.

T	Length () const noexcept
	Gets the length of the vector represented by this point object.

void	SetLength (T length) noexcept
	Sets the length of the vector represented by this point object.

Angle	Phi () const noexcept
	Gets the orientation of the vector represented by this point object.

void	SetPhi (Angle phi) noexcept
	Sets the orientation of the vector represented by this point object.

bool	operator== (const Point2D< T > &other) const noexcept
	Compares to an other point.

bool	operator!= (const Point2D< T > &other) const noexcept
	Compares to an other point.

template<class C>
	operator Point2D< C > () const noexcept
	Enable casting.

Point2D< T > &	operator+= (const Point2D< T > &point) noexcept
	Adds and assigns to this point.

Point2D< T > &	operator-= (const Point2D< T > &point) noexcept
	Subtracts and assigns to this point.

Point2D< T > &	operator*= (const T &value) noexcept
	Multiplies by a scalar and assigns to this point.

Point2D< T > &	operator/= (const T &value) noexcept
	Divide by a scalar and assigns to this point.

const T &	operator[] (int index) const noexcept
	Index based element access.

T &	operator[] (int index) noexcept
	Index based element access.

Related Symbols
(Note that these are not member symbols.)
template<size_t I, class T, std::enable_if_t< less< I, 2 >::value, int > = 0>
CVB_BEGIN_INLINE_NS auto	get (const Point2D< T > &point) noexcept -> decltype(point[I])
	Get's the I-th element of the Point2D<T>.

template<size_t I, class T, std::enable_if_t< less< I, 2 >::value, int > = 0>
void	set (Point2D< T > &point, const T &val) noexcept
	Set's the value of the I-th element in the Point2D<T> point.

template<class T>
Point2D< T >	operator+ (const Point2D< T > &lhs, const Point2D< T > &rhs)
	Add two points.

template<class T>
Point2D< T >	operator- (const Point2D< T > &lhs, const Point2D< T > &rhs)
	Subtracts two points.

template<class T>
T	operator* (const Point2D< T > &lhs, const Point2D< T > &rhs)
	Inner product of two point vectors.

template<class T>
Point2D< T >	operator* (const Point2D< T > &lhs, const T &rhs)
	Multiply point with scalar.

template<class T>
Point2D< T >	operator* (const T &lhs, const Point2D< T > &rhs)
	Multiply scalar with point.

template<class T>
Point2D< T >	operator/ (const Point2D< T > &lhs, const T &rhs)
	Divide point by scalar.

Detailed Description

template<class T, class ENABLE = void>
class Cvb::Point2D< T, ENABLE >

Multi-purpose 2D vector class.

Constructor & Destructor Documentation

◆ Point2D() [1/4]

template<class T, class ENABLE = void>

Point2D ( )

defaultnoexcept

Creates a default point at (0, 0).

Exceptions

Does	not throw any exception.

◆ Point2D() [2/4]

template<class T, class ENABLE = void>

Point2D	(	T	x,
		T	y )

inlinenoexcept

Create a point from the x and y component.

Parameters

[in]	x	Data to initialize with.
[in]	y	Data to initialize with.

Exceptions

Does	not throw any exception.

◆ Point2D() [3/4]

template<class T, class ENABLE = void>

Point2D	(	Angle	phi,
		T	r )

inlinenoexcept

Create a PointD vector from radial coordinates.

Parameters

[in]	phi	Angle coordinate.
[in]	r	Radius coordinate.

Exceptions

Does	not throw any exception.

The vectors are internally stored in Cartesian coordinates and that extensive use of radial coordinates my be slow.

◆ Point2D() [4/4]

template<class T, class ENABLE = void>

template<std::size_t N>

Point2D ( const T(&) list[N] )

inlinenoexcept

Construct a point with an initializer list.

Parameters

[in] list Containing exactly 2 elements.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ Length()

template<class T, class ENABLE = void>

T Length ( ) const

inlinenoexcept

Gets the length of the vector represented by this point object.

Returns: T The length (accurate only for double or float).

Exceptions

Does	not throw any exception.

◆ operator!=()

template<class T, class ENABLE = void>

bool operator!= ( const Point2D< T > & other ) const

inlinenoexcept

Compares to an other point.

Parameters

[in] other Other point.

Returns: True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator*=()

template<class T, class ENABLE = void>

Point2D< T > & operator*= ( const T & value )

inlinenoexcept

Multiplies by a scalar and assigns to this point.

Parameters

[in] value The scalar.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator+=()

template<class T, class ENABLE = void>

Point2D< T > & operator+= ( const Point2D< T > & point )

inlinenoexcept

Adds and assigns to this point.

Parameters

[in] point Other point.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator-=()

template<class T, class ENABLE = void>

Point2D< T > & operator-= ( const Point2D< T > & point )

inlinenoexcept

Subtracts and assigns to this point.

Parameters

[in] point Other point.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator/=()

template<class T, class ENABLE = void>

Point2D< T > & operator/= ( const T & value )

inlinenoexcept

Divide by a scalar and assigns to this point.

Parameters

[in] value The scalar.

Returns: This point.

Exceptions

Does	not throw any exception.

◆ operator==()

template<class T, class ENABLE = void>

bool operator== ( const Point2D< T > & other ) const

inlinenoexcept

Compares to an other point.

Parameters

[in] other Other point.

Returns: True if equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator[]() [1/2]

template<class T, class ENABLE = void>

const T & operator[] ( int index ) const

inlinenoexcept

Index based element access.

Parameters

[in] index Index of the element.

Returns: A const reference to the element.

Exceptions

Does	not throw any exception.

◆ operator[]() [2/2]

template<class T, class ENABLE = void>

T & operator[] ( int index )

inlinenoexcept

Index based element access.

Parameters

[in] index Index of the element.

Returns: A reference to the element.

Exceptions

Does	not throw any exception.

◆ Phi()

template<class T, class ENABLE = void>

Angle Phi ( ) const

inlinenoexcept

Gets the orientation of the vector represented by this point object.

Returns: The angle (accurate only for double or float).

Exceptions

Does	not throw any exception.

◆ SetLength()

template<class T, class ENABLE = void>

void SetLength ( T length )

inlinenoexcept

Sets the length of the vector represented by this point object.

Parameters

[in] length The length (accurate only for double or float).

Exceptions

Does	not throw any exception.

◆ SetPhi()

template<class T, class ENABLE = void>

void SetPhi ( Angle phi )

inlinenoexcept

Sets the orientation of the vector represented by this point object.

Parameters

[in] phi The angle (accurate only for double or float).

Exceptions

Does	not throw any exception.

◆ SetX()

template<class T, class ENABLE = void>

void SetX ( T x )

inlinenoexcept

Sets the x-component of the point.

Parameters

[in] x X-component.

Exceptions

Does	not throw any exception.

◆ SetY()

template<class T, class ENABLE = void>

void SetY ( T y )

inline

Sets the y-component of the point.

Parameters

[in] y Y-component.

Exceptions

Does	not throw any exception.

◆ X()

template<class T, class ENABLE = void>

T X ( ) const

inlinenoexcept

Gets the x-component of the point.

Returns: X-component.

Exceptions

Does	not throw any exception.

◆ Y()

template<class T, class ENABLE = void>

T Y ( ) const

inlinenoexcept

Gets the y-component of the point.

Returns: Y-component.

Exceptions

Does	not throw any exception.

Friends And Related Symbol Documentation

◆ get()

template<size_t I, class T, std::enable_if_t< less< I, 2 >::value, int > = 0>

CVB_BEGIN_INLINE_NS auto get ( const Point2D< T > & point ) -> decltype(point[I])

Get's the I-th element of the Point2D<T>.

See also: Block, Visit

Precondition: I < 2

Template Parameters

I	The index of the element.

Parameters

point The Point2D<T> to retrieve the I-th element from.

Returns: The I-th element of point.

◆ operator*() [1/3]

template<class T>

T operator*	(	const Point2D< T > &	lhs,
		const Point2D< T > &	rhs )

Inner product of two point vectors.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [2/3]

template<class T>

Point2D< T > operator*	(	const Point2D< T > &	lhs,
		const T &	rhs )

Multiply point with scalar.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [3/3]

template<class T>

Point2D< T > operator*	(	const T &	lhs,
		const Point2D< T > &	rhs )

Multiply scalar with point.

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator+()

template<class T>

Point2D< T > operator+	(	const Point2D< T > &	lhs,
		const Point2D< T > &	rhs )

Add two points.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator-()

template<class T>

Point2D< T > operator-	(	const Point2D< T > &	lhs,
		const Point2D< T > &	rhs )

Subtracts two points.

Parameters

[in]	lhs	Right hand side point.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator/()

template<class T>

Point2D< T > operator/	(	const Point2D< T > &	lhs,
		const T &	rhs )

Divide point by scalar.

Parameters

[in]	lhs	Right hand side matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ set()

template<size_t I, class T, std::enable_if_t< less< I, 2 >::value, int > = 0>

void set	(	Point2D< T > &	point,
		const T &	val )

Set's the value of the I-th element in the Point2D<T> point.

See also: Block, Visit

Precondition: I < 2

Template Parameters

I	The index of the element.

Parameters

point	The Point2D<T,K> to set the I-th value in.
val	The value to be written to the I-th element of point.

Public Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ Point2D() [1/4]

◆ Point2D() [2/4]

◆ Point2D() [3/4]

◆ Point2D() [4/4]

Member Function Documentation

◆ Length()

◆ operator!=()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Phi()

◆ SetLength()

◆ SetPhi()

◆ SetX()

◆ SetY()

◆ X()

◆ Y()

Friends And Related Symbol Documentation

◆ get()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator+()

◆ operator-()

◆ operator/()

◆ set()