---
title: "ClikaRT::nn::CosineSimilarityOptions"
sidebar_label: "CosineSimilarityOptions"
description: "Settings of CosineSimilarity: 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 [`CosineSimilarity`](./CosineSimilarity.md): chain the setters, or assign the fields.

## Member functions

### CosineSimilarityOptions() {#CosineSimilarityOptions}

<div class="api-signature">

**`CosineSimilarityOptions`**() `=default`

</div>

<div class="api-declared">

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

</div>

### CosineSimilarityOptions(int64\_t, optional\<double\>) {#CosineSimilarityOptions-2}

<div class="api-signature">

`explicit` **`CosineSimilarityOptions`**(`std::int64_t` `dim`, `std::optional<double>` `eps` `=` `std::nullopt`)

</div>

`CosineSimilarityOptions(dim, eps)`: the positional form.

<div class="api-declared">

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

</div>

### dim(int64\_t) {#dim}

<div class="api-signature">

[`CosineSimilarityOptions`](./CosineSimilarityOptions.md)`&` **`dim`**(`std::int64_t` `v`)

</div>

Sets [`dim`](./CosineSimilarityOptions.md#dim), the axis reduced by the dot product and the norms.

<div class="api-declared">

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

</div>

### dim() {#dim-2}

<div class="api-signature">

`std::int64_t` **`dim`**() `const`

</div>

Reads [`dim`](./CosineSimilarityOptions.md#dim).

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

Sets [`eps`](./CosineSimilarityOptions.md#eps), the divide-by-zero floor; unset is 1e-8.

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

## Data members

### dim\_ {#dim_}

<div class="api-signature">

`std::int64_t` **`dim_`** `= 1`

</div>

The axis reduced by the dot product and the norms. Default `1`.

<div class="api-declared">

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

</div>

### eps\_ {#eps_}

<div class="api-signature">

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

</div>

The divide-by-zero floor; unset is 1e-8. Default `std::nullopt`.

<div class="api-declared">

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

</div>