---
title: "ClikaRT::nn::SoftminOptions"
sidebar_label: "SoftminOptions"
description: "Settings of Softmin: 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/activation.h`

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

## Member functions

### SoftminOptions() {#SoftminOptions}

<div class="api-signature">

**`SoftminOptions`**() `=default`

</div>

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1336

</div>

### SoftminOptions(int64\_t) {#SoftminOptions-2}

<div class="api-signature">

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

</div>

`SoftminOptions(dim)`: implicit, so `Softmin(dim)` reads like the function call.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1339

</div>

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

<div class="api-signature">

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

</div>

Sets [`dim`](./SoftminOptions.md#dim), the reduction dimension; negative counts from the end.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1342

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1344

</div>

### dtype(DataType) {#dtype}

<div class="api-signature">

[`SoftminOptions`](./SoftminOptions.md)`&` **`dtype`**([`DataType`](../../index.md#DataType) `v`)

</div>

Sets [`dtype`](../dtype/index.md), the output dtype; [`DataType::Undefined`](../../index.md#DataType) keeps the input's.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1350

</div>

### dtype() {#dtype-2}

<div class="api-signature">

[`DataType`](../../index.md#DataType) **`dtype`**() `const`

</div>

Reads [`dtype`](../dtype/index.md).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1352

</div>

## Data members

### dim\_ {#dim_}

<div class="api-signature">

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

</div>

The reduction dimension; negative counts from the end. Default `-1`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1346

</div>

### dtype\_ {#dtype_}

<div class="api-signature">

[`DataType`](../../index.md#DataType) **`dtype_`** `=` [`DataType::Undefined`](../../index.md#DataType)

</div>

The output dtype; [`DataType::Undefined`](../../index.md#DataType) keeps the input's. Default [`DataType::Undefined`](../../index.md#DataType).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/activation.h`, line 1355

</div>
