---
title: "ClikaRT::nn::ClampOptions"
sidebar_label: "ClampOptions"
description: "Settings of Clamp: 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/elementwise.h`

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

## Member functions

### ClampOptions() {#ClampOptions}

<div class="api-signature">

**`ClampOptions`**() `=default`

</div>

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 388

</div>

### ClampOptions(optional\<ScalarOrTensor\>, optional\<ScalarOrTensor\>) {#ClampOptions-2}

<div class="api-signature">

`explicit` **`ClampOptions`**(<br />
&nbsp;&nbsp;&nbsp;&nbsp;`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `min_val`,<br />
&nbsp;&nbsp;&nbsp;&nbsp;`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `max_val` `=` `std::nullopt`<br />
)

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 390

</div>

### min\_val(optional\<ScalarOrTensor\>) {#min_val}

<div class="api-signature">

[`ClampOptions`](./ClampOptions.md)`&` **`min_val`**(`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `v`)

</div>

Sets [`min_val`](./ClampOptions.md#min_val), the lower bound: a scalar or a tensor; unset leaves the side open.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 396

</div>

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

<div class="api-signature">

`const std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>&` **`min_val`**() `const`

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 401

</div>

### max\_val(optional\<ScalarOrTensor\>) {#max_val}

<div class="api-signature">

[`ClampOptions`](./ClampOptions.md)`&` **`max_val`**(`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `v`)

</div>

Sets [`max_val`](./ClampOptions.md#max_val), the upper bound: a scalar or a tensor; unset leaves the side open.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 408

</div>

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

<div class="api-signature">

`const std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>&` **`max_val`**() `const`

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 413

</div>

## Data members

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

<div class="api-signature">

`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` **`min_val_`** `= std::nullopt`

</div>

The lower bound: a scalar or a tensor; unset leaves the side open. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 404

</div>

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

<div class="api-signature">

`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` **`max_val_`** `= std::nullopt`

</div>

The upper bound: a scalar or a tensor; unset leaves the side open. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/elementwise.h`, line 416

</div>