---
title: "ClikaRT::nn::Flatten"
sidebar_label: "Flatten"
description: "Merges the inclusive dimension range [start_dim, end_dim] into one dimension; a view when the layout permits."
---

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

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

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

Merges the inclusive dimension range `[start_dim, end_dim]` into one dimension; a view when the layout permits. The module form of [`ClikaRT::ops::flatten`](../ops/flatten.md#flatten), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### Flatten(FlattenOptions) {#Flatten}

<div class="api-signature">

`explicit` **`Flatten`**([`FlattenOptions`](./FlattenOptions.md) `options` `=` `{}`)

</div>

Constructs the module from [`options`](./Flatten.md#options) (every default when omitted).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/flatten.h`, line 65

</div>

### Flatten(int64\_t, int64\_t) {#Flatten-2}

<div class="api-signature">

`explicit` **`Flatten`**(`std::int64_t` `start_dim`, `std::int64_t` `end_dim` `=` `-1`)

</div>

`Flatten(start_dim, end_dim)`: the positional form of `FlattenOptions(start_dim, end_dim)`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/flatten.h`, line 68

</div>

### forward() {#forward}

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/flatten.h`, line 81

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/flatten.h`, line 85

</div>

### options() {#options}

<div class="api-signature">

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

</div>

The settings this module was constructed with.

<div class="api-declared">

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

</div>