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

## Member functions

### AvgPool2dOptions() {#AvgPool2dOptions}

<div class="api-signature">

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

</div>

`AvgPool2dOptions(kernel_size)`: implicit, so `AvgPool2d(kernel_size)` reads like the function call.

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

Sets [`padding`](./AvgPool2dOptions.md#padding), the implicit zero padding per spatial dimension.

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### count\_include\_pad(bool) {#count_include_pad}

<div class="api-signature">

[`AvgPool2dOptions`](./AvgPool2dOptions.md)`&` **`count_include_pad`**(`bool` `v`)

</div>

Sets [`count_include_pad`](./AvgPool2dOptions.md#count_include_pad), counts padded positions in the divisor.

<div class="api-declared">

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

</div>

### count\_include\_pad() {#count_include_pad-2}

<div class="api-signature">

`bool` **`count_include_pad`**() `const`

</div>

Reads [`count_include_pad`](./AvgPool2dOptions.md#count_include_pad).

<div class="api-declared">

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

</div>

### divisor\_override(optional\<int64\_t\>) {#divisor_override}

<div class="api-signature">

[`AvgPool2dOptions`](./AvgPool2dOptions.md)`&` **`divisor_override`**(`std::optional<std::int64_t>` `v`)

</div>

Sets [`divisor_override`](./AvgPool2dOptions.md#divisor_override), a fixed divisor instead of the window count.

<div class="api-declared">

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

</div>

### divisor\_override() {#divisor_override-2}

<div class="api-signature">

`const std::optional<std::int64_t>&` **`divisor_override`**() `const`

</div>

Reads [`divisor_override`](./AvgPool2dOptions.md#divisor_override).

<div class="api-declared">

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

</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 458

</div>

### stride\_ {#stride_}

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### padding\_ {#padding_}

<div class="api-signature">

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

</div>

The implicit zero padding per spatial dimension. Default `{0, 0}`.

<div class="api-declared">

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

</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 487

</div>

### count\_include\_pad\_ {#count_include_pad_}

<div class="api-signature">

`bool` **`count_include_pad_`** `= true`

</div>

Counts padded positions in the divisor. Default `true`.

<div class="api-declared">

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

</div>

### divisor\_override\_ {#divisor_override_}

<div class="api-signature">

`std::optional<std::int64_t>` **`divisor_override_`** `= std::nullopt`

</div>

A fixed divisor instead of the window count. Default `std::nullopt`.

<div class="api-declared">

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

</div>