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

## Member functions

### CircularPadOptions() {#CircularPadOptions}

<div class="api-signature">

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

</div>

`CircularPadOptions(padding)`: implicit, so `CircularPad(padding)` reads like the function call.

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

Sets [`padding`](./CircularPadOptions.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 236

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

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

</div>