org.apache.ignite.ml.knn.classification

Enum KNNStrategy

java.lang.Object

java.lang.Enum<KNNStrategy>

org.apache.ignite.ml.knn.classification.KNNStrategy

All Implemented Interfaces:

Serializable, Comparable<KNNStrategy>

public enum KNNStrategy
extends Enum<KNNStrategy>

This enum contains settings for kNN algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SIMPLE The default strategy.
WEIGHTED A refinement of the k-NN classification algorithm is to weigh the contribution of each of the k neighbors according to their distance to the query point, giving greater weight to closer neighbors.

Method Summary

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

SIMPLE

public static final KNNStrategy SIMPLE

The default strategy. All k neighbors have the same weight which is independent on their distance to the query point.

WEIGHTED

public static final KNNStrategy WEIGHTED

A refinement of the k-NN classification algorithm is to weigh the contribution of each of the k neighbors according to their distance to the query point, giving greater weight to closer neighbors.

Method Detail

values

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

Returns:

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

valueOf

public static KNNStrategy valueOf(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:

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

NullPointerException - if the argument is null