FixedNdPoint Class Template Reference

Inheritance diagram for FixedNdPoint:

LocalArray FixedNdWeightedPoint FixedNdWeightedPoint< double, double, 2 > FixedNdWeightedPoint< double, double, 3 > FixedNdWeightedPoint< double, double, 6 > Point Point3D Pose Pose3D List of all members.

Detailed Description

template<class T, int Size>
class FixedNdPoint< T, Size >

This class provides points with fixed-sized dimension (known at compile time).

All storage is local to the class.

Author:
Bill Smart
Version:
1.0
Date:
June 2005

Definition at line 335 of file Geometry.H.

Public Member Functions

 FixedNdPoint ()
 FixedNdPoint (const T &value)
 FixedNdPoint (const NdPoint< T > &point)
 ~FixedNdPoint ()
Dimension
int n () const
 
Returns:
The dimension of the point. */

Operators
FixedNdPoint< T, Size > operator+ (const FixedNdVector< T, Size > &vector) const
 
Parameters:
[in] vector The vector to add.

FixedNdPoint< T, Size > operator- (const FixedNdVector< T, Size > &vector) const
 
Parameters:
[in] vector The vector to subtract.

FixedNdPoint< T, Size > & operator+= (const FixedNdVector< T, Size > &vector)
 
Parameters:
[in] vector The vector to move the point along.

FixedNdPoint< T, Size > & operator-= (const FixedNdVector< T, Size > &vector)
 
Parameters:
[in] vector The vector to move the point backwards along.

FixedNdVector< T, Size > operator- (const FixedNdPoint< T, Size > &point) const
 
Parameters:
[in] point The second point.

double distance (const FixedNdPoint< T, Size > &point) const
 
Parameters:
[in] point The second point.


Constructor & Destructor Documentation

FixedNdPoint (  )  [inline]

Definition at line 337 of file Geometry.H.

FixedNdPoint ( const T &  value  )  [inline]

Allocate a point and set all of its elements to the given value.

Parameters:
[in] value The value to set the elements to.

Definition at line 340 of file Geometry.H.

FixedNdPoint ( const NdPoint< T > &  point  )  [inline]

Definition at line 341 of file Geometry.H.

~FixedNdPoint (  )  [inline]

Definition at line 342 of file Geometry.H.


Member Function Documentation

int n (  )  const [inline]

Returns:
The dimension of the point. */

Definition at line 349 of file Geometry.H.

FixedNdPoint<T, Size> operator+ ( const FixedNdVector< T, Size > &  vector  )  const [inline]

Parameters:
[in] vector The vector to add.

Returns:
The resulting point.

Definition at line 357 of file Geometry.H.

FixedNdPoint<T, Size> operator- ( const FixedNdVector< T, Size > &  vector  )  const [inline]

Parameters:
[in] vector The vector to subtract.

Returns:
The resulting point.

Definition at line 362 of file Geometry.H.

FixedNdPoint<T, Size>& operator+= ( const FixedNdVector< T, Size > &  vector  )  [inline]

Parameters:
[in] vector The vector to move the point along.

Returns:
The modified point.

Definition at line 368 of file Geometry.H.

FixedNdPoint<T, Size>& operator-= ( const FixedNdVector< T, Size > &  vector  )  [inline]

Parameters:
[in] vector The vector to move the point backwards along.

Returns:
The modified point.

Definition at line 373 of file Geometry.H.

FixedNdVector<T, Size> operator- ( const FixedNdPoint< T, Size > &  point  )  const [inline]

Parameters:
[in] point The second point.

Returns:
The vector from the current point to the given point.

Definition at line 379 of file Geometry.H.

double distance ( const FixedNdPoint< T, Size > &  point  )  const [inline]

Parameters:
[in] point The second point.

Returns:
The Euclidean distance between the points.

Definition at line 388 of file Geometry.H.


The documentation for this class was generated from the following file:
Generated on Thu Feb 1 15:31:55 2007 for WURDE by  doxygen 1.5.1