Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

DPosition Class Template Reference
[Datastructures]

#include <OpenMS/DATASTRUCTURES/DPosition.h>

List of all members.


Detailed Description

template<UInt D>
class OpenMS::DPosition< D >

Representation of a coordinate in D-dimensional space.

Accessors



CoordinateType operator[] (UInt index) const
 Const accessor for the dimensions.
CoordinateTypeoperator[] (UInt index)
 Accessor for the dimensions.
CoordinateType getX () const
 Name accessor for the first dimension. Only for DPosition<2>, for visualization.
CoordinateType getY () const
 Name accessor for the second dimension. Only for DPosition<2>, for visualization.
void setX (CoordinateType c)
 Name mutator for the first dimension. Only for DPosition<2>, for visualization.
void setY (CoordinateType c)
 Name mutator for the second dimension. Only for DPosition<2>, for visualization.
bool operator== (const DPosition &point) const throw ()
 Equality operator.
bool operator!= (const DPosition &point) const throw ()
 Equality operator.
bool operator< (const DPosition &point) const throw ()
 Lexicographical less than operator.
bool operator<= (const DPosition &point) const throw ()
 Lexicographical greater less or equal operator.
bool spatiallyLessEqual (const DPosition &point) const throw ()
 Spatially (geometrically) less or equal operator. All coordinates must be "<=".
bool spatiallyGreaterEqual (const DPosition &point) const throw ()
 Spatially (geometrically) greater or equal operator. All coordinates must be ">=".
bool operator> (const DPosition &point) const throw ()
 Lexicographical greater than operator.
bool operator>= (const DPosition &point) const throw ()
 Lexicographical greater or equal operator.
DPosition operator+ (const DPosition &point) const throw ()
 Addition (a bit inefficient).
DPositionoperator+= (const DPosition &point) throw ()
 Addition.
DPosition operator- (const DPosition &point) const throw ()
 Subtraction (a bit inefficient).
DPositionoperator-= (const DPosition &point) throw ()
 Subtraction.
DPosition operator- () const throw ()
 Negation (a bit inefficient).
CoordinateType operator * (const DPosition &point) const throw ()
 Inner product.
DPositionoperator *= (CoordinateType scalar) throw ()
 Scalar multiplication.
DPositionoperator/= (CoordinateType scalar) throw ()
 Scalar division.
void clear ()
 Set all dimensions to zero.
static UInt size ()
 Returns the number of dimensions.

Public Types

enum  { DIMENSION = D }
 Dimensions. More...
typedef DoubleReal CoordinateType
 Coordinate type.
typedef CoordinateTypeIterator
 Mutable iterator.
typedef const CoordinateTypeConstIterator
 Non-mutable iterator.
STL compatibility type definitions
typedef CoordinateType value_type
typedef CoordinateTypereference
typedef CoordinateTypepointer
typedef CoordinateTypeiterator
typedef const CoordinateTypeconst_iterator

Public Member Functions

Constructors and Destructor
 DPosition ()
 Default constructor.
 ~DPosition ()
 Destructor (not-virtual as this will save a lot of space!).
 DPosition (CoordinateType x)
 Constructor that fills all dimensions with the value x.
 DPosition (const DPosition &pos)
 Copy constructor.
 DPosition (CoordinateType x, CoordinateType y)
 Constructor only for DPosition<2> that takes two Coordinates.
DPositionoperator= (const DPosition &source)
 Assignment operator.
Iteration


ConstIterator begin () const throw ()
 Non-mutable begin iterator.
ConstIterator end () const throw ()
 Non-mutable end iterator.
Iterator begin () throw ()
 Mutable begin iterator.
Iterator end () throw ()
 Mutable end iterator.

Static Public Attributes

Static default instances


static const DPosition zero = DPosition<D>(0)
 all zero
static const DPosition min = DPosition<D>(std::numeric_limits<typename DPosition<D>::CoordinateType>::min())
 smallest positive
static const DPosition min_negative = DPosition<D>(-std::numeric_limits<typename DPosition<D>::CoordinateType>::max())
 smallest negative
static const DPosition max = DPosition<D>(std::numeric_limits<typename DPosition<D>::CoordinateType>::max())
 largest positive

Protected Attributes

CoordinateType coordinate_ [D]

Member Typedef Documentation

typedef DoubleReal CoordinateType

Coordinate type.

typedef CoordinateType* Iterator

Mutable iterator.

typedef const CoordinateType* ConstIterator

Non-mutable iterator.

typedef CoordinateType value_type

typedef CoordinateType& reference

typedef CoordinateType* pointer

typedef CoordinateType* iterator

typedef const CoordinateType* const_iterator


Member Enumeration Documentation

anonymous enum

Dimensions.

Enumerator:
DIMENSION 


Constructor & Destructor Documentation

DPosition (  )  [inline]

Default constructor.

Creates a position with all coordinates zero.

~DPosition (  )  [inline]

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

DPosition ( CoordinateType  x  )  [inline]

Constructor that fills all dimensions with the value x.

DPosition ( const DPosition< D > &  pos  )  [inline]

Copy constructor.

DPosition ( CoordinateType  x,
CoordinateType  y 
) [inline]

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


Member Function Documentation

DPosition& operator= ( const DPosition< D > &  source  )  [inline]

Assignment operator.

CoordinateType operator[] ( UInt  index  )  const [inline]

Const accessor for the dimensions.

CoordinateType& operator[] ( UInt  index  )  [inline]

Accessor for the dimensions.

CoordinateType getX (  )  const [inline]

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

CoordinateType getY (  )  const [inline]

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

void setX ( CoordinateType  c  )  [inline]

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

void setY ( CoordinateType  c  )  [inline]

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

bool operator== ( const DPosition< D > &  point  )  const throw () [inline]

Equality operator.

bool operator!= ( const DPosition< D > &  point  )  const throw () [inline]

Equality operator.

bool operator< ( const DPosition< D > &  point  )  const throw () [inline]

Lexicographical less than operator.

Lexicographical copmarison from dimension 0 to dimension D-1 is done.

bool operator<= ( const DPosition< D > &  point  )  const throw () [inline]

Lexicographical greater less or equal operator.

bool spatiallyLessEqual ( const DPosition< D > &  point  )  const throw () [inline]

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

bool spatiallyGreaterEqual ( const DPosition< D > &  point  )  const throw () [inline]

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

bool operator> ( const DPosition< D > &  point  )  const throw () [inline]

Lexicographical greater than operator.

bool operator>= ( const DPosition< D > &  point  )  const throw () [inline]

Lexicographical greater or equal operator.

DPosition operator+ ( const DPosition< D > &  point  )  const throw () [inline]

Addition (a bit inefficient).

DPosition& operator+= ( const DPosition< D > &  point  )  throw () [inline]

Addition.

DPosition operator- ( const DPosition< D > &  point  )  const throw () [inline]

Subtraction (a bit inefficient).

DPosition& operator-= ( const DPosition< D > &  point  )  throw () [inline]

Subtraction.

DPosition operator- (  )  const throw () [inline]

Negation (a bit inefficient).

CoordinateType operator * ( const DPosition< D > &  point  )  const throw () [inline]

Inner product.

DPosition& operator *= ( CoordinateType  scalar  )  throw () [inline]

Scalar multiplication.

DPosition& operator/= ( CoordinateType  scalar  )  throw () [inline]

Scalar division.

static UInt size (  )  [inline, static]

Returns the number of dimensions.

void clear (  )  [inline]

Set all dimensions to zero.

ConstIterator begin (  )  const throw () [inline]

Non-mutable begin iterator.

ConstIterator end (  )  const throw () [inline]

Non-mutable end iterator.

Iterator begin (  )  throw () [inline]

Mutable begin iterator.

Iterator end (  )  throw () [inline]

Mutable end iterator.


Member Data Documentation

const DPosition< D > zero = DPosition<D>(0) [inline, static]

all zero

const DPosition< D > min = DPosition<D>(std::numeric_limits<typename DPosition<D>::CoordinateType>::min()) [inline, static]

smallest positive

const DPosition< D > min_negative = DPosition<D>(-std::numeric_limits<typename DPosition<D>::CoordinateType>::max()) [inline, static]

smallest negative

const DPosition< D > max = DPosition<D>(std::numeric_limits<typename DPosition<D>::CoordinateType>::max()) [inline, static]

largest positive

CoordinateType coordinate_[D] [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1