ai.djl.nn.pooling

Enum PoolingConvention

java.lang.Object

java.lang.Enum<PoolingConvention>

ai.djl.nn.pooling.PoolingConvention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PoolingConvention>

public enum PoolingConvention
extends java.lang.Enum<PoolingConvention>

An enum that enumerates the different pooling conventions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL
VALID

Method Summary

Modifier and Type	Method and Description
long	getOutput(long input, long kernel, long stride, long pad) Computes the size of the output in the given input dimension for this PoolingConvention.
static PoolingConvention	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PoolingConvention[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALID

public static final PoolingConvention VALID

FULL

public static final PoolingConvention FULL

Method Detail

values

public static PoolingConvention[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PoolingConvention c : PoolingConvention.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PoolingConvention valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getOutput

public long getOutput(long input,
                      long kernel,
                      long stride,
                      long pad)

Computes the size of the output in the given input dimension for this PoolingConvention.

Parameters:

input - the input size in the dimension

kernel - the kernel size in the dimension

stride - the stride size in the dimension

pad - the pad size in the dimension

Returns:

the output size in the given input dimension