Skip to main content

ClikaRT::nn::AvgPool2dOptions

struct

Header: ClikaRT/nn/generated/pooling.h

Settings of AvgPool2d: chain the setters, or assign the fields.

Member functions​

AvgPool2dOptions()​

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

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

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

kernel_size(vector<int64_t>)​

AvgPool2dOptions& kernel_size(std::vector<std::int64_t> v)

Sets kernel_size, the window extent per spatial dimension.

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

kernel_size()​

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

Reads kernel_size.

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

stride(vector<int64_t>)​

AvgPool2dOptions& stride(std::vector<std::int64_t> v)

Sets stride, the window step per spatial dimension; empty takes kernel_size.

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

stride()​

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

Reads stride.

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

padding(vector<int64_t>)​

AvgPool2dOptions& padding(std::vector<std::int64_t> v)

Sets padding, the implicit zero padding per spatial dimension.

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

padding()​

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

Reads padding.

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

ceil_mode(bool)​

AvgPool2dOptions& ceil_mode(bool v)

Sets ceil_mode, rounds the output extents up instead of down.

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

ceil_mode()​

bool ceil_mode() const

Reads ceil_mode.

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

count_include_pad(bool)​

AvgPool2dOptions& count_include_pad(bool v)

Sets count_include_pad, counts padded positions in the divisor.

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

count_include_pad()​

bool count_include_pad() const

Reads count_include_pad.

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

divisor_override(optional<int64_t>)​

AvgPool2dOptions& divisor_override(std::optional<std::int64_t> v)

Sets divisor_override, a fixed divisor instead of the window count.

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

divisor_override()​

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

Reads divisor_override.

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

Data members​

kernel_size_​

std::vector<std::int64_t> kernel_size_

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

Declared in ClikaRT/nn/generated/pooling.h, line 458

stride_​

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

The window step per spatial dimension; empty takes kernel_size. Default {}.

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

padding_​

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

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

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

ceil_mode_​

bool ceil_mode_ = false

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

Declared in ClikaRT/nn/generated/pooling.h, line 487

count_include_pad_​

bool count_include_pad_ = true

Counts padded positions in the divisor. Default true.

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

divisor_override_​

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

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

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