---
title: "ClikaRT::nn::MaxPool2dOptions"
sidebar_label: "MaxPool2dOptions"
description: "Settings of MaxPool2d: 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/pooling.h`

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

## Member functions

### MaxPool2dOptions() {#MaxPool2dOptions}

<div class="api-signature">

**`MaxPool2dOptions`**(`std::vector<std::int64_t>` `kernel_size`)

</div>

`MaxPool2dOptions(kernel_size)`: implicit, so `MaxPool2d(kernel_size)` reads like the function call.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 142

</div>

### kernel\_size(vector\<int64\_t\>) {#kernel_size}

<div class="api-signature">

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

</div>

Sets [`kernel_size`](./MaxPool2dOptions.md#kernel_size), the window extent per spatial dimension.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 146

</div>

### kernel\_size() {#kernel_size-2}

<div class="api-signature">

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

</div>

Reads [`kernel_size`](./MaxPool2dOptions.md#kernel_size).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 151

</div>

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

<div class="api-signature">

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

</div>

Sets [`stride`](./MaxPool2dOptions.md#stride), the window step per spatial dimension; empty takes [`kernel_size`](./MaxPool2dOptions.md#kernel_size).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 158

</div>

### stride() {#stride-2}

<div class="api-signature">

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

</div>

Reads [`stride`](./MaxPool2dOptions.md#stride).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 163

</div>

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

<div class="api-signature">

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

</div>

Sets [`padding`](./MaxPool2dOptions.md#padding), the implicit padding per spatial dimension; padded positions never win.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 170

</div>

### padding() {#padding-2}

<div class="api-signature">

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

</div>

Reads [`padding`](./MaxPool2dOptions.md#padding).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 175

</div>

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

<div class="api-signature">

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

</div>

Sets [`dilation`](./MaxPool2dOptions.md#dilation), the element spacing inside the window.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 181

</div>

### dilation() {#dilation-2}

<div class="api-signature">

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

</div>

Reads [`dilation`](./MaxPool2dOptions.md#dilation).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 186

</div>

### ceil\_mode(bool) {#ceil_mode}

<div class="api-signature">

[`MaxPool2dOptions`](./MaxPool2dOptions.md)`&` **`ceil_mode`**(`bool` `v`)

</div>

Sets [`ceil_mode`](./MaxPool2dOptions.md#ceil_mode), rounds the output extents up instead of down.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 191

</div>

### ceil\_mode() {#ceil_mode-2}

<div class="api-signature">

`bool` **`ceil_mode`**() `const`

</div>

Reads [`ceil_mode`](./MaxPool2dOptions.md#ceil_mode).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 193

</div>

## Data members

### kernel\_size\_ {#kernel_size_}

<div class="api-signature">

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

</div>

The window extent per spatial dimension. Required: set through the constructor.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 154

</div>

### stride\_ {#stride_}

<div class="api-signature">

`std::vector<std::int64_t>` **`stride_`** `= {}`

</div>

The window step per spatial dimension; empty takes [`kernel_size`](./MaxPool2dOptions.md#kernel_size). Default `{}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 166

</div>

### padding\_ {#padding_}

<div class="api-signature">

`std::vector<std::int64_t>` **`padding_`** `= {0, 0}`

</div>

The implicit padding per spatial dimension; padded positions never win. Default `{0, 0}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 178

</div>

### dilation\_ {#dilation_}

<div class="api-signature">

`std::vector<std::int64_t>` **`dilation_`** `= {1, 1}`

</div>

The element spacing inside the window. Default `{1, 1}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 188

</div>

### ceil\_mode\_ {#ceil_mode_}

<div class="api-signature">

`bool` **`ceil_mode_`** `= false`

</div>

Rounds the output extents up instead of down. Default `false`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pooling.h`, line 195

</div>