org.openimaj.tools.clusterquantiser.fastkmeans

Enum ByteKMeansInitialisers

java.lang.Object

java.lang.Enum<ByteKMeansInitialisers>

org.openimaj.tools.clusterquantiser.fastkmeans.ByteKMeansInitialisers

All Implemented Interfaces:

Serializable, Comparable<ByteKMeansInitialisers>, CmdLineOptionsProvider

public enum ByteKMeansInitialisers
extends Enum<ByteKMeansInitialisers>
implements CmdLineOptionsProvider

Initialisation options for k-means.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ByteKMeansInitialisers.Options Base options for FastByteKMeansInitialisers types

Enum Constant Summary

Enum Constants

Enum Constant and Description
RANDOM Randomly sampled points to start
RANDOMSETCLUSTER Start from provided centroids

Method Summary

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

RANDOM

public static final ByteKMeansInitialisers RANDOM

Randomly sampled points to start

RANDOMSETCLUSTER

public static final ByteKMeansInitialisers RANDOMSETCLUSTER

Start from provided centroids

Method Detail

values

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

Returns:

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

valueOf

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

getOptions

public abstract ByteKMeansInitialisers.Options getOptions()

Specified by:

getOptions in interface CmdLineOptionsProvider

Returns:

the object providing options/arguments