---
title: "ClikaRT::nn::ConstantPad"
sidebar_label: "ConstantPad"
description: "Pads with a constant value. The module form of ClikaRT::ops::constant_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 with a constant value. The module form of [`ClikaRT::ops::constant_pad`](../ops/constant_pad.md#constant_pad), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### ConstantPad(ConstantPadOptions) {#ConstantPad}

<div class="api-signature">

`explicit` **`ConstantPad`**([`ConstantPadOptions`](./ConstantPadOptions.md) `options`)

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

`explicit` **`ConstantPad`**(<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>

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

<div class="api-declared">

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

</div>

### forward() {#forward}

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### options() {#options}

<div class="api-signature">

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

</div>

The settings this module was constructed with.

<div class="api-declared">

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

</div>
