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

## Member functions

### SoftmaxOptions() {#SoftmaxOptions}

<div class="api-signature">

**`SoftmaxOptions`**() `=default`

</div>

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

`SoftmaxOptions(dim)`: implicit, so `Softmax(dim)` reads like the function call.

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### dtype(DataType) {#dtype}

<div class="api-signature">

[`SoftmaxOptions`](./SoftmaxOptions.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 1226

</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 1228

</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 1222

</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 1231

</div>