Specialization of class vecng for DIM == 2. More...

#include <geogram/basic/vecg.h>

Public Types
typedef vecng< dim, T >	vector_type
	This vector type.

typedef T	value_type
	The type of the vector coordinates.

Public Member Functions
	vecng ()
	Default vector constructor.

	vecng (const T &x_in, const T &y_in)
	Constructs a vector from coordinates.

	vecng (T &&x_in, T &&y_in)
	Constructs a vector from coordinates.

	vecng (const vecng< 2, T > &rhs)=default

	vecng (vecng< 2, T > &&rhs)=default

template<class T2 >
	vecng (const vecng< dim, T2 > &v)
	Constructs a vector by copy.

template<class T2 >
	vecng (const T2 *v)
	Constructs a vector from an array.

	vecng (const std::initializer_list< T > &Vi)

vecng< 2, T > &	operator= (const vecng< 2, T > &rhs)=default

vecng< 2, T > &	operator= (vecng< 2, T > &&rhs)=default

T	length2 () const
	Gets the squared length of the vector.

T	length () const
	Gets the length of the vector.

T	distance2 (const vector_type &v) const

T	distance (const vector_type &v) const

vector_type &	operator+= (const vector_type &v)

vector_type &	operator-= (const vector_type &v)

template<class T2 >
vector_type &	operator*= (T2 s)
	Multiplies by a scalar in place.

template<class T2 >
vector_type &	operator/= (T2 s)
	Divides by a scalar in place.

vector_type	operator+ (const vector_type &v) const

vector_type	operator- (const vector_type &v) const

template<class T2 >
vector_type	operator* (T2 s) const
	Multiplies a vector by a scalar.

template<class T2 >
vector_type	operator/ (T2 s) const
	Divides a vector by a scalar.

vector_type	operator- () const
	Negates a vector.

index_t	dimension () const
	Gets the vector dimension.

T *	data ()
	Gets modifiable vector data.

const T *	data () const
	Gets non-modifiable vector data.

T &	operator[] (index_t i)
	Gets a modifiable vector coordinate.

const T &	operator[] (index_t i) const
	Gets a non-modifiable vector coordinate.

void	optimize ()
	Optimizes coordinate representation.

Public Attributes
T	x
	Vector x coordinate.

T	y
	Vector y coordinate.

Static Public Attributes
static constexpr index_t	dim = 2
	The dimension of the vector.

Detailed Description

template<class T>
class GEO::vecng< 2, T >

Specialization of class vecng for DIM == 2.

See also: vecng

Definition at line 520 of file vecg.h.

Member Typedef Documentation

◆ value_type

template<class T >

typedef T GEO::vecng< 2, T >::value_type

The type of the vector coordinates.

Definition at line 529 of file vecg.h.

◆ vector_type

template<class T >

typedef vecng<dim, T> GEO::vecng< 2, T >::vector_type

This vector type.

Definition at line 526 of file vecg.h.

Constructor & Destructor Documentation

◆ vecng() [1/6]

template<class T >

GEO::vecng< 2, T >::vecng ( )

inline

Default vector constructor.

All coordinates are initialized to 0 (zero).

Definition at line 532 of file vecg.h.

◆ vecng() [2/6]

template<class T >

GEO::vecng< 2, T >::vecng	(	const T &	x_in,
		const T &	y_in
	)

inline

Constructs a vector from coordinates.

Parameters

[in] x_in,y_in references to vector coordinates

Definition at line 541 of file vecg.h.

◆ vecng() [3/6]

template<class T >

GEO::vecng< 2, T >::vecng	(	T &&	x_in,
		T &&	y_in
	)

inline

Constructs a vector from coordinates.

Parameters

[in] x_in,y_in vector coordinates as rvalue references

Definition at line 550 of file vecg.h.

◆ vecng() [4/6]

template<class T >

template<class T2 >

GEO::vecng< 2, T >::vecng ( const vecng< dim, T2 > & v )

inlineexplicit

Constructs a vector by copy.

This copies coordinates of vector v to this vector. The type T2 of the coordinates in v must be convertible to the type T of this vector.

Parameters

[in] v an vector of same dimension with coordinates of type T2

Template Parameters

T2	the type of coordinates in vector `v`

Definition at line 560 of file vecg.h.

◆ vecng() [5/6]

template<class T >

template<class T2 >

GEO::vecng< 2, T >::vecng ( const T2 * v )

inlineexplicit

Constructs a vector from an array.

This copies coordinates the first DIM coordinates of array v to this vector. The type T2 of the coordinates in v must be convertible to the type T of this vector.

Parameters

[in] v an array of values of type T2

Template Parameters

T2	the type of coordinates in vector `v`

Definition at line 567 of file vecg.h.

◆ vecng() [6/6]

template<class T >

GEO::vecng< 2, T >::vecng ( const std::initializer_list< T > & Vi )

inline

Definition at line 573 of file vecg.h.

Member Function Documentation

◆ data() [1/2]

template<class T >

T * GEO::vecng< 2, T >::data ( )

inline

Gets modifiable vector data.

Returns: a pointer to the first element of the vector

Definition at line 670 of file vecg.h.

◆ data() [2/2]

template<class T >

const T * GEO::vecng< 2, T >::data ( ) const

inline

Gets non-modifiable vector data.

Returns: a const pointer to the first element of the vector

Definition at line 675 of file vecg.h.

◆ dimension()

template<class T >

index_t GEO::vecng< 2, T >::dimension ( ) const

inline

Gets the vector dimension.

Returns: the value of DIM

Definition at line 665 of file vecg.h.

◆ distance()

template<class T >

T GEO::vecng< 2, T >::distance ( const vector_type & v ) const

inline

Definition at line 603 of file vecg.h.

◆ distance2()

template<class T >

T GEO::vecng< 2, T >::distance2 ( const vector_type & v ) const

inline

Definition at line 596 of file vecg.h.

◆ length()

template<class T >

T GEO::vecng< 2, T >::length ( ) const

inline

Gets the length of the vector.

Definition at line 591 of file vecg.h.

◆ length2()

template<class T >

T GEO::vecng< 2, T >::length2 ( ) const

inline

Gets the squared length of the vector.

Definition at line 586 of file vecg.h.

◆ operator*()

template<class T >

template<class T2 >

vector_type GEO::vecng< 2, T >::operator* ( T2 s ) const

inline

Multiplies a vector by a scalar.

Builds a vector by multipying this vector coordinates by value s. The type T2 of s must be convertible to the type T of this vector coordinates.

Parameters

[in] s a value of type T2

Template Parameters

T2	the type of value `s`

Returns: the result vector (this * s)

Definition at line 649 of file vecg.h.

◆ operator*=()

template<class T >

template<class T2 >

vector_type & GEO::vecng< 2, T >::operator*= ( T2 s )

inline

Multiplies by a scalar in place.

Multiplies this vector coordinates by value s. The type T2 of s must be convertible to the type T of this vector coordinates.

Parameters

[in] s a value of type T2

Template Parameters

T2	the type of value `s`

Returns: a reference to this vector

Definition at line 623 of file vecg.h.

◆ operator+()

template<class T >

vector_type GEO::vecng< 2, T >::operator+ ( const vector_type & v ) const

inline

Definition at line 638 of file vecg.h.

◆ operator+=()

template<class T >

vector_type & GEO::vecng< 2, T >::operator+= ( const vector_type & v )

inline

Definition at line 608 of file vecg.h.

◆ operator-() [1/2]

template<class T >

vector_type GEO::vecng< 2, T >::operator- ( ) const

inline

Negates a vector.

Builds a vector by negating coordinates of this vector.

Returns: the result vector (-this)

Definition at line 660 of file vecg.h.

◆ operator-() [2/2]

template<class T >

vector_type GEO::vecng< 2, T >::operator- ( const vector_type & v ) const

inline

Definition at line 643 of file vecg.h.

◆ operator-=()

template<class T >

vector_type & GEO::vecng< 2, T >::operator-= ( const vector_type & v )

inline

Definition at line 615 of file vecg.h.

◆ operator/()

template<class T >

template<class T2 >

vector_type GEO::vecng< 2, T >::operator/ ( T2 s ) const

inline

Divides a vector by a scalar.

Builds a vector by dividing this vector coordinates by value s. The type T2 of s must be convertible to the type T of this vector coordinates.

Parameters

[in] s a value of type T2

Template Parameters

T2	the type of value `s`

Returns: the result vector (this / s)

Definition at line 655 of file vecg.h.

◆ operator/=()

template<class T >

template<class T2 >

vector_type & GEO::vecng< 2, T >::operator/= ( T2 s )

inline

Divides by a scalar in place.

Divides this vector coordinates by value s. The type T2 of s must be convertible to the type T of this vector coordinates.

Parameters

[in] s a value of type T2

Template Parameters

T2	the type of value `s`

Returns: a reference to this vector

Definition at line 631 of file vecg.h.

◆ operator[]() [1/2]

template<class T >

T & GEO::vecng< 2, T >::operator[] ( index_t i )

inline

Gets a modifiable vector coordinate.

Parameters

[in] i index of the coordinate

Returns: a reference to coordinate at index i

Definition at line 680 of file vecg.h.

◆ operator[]() [2/2]

template<class T >

const T & GEO::vecng< 2, T >::operator[] ( index_t i ) const

inline

Gets a non-modifiable vector coordinate.

Parameters

[in] i index of the coordinate

Returns: a const reference to coordinate at index i

Definition at line 686 of file vecg.h.

◆ optimize()

template<class T >

void GEO::vecng< 2, T >::optimize ( )

inline

Optimizes coordinate representation.

Definition at line 692 of file vecg.h.

Member Data Documentation

◆ dim

template<class T >

constexpr index_t GEO::vecng< 2, T >::dim = 2

staticconstexpr

The dimension of the vector.

Definition at line 523 of file vecg.h.

◆ x

template<class T >

T GEO::vecng< 2, T >::x

Vector x coordinate.

Definition at line 698 of file vecg.h.

◆ y

template<class T >

T GEO::vecng< 2, T >::y

Vector y coordinate.

Definition at line 700 of file vecg.h.

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

geogram/basic/vecg.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ value_type

◆ vector_type

Constructor & Destructor Documentation

◆ vecng() [1/6]

◆ vecng() [2/6]

◆ vecng() [3/6]

◆ vecng() [4/6]

◆ vecng() [5/6]

◆ vecng() [6/6]

Member Function Documentation

◆ data() [1/2]

◆ data() [2/2]

◆ dimension()

◆ distance()

◆ distance2()

◆ length()

◆ length2()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ optimize()

Member Data Documentation

◆ dim

◆ x

◆ y