ai.djl.mxnet.engine

Enum GradReq

java.lang.Object

java.lang.Enum<GradReq>

ai.djl.mxnet.engine.GradReq

All Implemented Interfaces:

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

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

An enum that indicates whether gradient is required.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD
NULL
WRITE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getType() Gets the type of this GradReq.
int	getValue() Gets the value of this GradType.
static GradReq	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GradReq[]	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

NULL

public static final GradReq NULL

WRITE

public static final GradReq WRITE

ADD

public static final GradReq ADD

Method Detail

values

public static GradReq[] 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 (GradReq c : GradReq.values())
    System.out.println(c);

Returns:

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

valueOf

public static GradReq 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

getType

public java.lang.String getType()

Gets the type of this GradReq.

Returns:

the type

getValue

public int getValue()

Gets the value of this GradType.

Returns:

the value