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

## Member functions

### HardtanhOptions() {#HardtanhOptions}

<div class="api-signature">

**`HardtanhOptions`**() `=default`

</div>

<div class="api-declared">

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

</div>

### HardtanhOptions(double, double) {#HardtanhOptions-2}

<div class="api-signature">

`explicit` **`HardtanhOptions`**(`double` `min_val`, `double` `max_val` `=` `1.0`)

</div>

`HardtanhOptions(min_val, max_val)`: the positional form.

<div class="api-declared">

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

</div>

### min\_val(double) {#min_val}

<div class="api-signature">

[`HardtanhOptions`](./HardtanhOptions.md)`&` **`min_val`**(`double` `v`)

</div>

Sets [`min_val`](./HardtanhOptions.md#min_val), the lower bound.

<div class="api-declared">

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

</div>

### min\_val() {#min_val-2}

<div class="api-signature">

`double` **`min_val`**() `const`

</div>

Reads [`min_val`](./HardtanhOptions.md#min_val).

<div class="api-declared">

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

</div>

### max\_val(double) {#max_val}

<div class="api-signature">

[`HardtanhOptions`](./HardtanhOptions.md)`&` **`max_val`**(`double` `v`)

</div>

Sets [`max_val`](./HardtanhOptions.md#max_val), the upper bound.

<div class="api-declared">

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

</div>

### max\_val() {#max_val-2}

<div class="api-signature">

`double` **`max_val`**() `const`

</div>

Reads [`max_val`](./HardtanhOptions.md#max_val).

<div class="api-declared">

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

</div>

### inplace(bool) {#inplace}

<div class="api-signature">

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

</div>

Sets [`inplace`](./HardtanhOptions.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 770

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

## Data members

### min\_val\_ {#min_val_}

<div class="api-signature">

`double` **`min_val_`** `= -1.0`

</div>

The lower bound. Default `-1.0`.

<div class="api-declared">

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

</div>

### max\_val\_ {#max_val_}

<div class="api-signature">

`double` **`max_val_`** `= 1.0`

</div>

The upper bound. Default `1.0`.

<div class="api-declared">

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

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

</div>