---
title: "ClikaRT::nn::UnflattenOptions"
sidebar_label: "UnflattenOptions"
description: "Settings of Unflatten: 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 [`Unflatten`](./Unflatten.md): chain the setters, or assign the fields.

## Member functions

### UnflattenOptions() {#UnflattenOptions}

<div class="api-signature">

`explicit` **`UnflattenOptions`**(`std::int64_t` `dim`, `std::vector<std::int64_t>` `sizes`)

</div>

`UnflattenOptions(dim, sizes)`: the positional form.

<div class="api-declared">

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

</div>

### dim(int64\_t) {#dim}

<div class="api-signature">

[`UnflattenOptions`](./UnflattenOptions.md)`&` **`dim`**(`std::int64_t` `v`)

</div>

Sets [`dim`](./UnflattenOptions.md#dim), the dimension to split; negative counts from the end.

<div class="api-declared">

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

</div>

### dim() {#dim-2}

<div class="api-signature">

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

</div>

Reads [`dim`](./UnflattenOptions.md#dim).

<div class="api-declared">

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

</div>

### sizes(vector\<int64\_t\>) {#sizes}

<div class="api-signature">

[`UnflattenOptions`](./UnflattenOptions.md)`&` **`sizes`**(`std::vector<std::int64_t>` `v`)

</div>

Sets [`sizes`](./UnflattenOptions.md#sizes), the extents the dimension splits into.

<div class="api-declared">

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

</div>

### sizes() {#sizes-2}

<div class="api-signature">

`const std::vector<std::int64_t>&` **`sizes`**() `const`

</div>

Reads [`sizes`](./UnflattenOptions.md#sizes).

<div class="api-declared">

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

</div>

## Data members

### dim\_ {#dim_}

<div class="api-signature">

`std::int64_t` **`dim_`**

</div>

The dimension to split; negative counts from the end. Required: set through the constructor.

<div class="api-declared">

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

</div>

### sizes\_ {#sizes_}

<div class="api-signature">

`std::vector<std::int64_t>` **`sizes_`**

</div>

The extents the dimension splits into. Required: set through the constructor.

<div class="api-declared">

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

</div>