PoolingType (wekaDeeplearning4j 1.7.2 API)

java.lang.Object
- java.lang.Enum<PoolingType>
- - weka.dl4j.enums.PoolingType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PoolingType>, ApiWrapper<org.deeplearning4j.nn.conf.layers.PoolingType>
```
public enum PoolingType
extends java.lang.Enum<PoolingType>
implements ApiWrapper<org.deeplearning4j.nn.conf.layers.PoolingType>
```
Proxy Enum for PoolingType. This is necessary as Weka's run script cannot find the enum classes during the option parsing as they reside in the Dl4j backend and are at that time not visible to the class loader.

Enum Constant Summary

Enum Constants
Enum Constant and Description

AVG
Average pooling.

MAX
Max pooling.

MIN
Min pooling.

NONE
No pooling.

PNORM
PNorm pooling.

SUM
Additive pooling.

Enum Constants
Enum Constant and Description
`AVG` Average pooling.
`MAX` Max pooling.
`MIN` Min pooling.
`NONE` No pooling.
`PNORM` PNorm pooling.
`SUM` Additive pooling.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PoolingType`	`fromBackend(org.deeplearning4j.nn.conf.layers.PoolingType poolingType)` Parse backend pooling type and return weka enum implementation.
`org.deeplearning4j.nn.conf.layers.PoolingType`	`getBackend()` Access the DL4J backend.
`void`	`initializeBackend()` Initialize the DL4J backend.
`boolean`	`isCustom()` NONE and MIN are not DL4J pooling types, only used for pooling activations
`void`	`setBackend(org.deeplearning4j.nn.conf.layers.PoolingType newBackend)` Set the DL4J backend.
`static PoolingType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PoolingType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MAX
```
public static final PoolingType MAX
```
    Max pooling.
  - AVG
```
public static final PoolingType AVG
```
    Average pooling.
  - SUM
```
public static final PoolingType SUM
```
    Additive pooling.
  - PNORM
```
public static final PoolingType PNORM
```
    PNorm pooling.
  - NONE
```
public static final PoolingType NONE
```
    No pooling.
  - MIN
```
public static final PoolingType MIN
```
    Min pooling.
- Method Detail
  - values
```
public static PoolingType[] 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 (PoolingType c : PoolingType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PoolingType 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
  - isCustom
```
public boolean isCustom()
```
    NONE and MIN are not DL4J pooling types, only used for pooling activations
    
    Returns:
    
    true if the pooling type is custom (and not valid in DL4J)
  - fromBackend
```
public static PoolingType fromBackend(org.deeplearning4j.nn.conf.layers.PoolingType poolingType)
```
    Parse backend pooling type and return weka enum implementation.
    
    Parameters:
    
    poolingType - Pooling type
    
    Returns:
    
    Weka pooling type enum implementation
  - getBackend
```
public org.deeplearning4j.nn.conf.layers.PoolingType getBackend()
```
    Description copied from interface: ApiWrapper
    
    Access the DL4J backend.
    
    Specified by:
    
    getBackend in interface ApiWrapper<org.deeplearning4j.nn.conf.layers.PoolingType>
    
    Returns:
    
    DL4J backend for this wrapper
  - setBackend
```
public void setBackend(org.deeplearning4j.nn.conf.layers.PoolingType newBackend)
```
    Description copied from interface: ApiWrapper
    
    Set the DL4J backend.
    
    Specified by:
    
    setBackend in interface ApiWrapper<org.deeplearning4j.nn.conf.layers.PoolingType>
    
    Parameters:
    
    newBackend - Backend that should be wrapped by this class
  - initializeBackend
```
public void initializeBackend()
```
    Description copied from interface: ApiWrapper
    
    Initialize the DL4J backend.
    
    Specified by:
    
    initializeBackend in interface ApiWrapper<org.deeplearning4j.nn.conf.layers.PoolingType>

Enum PoolingType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MAX

AVG

SUM

PNORM

NONE

MIN

Method Detail

values

valueOf

isCustom

fromBackend

getBackend

setBackend

initializeBackend