Representation of a coordinate in D-dimensional space. More...

#include <OpenMS/DATASTRUCTURES/DPosition.h>

Inheritance diagram for DPosition< D, TCoordinateType >:

Collaboration diagram for DPosition< D, TCoordinateType >:

Public Types
enum	{ DIMENSION = D }
	Dimensions. More...

typedef TCoordinateType	CoordinateType
	Coordinate type. More...

typedef CoordinateType *	Iterator
	Mutable iterator. More...

typedef const CoordinateType *	ConstIterator
	Non-mutable iterator. More...

STL compatibility type definitions
typedef CoordinateType	value_type

typedef CoordinateType &	reference

typedef CoordinateType *	pointer

typedef CoordinateType *	iterator

typedef const CoordinateType *	const_iterator

Public Member Functions
Constructors and Destructor
	DPosition ()=default
	Default constructor. More...

	DPosition (CoordinateType x)
	Constructor that fills all dimensions with the value `x`. More...

	DPosition (CoordinateType x, CoordinateType y)
	Constructor only for DPosition<2> that takes two Coordinates. More...

	DPosition (CoordinateType x, CoordinateType y, CoordinateType z)
	Constructor only for DPosition<3> that takes three Coordinates. More...

	DPosition (const DPosition &pos)=default
	Copy constructor. More...

	DPosition (DPosition &&rhs) noexcept=default
	Move constructor. More...

DPosition &	operator= (const DPosition &source)=default
	Assignment operator. More...

DPosition &	operator= (DPosition &&source) noexcept=default
	Move Assignment operator. More...

	~DPosition () noexcept=default
	Destructor (not-virtual as this will save a lot of space!) More...

void	swap (DPosition &rhs) noexcept
	Swap the two objects. More...

DPosition &	abs () noexcept
	Make all dimension values positive. More...

Static Public Member Functions
Static values
static constexpr DPosition	zero ()
	all zero More...

static constexpr DPosition	minPositive ()
	smallest positive More...

static constexpr DPosition	minNegative ()
	smallest negative More...

static constexpr DPosition	maxPositive ()
	largest positive More...

Iteration
CoordinateType	coordinate_ [D] {}

ConstIterator	begin () const
	Non-mutable begin iterator. More...

ConstIterator	end () const
	Non-mutable end iterator. More...

Iterator	begin ()
	Mutable begin iterator. More...

Iterator	end ()
	Mutable end iterator. More...

Accessors
CoordinateType	operator[] (Size index) const
	Const accessor for the dimensions. More...

CoordinateType &	operator[] (Size index)
	Accessor for the dimensions. More...

CoordinateType	getX () const
	Name accessor for the first dimension. Only for DPosition<2>, for visualization. More...

CoordinateType	getY () const
	Name accessor for the second dimension. Only for DPosition<2>, for visualization. More...

void	setX (CoordinateType c)
	Name mutator for the first dimension. Only for DPosition<2>, for visualization. More...

void	setY (CoordinateType c)
	Name mutator for the second dimension. Only for DPosition<2>, for visualization. More...

bool	operator== (const DPosition &point) const
	Equality operator. More...

bool	operator!= (const DPosition &point) const
	Equality operator. More...

bool	operator< (const DPosition &point) const
	Lexicographical less than operator. Lexicographical comparison from dimension 0 to dimension D-1 is done. More...

bool	operator<= (const DPosition &point) const
	Lexicographical greater less or equal operator. More...

bool	spatiallyLessEqual (const DPosition &point) const
	Spatially (geometrically) less or equal operator. All coordinates must be "<=". More...

bool	spatiallyGreaterEqual (const DPosition &point) const
	Spatially (geometrically) greater or equal operator. All coordinates must be ">=". More...

bool	operator> (const DPosition &point) const
	Lexicographical greater than operator. More...

bool	operator>= (const DPosition &point) const
	Lexicographical greater or equal operator. More...

DPosition	operator+ (const DPosition &point) const
	Addition (a bit inefficient) More...

DPosition &	operator+= (const DPosition &point)
	Addition. More...

DPosition	operator- (const DPosition &point) const
	Subtraction (a bit inefficient) More...

DPosition &	operator-= (const DPosition &point)
	Subtraction. More...

DPosition	operator- () const
	Negation (a bit inefficient) More...

CoordinateType	operator* (const DPosition &point) const
	Inner product. More...

DPosition &	operator*= (CoordinateType scalar)
	Scalar multiplication. More...

DPosition &	operator/= (CoordinateType scalar)
	Scalar division. More...

void	clear ()
	Set all dimensions to zero. More...

constexpr static Size	size ()
	Returns the number of dimensions. More...

Detailed Description

template<UInt D, typename TCoordinateType = double>
class OpenMS::DPosition< D, TCoordinateType >

Representation of a coordinate in D-dimensional space.

Member Typedef Documentation

◆ const_iterator

typedef const CoordinateType* const_iterator

◆ ConstIterator

typedef const CoordinateType* ConstIterator

Non-mutable iterator.

◆ CoordinateType

typedef TCoordinateType CoordinateType

Coordinate type.

◆ Iterator

typedef CoordinateType* Iterator

Mutable iterator.

◆ iterator

typedef CoordinateType* iterator

◆ pointer

typedef CoordinateType* pointer

◆ reference

typedef CoordinateType& reference

◆ value_type

typedef CoordinateType value_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Dimensions.

Enumerator
DIMENSION

Constructor & Destructor Documentation

◆ DPosition() [1/6]

DPosition ( )

default

Default constructor.

Creates a position with all coordinates zero.

Referenced by DPosition< D, TCoordinateType >::maxPositive(), DPosition< D, TCoordinateType >::minNegative(), DPosition< D, TCoordinateType >::minPositive(), and DPosition< D, TCoordinateType >::zero().

◆ DPosition() [2/6]

DPosition ( CoordinateType x )

inline

Constructor that fills all dimensions with the value x.

References DPosition< D, TCoordinateType >::coordinate_.

◆ DPosition() [3/6]

DPosition	(	CoordinateType	x,
		CoordinateType	y
	)

inline

Constructor only for DPosition<2> that takes two Coordinates.

References DPosition< D, TCoordinateType >::coordinate_.

◆ DPosition() [4/6]

DPosition	(	CoordinateType	x,
		CoordinateType	y,
		CoordinateType	z
	)

inline

Constructor only for DPosition<3> that takes three Coordinates.

References DPosition< D, TCoordinateType >::coordinate_.

◆ DPosition() [5/6]

DPosition ( const DPosition< D, TCoordinateType > & pos )

default

Copy constructor.

◆ DPosition() [6/6]

DPosition ( DPosition< D, TCoordinateType > && rhs )

defaultnoexcept

Move constructor.

◆ ~DPosition()

~DPosition ( )

defaultnoexcept

Destructor (not-virtual as this will save a lot of space!)

Member Function Documentation

◆ abs()

DPosition& abs ( )

inlinenoexcept

Make all dimension values positive.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by Annotation1DPeakItem< DataPoint >::draw().

◆ begin() [1/2]

Iterator begin ( )

inline

Mutable begin iterator.

References DPosition< D, TCoordinateType >::coordinate_.

◆ begin() [2/2]

ConstIterator begin ( ) const

inline

Non-mutable begin iterator.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by HashGrid< Cluster >::cellindexAtClustercenter_(), OpenMS::hash_value(), and HashGrid< Cluster >::updateGridDimension_().

◆ clear()

void clear ( )

inline

Set all dimensions to zero.

References DPosition< D, TCoordinateType >::coordinate_.

◆ end() [1/2]

Iterator end ( )

inline

Mutable end iterator.

References DPosition< D, TCoordinateType >::coordinate_.

◆ end() [2/2]

ConstIterator end ( ) const

inline

Non-mutable end iterator.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by HashGrid< Cluster >::cellindexAtClustercenter_(), OpenMS::hash_value(), and HashGrid< Cluster >::updateGridDimension_().

◆ getX()

CoordinateType getX ( ) const

inline

Name accessor for the first dimension. Only for DPosition<2>, for visualization.

References DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

Referenced by GridBasedClustering< Metric >::cluster(), Plot2DCanvas::dataToWidget_(), and Plot1DCanvas::dataToWidget_().

◆ getY()

CoordinateType getY ( ) const

inline

Name accessor for the second dimension. Only for DPosition<2>, for visualization.

References DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

Referenced by GridBasedClustering< Metric >::cluster(), Plot2DCanvas::dataToWidget_(), and Plot1DCanvas::dataToWidget_().

◆ maxPositive()

static constexpr DPosition maxPositive ( )

inlinestaticconstexpr

largest positive

References DPosition< D, TCoordinateType >::DPosition().

◆ minNegative()

static constexpr DPosition minNegative ( )

inlinestaticconstexpr

smallest negative

References DPosition< D, TCoordinateType >::DPosition().

◆ minPositive()

static constexpr DPosition minPositive ( )

inlinestaticconstexpr

smallest positive

References DPosition< D, TCoordinateType >::DPosition().

◆ operator!=()

bool operator!= ( const DPosition< D, TCoordinateType > & point ) const

inline

Equality operator.

References DPosition< D, TCoordinateType >::operator==().

◆ operator*()

CoordinateType operator* ( const DPosition< D, TCoordinateType > & point ) const

inline

Inner product.

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator*=()

DPosition& operator*= ( CoordinateType scalar )

inline

Scalar multiplication.

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator+()

DPosition operator+ ( const DPosition< D, TCoordinateType > & point ) const

inline

Addition (a bit inefficient)

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator+=()

DPosition& operator+= ( const DPosition< D, TCoordinateType > & point )

inline

Addition.

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator-() [1/2]

DPosition operator- ( ) const

inline

Negation (a bit inefficient)

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator-() [2/2]

DPosition operator- ( const DPosition< D, TCoordinateType > & point ) const

inline

Subtraction (a bit inefficient)

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator-=()

DPosition& operator-= ( const DPosition< D, TCoordinateType > & point )

inline

Subtraction.

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator/=()

DPosition& operator/= ( CoordinateType scalar )

inline

Scalar division.

References DPosition< D, TCoordinateType >::coordinate_.

◆ operator<()

bool operator< ( const DPosition< D, TCoordinateType > & point ) const

inline

Lexicographical less than operator. Lexicographical comparison from dimension 0 to dimension D-1 is done.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by DPosition< D, TCoordinateType >::operator>=().

◆ operator<=()

bool operator<= ( const DPosition< D, TCoordinateType > & point ) const

inline

Lexicographical greater less or equal operator.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by DPosition< D, TCoordinateType >::operator>().

◆ operator=() [1/2]

DPosition& operator= ( const DPosition< D, TCoordinateType > & source )

default

Assignment operator.

◆ operator=() [2/2]

DPosition& operator= ( DPosition< D, TCoordinateType > && source )

defaultnoexcept

Move Assignment operator.

◆ operator==()

bool operator== ( const DPosition< D, TCoordinateType > & point ) const

inline

Equality operator.

References DPosition< D, TCoordinateType >::coordinate_.

Referenced by DPosition< D, TCoordinateType >::operator!=().

◆ operator>()

bool operator> ( const DPosition< D, TCoordinateType > & point ) const

inline

Lexicographical greater than operator.

References DPosition< D, TCoordinateType >::operator<=().

◆ operator>=()

bool operator>= ( const DPosition< D, TCoordinateType > & point ) const

inline

Lexicographical greater or equal operator.

References DPosition< D, TCoordinateType >::operator<().

◆ operator[]() [1/2]

CoordinateType& operator[] ( Size index )

inline

Accessor for the dimensions.

References DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

◆ operator[]() [2/2]

CoordinateType operator[] ( Size index ) const

inline

Const accessor for the dimensions.

References DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

◆ setX()

void setX ( CoordinateType c )

inline

Name mutator for the first dimension. Only for DPosition<2>, for visualization.

References OpenMS::Constants::c, DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

◆ setY()

void setY ( CoordinateType c )

inline

Name mutator for the second dimension. Only for DPosition<2>, for visualization.

References OpenMS::Constants::c, DPosition< D, TCoordinateType >::coordinate_, and OPENMS_PRECONDITION.

◆ size()

constexpr static Size size ( )

inlinestaticconstexpr

Returns the number of dimensions.

◆ spatiallyGreaterEqual()

bool spatiallyGreaterEqual ( const DPosition< D, TCoordinateType > & point ) const

inline

Spatially (geometrically) greater or equal operator. All coordinates must be ">=".

References DPosition< D, TCoordinateType >::coordinate_.

◆ spatiallyLessEqual()

bool spatiallyLessEqual ( const DPosition< D, TCoordinateType > & point ) const

inline

Spatially (geometrically) less or equal operator. All coordinates must be "<=".

References DPosition< D, TCoordinateType >::coordinate_.

◆ swap()

void swap ( DPosition< D, TCoordinateType > & rhs )

inlinenoexcept

Swap the two objects.

References DPosition< D, TCoordinateType >::coordinate_.

◆ zero()

static constexpr DPosition zero ( )

inlinestaticconstexpr

all zero

References DPosition< D, TCoordinateType >::DPosition().

Member Data Documentation

◆ coordinate_

CoordinateType coordinate_[D] {}

protected

Public Types

Public Member Functions

Static Public Member Functions

Iteration

Accessors

Detailed Description

template<UInt D, typename TCoordinateType = double> class OpenMS::DPosition< D, TCoordinateType >

Member Typedef Documentation

◆ const_iterator

◆ ConstIterator

◆ CoordinateType

◆ Iterator

◆ iterator

◆ pointer

◆ reference

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DPosition() [1/6]

◆ DPosition() [2/6]

◆ DPosition() [3/6]

◆ DPosition() [4/6]

◆ DPosition() [5/6]

◆ DPosition() [6/6]

◆ ~DPosition()

Member Function Documentation

◆ abs()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ end() [1/2]

◆ end() [2/2]

◆ getX()

◆ getY()

◆ maxPositive()

◆ minNegative()

◆ minPositive()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ setX()

◆ setY()

◆ size()

◆ spatiallyGreaterEqual()

◆ spatiallyLessEqual()

◆ swap()

◆ zero()

Member Data Documentation

◆ coordinate_

template<UInt D, typename TCoordinateType = double>
class OpenMS::DPosition< D, TCoordinateType >