CGAL 6.2 - dD Spatial Searching: CGAL::Distance_adapter< Key, PointPropertyMap, Base_distance > Class Template Reference

CGAL 6.2 - dD Spatial Searching

Loading...
Searching...
No Matches
List of all members
CGAL::Distance_adapter< Key, PointPropertyMap, Base_distance > Class Template Reference
Reference Manual » Distance Classes

`#include <CGAL/Search_traits_adapter.h>`

## Inherits from

Base_distance.

## Definition

template<typename Key, typename PointPropertyMap, typename Base_distance>
class CGAL::Distance_adapter< Key, PointPropertyMap, Base_distance >

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 `ReadablePropertyMap` 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.