org.deeplearning4j.models.sequencevectors.graph.enums

Enum PopularityMode

java.lang.Object

java.lang.Enum<PopularityMode>

org.deeplearning4j.models.sequencevectors.graph.enums.PopularityMode

All Implemented Interfaces:

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

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

This enum is used in PopularityWalker, and it defines which nodes will be considered for next hop. MAXIMUM: top-popularity nodes will be considered. AVERAGE: nodes in the middle of possible selections will be considered. MINIMUM: low-popularity nodes will be considered.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE
MAXIMUM
MINIMUM

Method Summary

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

MAXIMUM

public static final PopularityMode MAXIMUM

AVERAGE

public static final PopularityMode AVERAGE

MINIMUM

public static final PopularityMode MINIMUM

Method Detail

values

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

Returns:

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

valueOf

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