CGAL 4.7 - dD Spatial Searching: CGAL::Distance_adapter< Key, PointPropertyMap, Base_distance > 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
CGAL::Distance_adapter< Key, PointPropertyMap, Base_distance > Class Template Reference
Distance Classes

`#include <CGAL/Search_traits_adapter.h>`

## Inherits from

Base_distance.

## Definition

A class that uses a point property map to adapt a distance class to work on a key as point type.

When using `Search_traits_adapter<Key,PointPropertyMap,BaseTraits>` in a nearest neighbor search algorithm, this class must be used as distance.

Template Parameters

  Key | is a type that is associated to a point of type `Base_distance::Point_d`.
  PointPropertyMap | is a model of `LvaluePropertyMap` with `Key` as key type and `Base_distance::Point_d` as value type.
  Base_distance | is a model of either `GeneralDistance` or `OrthogonalDistance`.

Is Model Of:

  `GeneralDistance` if Base_distance is a model of `GeneralDistance`

  `OrthogonalDistance` if Base_distance is a model of `OrthogonalDistance`

See Also
  `Search_traits_adapter<Key,PointPropertyMap,BaseTraits>`

## Types

typedef Base_distance::FT | FT
typedef Key | Point_d
typedef Base_distance::Query_item | Query_item

## Creation

| Distance_adapter (const PointPropertyMap &ppmap=PointPropertyMap(), const Base_distance &base=Base_distance())
| Constructor initializing the class to `base` and setting the point property map of the class to `ppmap`.

## Operations

const PointPropertyMap & | point_property_map () const
| Returns the point property map.