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

## Member functions

### ThresholdOptions() {#ThresholdOptions}

<div class="api-signature">

`explicit` **`ThresholdOptions`**(`double` `threshold`, `double` `value`)

</div>

`ThresholdOptions(threshold, value)`: the positional form.

<div class="api-declared">

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

</div>

### threshold(double) {#threshold}

<div class="api-signature">

[`ThresholdOptions`](./ThresholdOptions.md)`&` **`threshold`**(`double` `v`)

</div>

Sets [`threshold`](./ThresholdOptions.md#threshold), the comparison bound.

<div class="api-declared">

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

</div>

### threshold() {#threshold-2}

<div class="api-signature">

`double` **`threshold`**() `const`

</div>

Reads [`threshold`](./ThresholdOptions.md#threshold).

<div class="api-declared">

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

</div>

### value(double) {#value}

<div class="api-signature">

[`ThresholdOptions`](./ThresholdOptions.md)`&` **`value`**(`double` `v`)

</div>

Sets [`value`](./ThresholdOptions.md#value), the replacement for elements at or below the bound.

<div class="api-declared">

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

</div>

### value() {#value-2}

<div class="api-signature">

`double` **`value`**() `const`

</div>

Reads [`value`](./ThresholdOptions.md#value).

<div class="api-declared">

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

</div>

### inplace(bool) {#inplace}

<div class="api-signature">

[`ThresholdOptions`](./ThresholdOptions.md)`&` **`inplace`**(`bool` `v`)

</div>

Sets [`inplace`](./ThresholdOptions.md#inplace), whether the forward writes the result into its input and returns that input.

<div class="api-declared">

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

</div>

### inplace() {#inplace-2}

<div class="api-signature">

`bool` **`inplace`**() `const`

</div>

Reads [`inplace`](./ThresholdOptions.md#inplace).

<div class="api-declared">

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

</div>

## Data members

### threshold\_ {#threshold_}

<div class="api-signature">

`double` **`threshold_`**

</div>

The comparison bound. Required: set through the constructor.

<div class="api-declared">

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

</div>

### value\_ {#value_}

<div class="api-signature">

`double` **`value_`**

</div>

The replacement for elements at or below the bound. Required: set through the constructor.

<div class="api-declared">

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

</div>

### inplace\_ {#inplace_}

<div class="api-signature">

`bool` **`inplace_`** `= false`

</div>

Whether the forward writes the result into its input and returns that input. Default `false`.

<div class="api-declared">

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

</div>