---
title: "ClikaRT::nn::ConstantPadOptions"
sidebar_label: "ConstantPadOptions"
description: "Settings of ConstantPad: 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/padding.h`

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

## Member functions

### ConstantPadOptions() {#ConstantPadOptions}

<div class="api-signature">

`explicit` **`ConstantPadOptions`**(<br />
&nbsp;&nbsp;&nbsp;&nbsp;`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `padding`,<br />
&nbsp;&nbsp;&nbsp;&nbsp;`std::optional<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `value` `=` `std::nullopt`<br />
)

</div>

`ConstantPadOptions(padding, value)`: the positional form.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 38

</div>

### padding(vector\<ScalarOrTensor\>) {#padding}

<div class="api-signature">

[`ConstantPadOptions`](./ConstantPadOptions.md)`&` **`padding`**(`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `v`)

</div>

Sets [`padding`](./ConstantPadOptions.md#padding), the `(low, high)` widths per axis, leading axis first; a negative width crops.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 44

</div>

### padding() {#padding-2}

<div class="api-signature">

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

</div>

Reads [`padding`](./ConstantPadOptions.md#padding).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 49

</div>

### value(optional\<ScalarOrTensor\>) {#value}

<div class="api-signature">

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

</div>

Sets [`value`](./ConstantPadOptions.md#value), the fill value; unset fills with 0.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 55

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 60

</div>

## Data members

### padding\_ {#padding_}

<div class="api-signature">

`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` **`padding_`**

</div>

The `(low, high)` widths per axis, leading axis first; a negative width crops. Required: set through the constructor.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 52

</div>

### value\_ {#value_}

<div class="api-signature">

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

</div>

The fill value; unset fills with 0. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/padding.h`, line 62

</div>