# bm::distance_metric_descriptor Struct Reference

Distance metric descriptor, holds metric code and result. More...

`#include <bmalgo_impl.h>`

## Public Member Functions

| distance_metric_descriptor (distance_metric m)
| distance_metric_descriptor ()
void | reset ()
| Sets metric result to 0.

## Data Fields

distance_metric | metric
bm::id_t | result

## Detailed Description

Distance metric descriptor, holds metric code and result.

See also:
  distance_operation

Examples:

  sample9.cpp.

Definition at line 85 of file bmalgo_impl.h.

## Constructor & Destructor Documentation

bm::distance_metric_descriptor::distance_metric_descriptor | ( | distance_metric | m | ) | `[inline]`

Definition at line 90 of file bmalgo_impl.h.

bm::distance_metric_descriptor::distance_metric_descriptor | ( |  | ) | `[inline]`

Definition at line 94 of file bmalgo_impl.h.

## Member Function Documentation

void bm::distance_metric_descriptor::reset | ( |  | ) | `[inline]`

Sets metric result to 0.

Definition at line 102 of file bmalgo_impl.h.

References result.

## Field Documentation

distance_metric bm::distance_metric_descriptor::metric

Examples:
  sample9.cpp.

Definition at line 87 of file bmalgo_impl.h.

Referenced by bm::combine_any_operation_with_block(), bm::combine_count_operation_with_block(), and main().

bm::id_t bm::distance_metric_descriptor::result

Definition at line 88 of file bmalgo_impl.h.

Referenced by bm::any_and(), bm::any_or(), bm::any_sub(), bm::any_xor(), bm::combine_any_operation_with_block(), bm::combine_count_operation_with_block(), bm::count_or(), bm::count_sub(), bm::count_xor(), bm::distance_operation_any(), and reset().

The documentation for this struct was generated from the following file:

- bmalgo_impl.h