Template Struct AvgPoolOptions

• Defined in File pooling.h

Struct Documentation

template<size_t D>
struct AvgPoolOptions

Options for a D-dimensional avgpool module.

Public Functions

inline AvgPoolOptions(ExpandingArray<D> kernel_size)

inline auto kernel_size(const ExpandingArray<D> &new_kernel_size) -> decltype(*this)

the size of the window to take an average over

inline auto kernel_size(ExpandingArray<D> &&new_kernel_size) -> decltype(*this)

inline const ExpandingArray<D> &kernel_size() const noexcept

inline ExpandingArray<D> &kernel_size() noexcept

inline auto stride(const ExpandingArray<D> &new_stride) -> decltype(*this)

the stride of the window. Default value is kernel_size

inline auto stride(ExpandingArray<D> &&new_stride) -> decltype(*this)

inline const ExpandingArray<D> &stride() const noexcept

inline ExpandingArray<D> &stride() noexcept

inline auto padding(const ExpandingArray<D> &new_padding) -> decltype(*this)

implicit zero padding to be added on both sides

inline auto padding(ExpandingArray<D> &&new_padding) -> decltype(*this)

inline const ExpandingArray<D> &padding() const noexcept

inline ExpandingArray<D> &padding() noexcept

inline auto ceil_mode(const bool &new_ceil_mode) -> decltype(*this)

when True, will use ceil instead of floor to compute the output shape

inline auto ceil_mode(bool &&new_ceil_mode) -> decltype(*this)

inline const bool &ceil_mode() const noexcept

inline bool &ceil_mode() noexcept

inline auto count_include_pad(const bool &new_count_include_pad) -> decltype(*this)

when True, will include the zero-padding in the averaging calculation

inline auto count_include_pad(bool &&new_count_include_pad) -> decltype(*this)

inline const bool &count_include_pad() const noexcept

inline bool &count_include_pad() noexcept

inline auto divisor_override(const std::optional<int64_t> &new_divisor_override) -> decltype(*this)

if specified, it will be used as divisor, otherwise size of the pooling region will be used.

inline auto divisor_override(std::optional<int64_t> &&new_divisor_override) -> decltype(*this)

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

inline std::optional<int64_t> &divisor_override() noexcept