---
title: "ClikaRT::nn::PairwiseDistanceOptions"
sidebar_label: "PairwiseDistanceOptions"
description: "Settings of PairwiseDistance: chain the setters, or assign the fields."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--struct">struct</span>

**Header:** `ClikaRT/nn/generated/distance.h`

Settings of [`PairwiseDistance`](./PairwiseDistance.md): chain the setters, or assign the fields.

## Member functions

### PairwiseDistanceOptions() {#PairwiseDistanceOptions}

<div class="api-signature">

**`PairwiseDistanceOptions`**() `=default`

</div>

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 102

</div>

### PairwiseDistanceOptions(Scalar) {#PairwiseDistanceOptions-2}

<div class="api-signature">

**`PairwiseDistanceOptions`**([`Scalar`](../Scalar.md) `p`)

</div>

`PairwiseDistanceOptions(p)`: implicit, so `PairwiseDistance(p)` reads like the function call.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 105

</div>

### p(Scalar) {#p}

<div class="api-signature">

[`PairwiseDistanceOptions`](./PairwiseDistanceOptions.md)`&` **`p`**([`Scalar`](../Scalar.md) `v`)

</div>

Sets [`p`](./PairwiseDistanceOptions.md#p), the norm degree; an integer keeps its kind.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 108

</div>

### p() {#p-2}

<div class="api-signature">

[`Scalar`](../Scalar.md) **`p`**() `const`

</div>

Reads [`p`](./PairwiseDistanceOptions.md#p).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 110

</div>

### eps(optional\<double\>) {#eps}

<div class="api-signature">

[`PairwiseDistanceOptions`](./PairwiseDistanceOptions.md)`&` **`eps`**(`std::optional<double>` `v`)

</div>

Sets [`eps`](./PairwiseDistanceOptions.md#eps), the perturbation added before the norm; unset is 1e-6.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 115

</div>

### eps() {#eps-2}

<div class="api-signature">

`const std::optional<double>&` **`eps`**() `const`

</div>

Reads [`eps`](./PairwiseDistanceOptions.md#eps).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 120

</div>

### keepdim(bool) {#keepdim}

<div class="api-signature">

[`PairwiseDistanceOptions`](./PairwiseDistanceOptions.md)`&` **`keepdim`**(`bool` `v`)

</div>

Sets [`keepdim`](./PairwiseDistanceOptions.md#keepdim), keeps the reduced axis as size 1.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 126

</div>

### keepdim() {#keepdim-2}

<div class="api-signature">

`bool` **`keepdim`**() `const`

</div>

Reads [`keepdim`](./PairwiseDistanceOptions.md#keepdim).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 128

</div>

## Data members

### p\_ {#p_}

<div class="api-signature">

[`Scalar`](../Scalar.md) **`p_`** `= 2.0`

</div>

The norm degree; an integer keeps its kind. Default `2.0`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 112

</div>

### eps\_ {#eps_}

<div class="api-signature">

`std::optional<double>` **`eps_`** `= std::nullopt`

</div>

The perturbation added before the norm; unset is 1e-6. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 123

</div>

### keepdim\_ {#keepdim_}

<div class="api-signature">

`bool` **`keepdim_`** `= false`

</div>

Keeps the reduced axis as size 1. Default `false`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/distance.h`, line 130

</div>