de.lmu.ifi.dbs.elki.index.preprocessed.preference

Class HiSCPreferenceVectorIndex.Factory<V extends NumberVector<?,?>>

java.lang.Object

de.lmu.ifi.dbs.elki.index.preprocessed.preference.AbstractPreferenceVectorIndex.Factory<V,HiSCPreferenceVectorIndex<V>>

de.lmu.ifi.dbs.elki.index.preprocessed.preference.HiSCPreferenceVectorIndex.Factory<V>

Type Parameters:

V - Vector type

All Implemented Interfaces:

IndexFactory<V,HiSCPreferenceVectorIndex<V>>, PreferenceVectorIndex.Factory<V,HiSCPreferenceVectorIndex<V>>, InspectionUtilFrequentlyScanned, Parameterizable

Enclosing class:

HiSCPreferenceVectorIndex<V extends NumberVector<?,?>>

public static class HiSCPreferenceVectorIndex.Factory<V extends NumberVector<?,?>>
extends AbstractPreferenceVectorIndex.Factory<V,HiSCPreferenceVectorIndex<V>>

Factory class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HiSCPreferenceVectorIndex.Factory.Parameterizer<V extends NumberVector<?,?>> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	alpha Holds the value of parameter ALPHA_ID.
static OptionID	ALPHA_ID The maximum absolute variance along a coordinate axis.
static double	DEFAULT_ALPHA The default value for alpha.
protected Integer	k Holds the value of parameter K_ID.
static OptionID	K_ID The number of nearest neighbors considered to determine the preference vector.

Constructor Summary

Constructors

Constructor and Description
HiSCPreferenceVectorIndex.Factory(double alpha, Integer k) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
HiSCPreferenceVectorIndex<V>	instantiate(Relation<V> relation) Instantiate the index for a given database.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.preference.AbstractPreferenceVectorIndex.Factory

getInputTypeRestriction

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALPHA

public static final double DEFAULT_ALPHA

The default value for alpha.

See Also:

Constant Field Values

ALPHA_ID

public static final OptionID ALPHA_ID

The maximum absolute variance along a coordinate axis. Must be in the range of [0.0, 1.0).

Default value: DEFAULT_ALPHA

Key: -hisc.alpha

K_ID

public static final OptionID K_ID

The number of nearest neighbors considered to determine the preference vector. If this value is not defined, k is set to three times of the dimensionality of the database objects.

Key: -hisc.k

Default value: three times of the dimensionality of the database objects

alpha

protected double alpha

Holds the value of parameter ALPHA_ID.

k

protected Integer k

Holds the value of parameter K_ID.

Constructor Detail

HiSCPreferenceVectorIndex.Factory

public HiSCPreferenceVectorIndex.Factory(double alpha,
                                 Integer k)

Constructor.

Parameters:

alpha - Alpha

k - k

Method Detail

instantiate

public HiSCPreferenceVectorIndex<V> instantiate(Relation<V> relation)

Description copied from interface: PreferenceVectorIndex.Factory

Instantiate the index for a given database.

Specified by:

instantiate in interface IndexFactory<V extends NumberVector<?,?>,HiSCPreferenceVectorIndex<V extends NumberVector<?,?>>>

Specified by:

instantiate in interface PreferenceVectorIndex.Factory<V extends NumberVector<?,?>,HiSCPreferenceVectorIndex<V extends NumberVector<?,?>>>

Specified by:

instantiate in class AbstractPreferenceVectorIndex.Factory<V extends NumberVector<?,?>,HiSCPreferenceVectorIndex<V extends NumberVector<?,?>>>

Parameters:

relation - Relation to use

Returns:

Index