Main Page   Modules   Namespace List   Compound List   File List   Namespace Members   Compound Members  

Box_d Class Reference

Example class for a d-dimensional axis-parallel box. More...

List of all members.

Public Types

typedef double FT
 The field type used for interval endpoints.


Public Member Functions

FT min (int d) const
 Return the smaller endpoint of the d'th interval.

FT max (int d) const
 Return the larger endpoint of the d'th interval.


Static Public Attributes

const int dimension = 3
 Specify the number of intervals comprising the box.

Detailed Description

Example class for a d-dimensional axis-parallel box.

A Box_d is a concept (in the STL and CGAL sense of the word) of a d-dimensional axis-parallel box. Any class that has the four members described on this page is a suitable model of a Box_d.

A box can be thought of as a set of d intervals, one along each axis. All you need to implement are two functions, min() and max() that return the endpoints of each interval. Additionally, the class must specify the dimension (number of intervals) of the box, and the number type (which must be a CGAL field type) of the interval endpoints.

The box is considered to be closed; i.e. each interval contains its endpoints.

Definition at line 26 of file concepts.dox.

Member Function Documentation

FT Box_d::max (  int    d )  const
 

Return the larger endpoint of the d'th interval.

Precondition:
0 <= d < dimension

FT Box_d::min (  int    d )  const
 

Return the smaller endpoint of the d'th interval.

Precondition:
0 <= d < dimension

The documentation for this class was generated from the following file:
Generated on Sun Jun 8 17:38:22 2003 for CEP::intersection by doxygen1.3-rc3