---
title: "ClikaRT::nn::MaxPool3d"
sidebar_label: "MaxPool3d"
description: "Max pooling over a 3-D window; the input is channels-last [N, D1..D3, C]."
---

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

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

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

Max pooling over a 3-D window; the input is channels-last `[N, D1..D3, C]`. The module form of [`ClikaRT::ops::max_pool3d`](../ops/max_pool3d.md#max_pool3d), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### MaxPool3d(MaxPool3dOptions) {#MaxPool3d}

<div class="api-signature">

`explicit` **`MaxPool3d`**([`MaxPool3dOptions`](./MaxPool3dOptions.md) `options`)

</div>

Constructs the module from [`options`](./MaxPool3d.md#options).

<div class="api-declared">

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

</div>

### MaxPool3d(vector\<int64\_t\>) {#MaxPool3d-2}

<div class="api-signature">

`explicit` **`MaxPool3d`**(`std::vector<std::int64_t>` `kernel_size`)

</div>

`MaxPool3d(kernel_size)`: the positional form of `MaxPool3dOptions(kernel_size)`.

<div class="api-declared">

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

</div>

### forward() {#forward}

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

### options() {#options}

<div class="api-signature">

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

</div>

The settings this module was constructed with.

<div class="api-declared">

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

</div>