---
title: "ClikaRT::nn::FlattenOptions"
sidebar_label: "FlattenOptions"
description: "Settings of Flatten: 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/flatten.h`

Settings of [`Flatten`](./Flatten.md): chain the setters, or assign the fields.

## Member functions

### FlattenOptions() {#FlattenOptions}

<div class="api-signature">

**`FlattenOptions`**() `=default`

</div>

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### start\_dim(int64\_t) {#start_dim}

<div class="api-signature">

[`FlattenOptions`](./FlattenOptions.md)`&` **`start_dim`**(`std::int64_t` `v`)

</div>

Sets [`start_dim`](./FlattenOptions.md#start_dim), the first dimension to merge.

<div class="api-declared">

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

</div>

### start\_dim() {#start_dim-2}

<div class="api-signature">

`std::int64_t` **`start_dim`**() `const`

</div>

Reads [`start_dim`](./FlattenOptions.md#start_dim).

<div class="api-declared">

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

</div>

### end\_dim(int64\_t) {#end_dim}

<div class="api-signature">

[`FlattenOptions`](./FlattenOptions.md)`&` **`end_dim`**(`std::int64_t` `v`)

</div>

Sets [`end_dim`](./FlattenOptions.md#end_dim), the last dimension to merge; negative counts from the end.

<div class="api-declared">

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

</div>

### end\_dim() {#end_dim-2}

<div class="api-signature">

`std::int64_t` **`end_dim`**() `const`

</div>

Reads [`end_dim`](./FlattenOptions.md#end_dim).

<div class="api-declared">

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

</div>

## Data members

### start\_dim\_ {#start_dim_}

<div class="api-signature">

`std::int64_t` **`start_dim_`** `= 1`

</div>

The first dimension to merge. Default `1`.

<div class="api-declared">

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

</div>

### end\_dim\_ {#end_dim_}

<div class="api-signature">

`std::int64_t` **`end_dim_`** `= -1`

</div>

The last dimension to merge; negative counts from the end. Default `-1`.

<div class="api-declared">

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

</div>