CGAL 4.7 - dD Spatial Searching: CGAL::Kd_tree_rectangle< FT, Dimension > Class Template Reference

\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \) \( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \) \( \def\ccSum #1#2#3{ \sum_{#1}^{#2}{#3} } \def\ccProd #1#2#3{ \sum_{#1}^{#2}{#3} }\)

CGAL 4.7 - dD Spatial Searching

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
List of all members | Related Functions
CGAL::Kd_tree_rectangle< FT, Dimension > Class Template Reference
Advanced Classes

`#include <CGAL/Kd_tree_rectangle.h>`

## Definition

The class `Kd_tree_rectangle` implements `d`-dimensional iso-rectangles and related operations, e.g., methods to compute bounding boxes of point sets.

Examples:
  Spatial_searching/Distance.h.

## Related Functions

(Note that these are not member functions.)
template<class FT >
std::ostream & | operator<< (std::ostream &s, Kd_tree_rectangle< FT > &r)
| Inserts rectangle `r` in the output stream `s` and returns `s`.

## Types

typedef Dimension | Dimension
| Dimension type. More...
typedef FT | FT
| Number type.

## Creation

| Kd_tree_rectangle (int d)
| Constructs a `d`-dimensional rectangle `r` with lower bound and upper bound set to zero in each dimension.
template<class Construct_cartesian_const_iterator_d , class PointIter >
| Kd_tree_rectangle (int d, PointIter begin, PointIter end, const Construct_cartesian_const_iterator_d &construct_it)
| Constructs the bounding box of the points in the range `[begin,end)`, where the value type of `PointIter` can be used by operators of functors `Construct_cartesian_const_iterator_d` to define iterators with value type `FT`.

## Operations

FT | min_coord (int i) const
| Returns the lower bound of the rectangle in dimension `i`.
FT | max_coord (int i) const
| Returns the upper bound of the rectangle in dimension `i`.
void | set_upper_bound (int i, const FT &x)
| Sets upper bound in dimension `i` to `x`.
void | set_lower_bound (int i, const FT &x)
| Sets lower bound in dimension `i` to `x`.
FT | max_span () const
| Returns the maximal span of the rectangle.
FT | max_span_coord () const
| Returns the smallest coordinate for which the rectangle has its maximal span.
int | dimension () const
| Returns the dimension of the rectangle.
void | split (Kd_tree_rectangle< FT, Dimension > &r, int d, FT value)
| Splits rectangle in dimension `d` at coordinate-value `value` by modifying itself to lower half and by modifying `r` to upper half.

## Member Typedef Documentation

template<typename FT, typename Dimension>

typedef Dimension CGAL::Kd_tree_rectangle< FT, Dimension >::Dimension

Dimension type.

Either `CGAL::Dimension_tag` or `CGAL::Dynamic_dimension_tag`.