Package elki.algorithm

Class KNNDistancesSampler.Par<O>

java.lang.Object

elki.algorithm.KNNDistancesSampler.Par<O>

All Implemented Interfaces:

Parameterizer

Enclosing class:

KNNDistancesSampler<O>

public static class KNNDistancesSampler.Par<O>
extends java.lang.Object
implements Parameterizer

Parameterization class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
protected Distance<? super O>	distance	The distance function to use.
protected int	k	Parameter k.
static OptionID	K_ID	Parameter to specify the distance of the k-distant object to be assessed, must be an integer greater than 0.
protected double	percentage	Sampling percentage.
protected RandomFactory	rnd	Random number seeding.
static OptionID	SAMPLING_ID	Parameter to specify the average percentage of distances randomly chosen to be provided in the result, must be a double greater than 0 and less than or equal to 1.
static OptionID	SEED_ID	Random generator seed for distances.

Constructor Summary

Constructors

Constructor	Description
Par()

Method Summary

Modifier and Type	Method	Description
void	configure(Parameterization config)	Configure the class.
KNNDistancesSampler<O>	make()	Make an instance after successful configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

K_ID

public static final OptionID K_ID

Parameter to specify the distance of the k-distant object to be assessed, must be an integer greater than 0.

SAMPLING_ID

public static final OptionID SAMPLING_ID

Parameter to specify the average percentage of distances randomly chosen to be provided in the result, must be a double greater than 0 and less than or equal to 1.

SEED_ID

public static final OptionID SEED_ID

Random generator seed for distances.

distance

protected Distance<? super O> distance

The distance function to use.

k

protected int k

Parameter k.

percentage

protected double percentage

Sampling percentage.

rnd

protected RandomFactory rnd

Random number seeding.

Constructor Detail

Par

public Par()

Method Detail

configure

public void configure(Parameterization config)

Description copied from interface: Parameterizer

Configure the class.

Note: the status is collected by the parameterization object, so that multiple errors may arise and be reported in one run.

Specified by:

configure in interface Parameterizer

Parameters:

config - Parameterization

make

public KNNDistancesSampler<O> make()

Description copied from interface: Parameterizer

Make an instance after successful configuration.

Note: your class should return the exact type, only this very broad interface should use Object as return type.

Specified by:

make in interface Parameterizer

Returns:

a new instance