---
title: "ClikaRT::nn::CircularPad"
sidebar_label: "CircularPad"
description: "Pads by wrapping around the axis. The module form of ClikaRT::ops::circular_pad, which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--class">class</span>

**Header:** `ClikaRT/nn/generated/padding.h`  
**Inherits:** [`ClikaRT::nn::Module`](./Module.md)

Pads by wrapping around the axis. The module form of [`ClikaRT::ops::circular_pad`](../ops/circular_pad.md#circular_pad), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### CircularPad(CircularPadOptions) {#CircularPad}

<div class="api-signature">

`explicit` **`CircularPad`**([`CircularPadOptions`](./CircularPadOptions.md) `options`)

</div>

Constructs the module from [`options`](./CircularPad.md#options).

<div class="api-declared">

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

</div>

### CircularPad(vector\<ScalarOrTensor\>) {#CircularPad-2}

<div class="api-signature">

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

</div>

`CircularPad(padding)`: the positional form of `CircularPadOptions(padding)`.

<div class="api-declared">

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

</div>

### forward() {#forward}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`forward`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

[`forward_impl`](./CircularPad.md#forward), unwrapped: raises [`ClikaRT::Error`](../Error.md) on failure.

<div class="api-declared">

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

</div>

### operator()() {#operator-call}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`operator()`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

Same as [`forward`](./CircularPad.md#forward).

<div class="api-declared">

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

</div>

### options() {#options}

<div class="api-signature">

`const` [`CircularPadOptions`](./CircularPadOptions.md)`&` **`options`**() `const`

</div>

The settings this module was constructed with.

<div class="api-declared">

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

</div>