Package org.neo4j.gds.scaling

Enum ScalarScaler.Variant

java.lang.Object

java.lang.Enum<ScalarScaler.Variant>

org.neo4j.gds.scaling.ScalarScaler.Variant

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScalarScaler.Variant>

Enclosing class:

ScalarScaler

public static enum ScalarScaler.Variant
extends java.lang.Enum<ScalarScaler.Variant>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTER
L1NORM
L2NORM
LOG
MAX
MEAN
MINMAX
NONE
STDSCORE

Method Summary

Modifier and Type	Method	Description
abstract ScalarScaler	create(org.neo4j.gds.api.properties.nodes.NodePropertyValues properties, long nodeCount, int concurrency, java.util.concurrent.ExecutorService executor)	Create a scaler.
static ScalarScaler.Variant	lookup(java.lang.Object name)
static java.lang.String	toString(ScalarScaler.Variant variant)
static ScalarScaler.Variant	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ScalarScaler.Variant[]	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

NONE

public static final ScalarScaler.Variant NONE

MAX

public static final ScalarScaler.Variant MAX

MINMAX

public static final ScalarScaler.Variant MINMAX

MEAN

public static final ScalarScaler.Variant MEAN

LOG

public static final ScalarScaler.Variant LOG

STDSCORE

public static final ScalarScaler.Variant STDSCORE

L1NORM

public static final ScalarScaler.Variant L1NORM

L2NORM

public static final ScalarScaler.Variant L2NORM

CENTER

public static final ScalarScaler.Variant CENTER

Method Detail

values

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

Returns:

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

valueOf

public static ScalarScaler.Variant 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

lookup

public static ScalarScaler.Variant lookup(java.lang.Object name)

toString

public static java.lang.String toString(ScalarScaler.Variant variant)

create

public abstract ScalarScaler create(org.neo4j.gds.api.properties.nodes.NodePropertyValues properties,
                                    long nodeCount,
                                    int concurrency,
                                    java.util.concurrent.ExecutorService executor)

Create a scaler. Some scalers rely on aggregate extreme values which are computed at construction time.