Savarese Software Research
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
com::savarese::algorithms::spatial_v0_1_1::Point2D

sava::spatial::Point2D< CoordType > Class Template Reference

#include <Point.h>

Inheritance diagram for sava::spatial::Point2D< CoordType >:

Inheritance graph
[legend]
List of all members.

Detailed Description

template<class CoordType = unsigned int>
class sava::spatial::Point2D< CoordType >

A two-dimensional specialization of the Point class.

Author:
Daniel F. Savarese

Definition at line 303 of file Point.h.

Public Types

typedef CoordType coordinate_type
 The type of coordinates stored in the point.

Public Member Functions

 Point2D ()
 Point2D (const coordinate_type &x, const coordinate_type &y)
 Point ()
 Constructs a point with all coordinate values set to zero.
coordinate_type & operator[] (const unsigned int index)
 Returns the coordinate at the specified index.
const coordinate_type & operator[] (const unsigned int index) const
 Returns the coordinate at the specified index as a const reference.

Static Public Member Functions

static const unsigned int dimensions ()
 Returns the number of dimensions in the point.

Member Typedef Documentation

template<class CoordType = unsigned int>
typedef CoordType sava::spatial::Point2D< CoordType >::coordinate_type
 

The type of coordinates stored in the point.

Reimplemented from sava::spatial::Point< 2, CoordType >.

Definition at line 306 of file Point.h.

Constructor & Destructor Documentation

template<class CoordType = unsigned int>
sava::spatial::Point2D< CoordType >::Point2D (   )  [inline]
 

Definition at line 308 of file Point.h.

template<class CoordType = unsigned int>
sava::spatial::Point2D< CoordType >::Point2D (  const coordinate_type &  x,
const coordinate_type &  y
)  [inline]
 

Definition at line 313 of file Point.h.

Member Function Documentation

static const unsigned int sava::spatial::Point< Dimensions, CoordType >::dimensions (   )  [inline, static, inherited]
 

Returns the number of dimensions in the point.

Returns:
The number of dimensions in the point.

Definition at line 103 of file Point.h.

const coordinate_type& sava::spatial::Point< Dimensions, CoordType >::operator[] (  const unsigned int  index  )  const [inline, inherited]
 

Returns the coordinate at the specified index as a const reference.

Parameters:
index The index of the coordinate to retrieve.
Returns:
The coordinate at the specified index.

Definition at line 137 of file Point.h.

coordinate_type& sava::spatial::Point< Dimensions, CoordType >::operator[] (  const unsigned int  index  )  [inline, inherited]
 

Returns the coordinate at the specified index.

Parameters:
index The index of the coordinate to retrieve.
Returns:
The coordinate at the specified index.

Definition at line 127 of file Point.h.

sava::spatial::Point< Dimensions, CoordType >::Point (   )  [inline, inherited]
 

Constructs a point with all coordinate values set to zero.

Definition at line 115 of file Point.h.

The documentation for this class was generated from the following file:
Savarese Software Research
Copyright © 2003-2005 Savarese Software Research and Daniel F. Savarese. All rights reserved.