---
title: "ClikaRT::nn::PairwiseDistance"
sidebar_label: "PairwiseDistance"
description: "The p-norm of x1 - x2 + eps over the last axis, with broadcasting of the leading dimensions."
---

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

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

**Header:** `ClikaRT/nn/generated/distance.h`  
**Inherits:** [`ClikaRT::nn::Module`](./Module.md)

The p-norm of `x1 - x2 + eps` over the last axis, with broadcasting of the leading dimensions. The module form of [`ClikaRT::ops::pairwise_distance`](../ops/pairwise_distance.md#pairwise_distance), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### PairwiseDistance(PairwiseDistanceOptions) {#PairwiseDistance}

<div class="api-signature">

`explicit` **`PairwiseDistance`**([`PairwiseDistanceOptions`](./PairwiseDistanceOptions.md) `options` `=` `{}`)

</div>

Constructs the module from [`options`](./PairwiseDistance.md#options) (every default when omitted).

<div class="api-declared">

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

</div>

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

<div class="api-signature">

`explicit` **`PairwiseDistance`**([`Scalar`](../Scalar.md) `p`)

</div>

`PairwiseDistance(p)`: the positional form of `PairwiseDistanceOptions(p)`.

<div class="api-declared">

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

</div>

### forward() {#forward}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`forward`**([`Tensor`](../Tensor.md) `x1`, [`Tensor`](../Tensor.md) `x2`) `const`

</div>

[`forward_impl`](./PairwiseDistance.md#forward), unwrapped: raises [`ClikaRT::Error`](../Error.md) on failure.

<div class="api-declared">

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

</div>

### operator()() {#operator-call}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`operator()`**([`Tensor`](../Tensor.md) `x1`, [`Tensor`](../Tensor.md) `x2`) `const`

</div>

Same as [`forward`](./PairwiseDistance.md#forward).

<div class="api-declared">

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

</div>

### options() {#options}

<div class="api-signature">

`const` [`PairwiseDistanceOptions`](./PairwiseDistanceOptions.md)`&` **`options`**() `const`

</div>

The settings this module was constructed with.

<div class="api-declared">

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

</div>