---
title: "ClikaRT::nn::Fold"
sidebar_label: "Fold"
description: "Sums sliding windows [N, L, prod(kernel_size), C] back into a channels- last image [N, output_size.., C]; overlapping windows add."
---

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

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

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

Sums sliding windows `[N, L, prod(kernel_size), C]` back into a channels- last image `[N, output_size.., C]`; overlapping windows add. The module form of [`ClikaRT::ops::fold`](../ops/fold.md#fold), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### Fold(FoldOptions) {#Fold}

<div class="api-signature">

`explicit` **`Fold`**([`FoldOptions`](./FoldOptions.md) `options`)

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 115

</div>

### Fold(vector\<int64\_t\>, vector\<int64\_t\>) {#Fold-2}

<div class="api-signature">

`explicit` **`Fold`**(`std::vector<std::int64_t>` `output_size`, `std::vector<std::int64_t>` `kernel_size`)

</div>

`Fold(output_size, kernel_size)`: the positional form of `FoldOptions(output_size, kernel_size)`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 118

</div>

### forward() {#forward}

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 133

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 137

</div>

### options() {#options}

<div class="api-signature">

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

</div>

The settings this module was constructed with.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 141

</div>