Package elki.distance.external

Class FileBasedSparseFloatDistance.Par

java.lang.Object

elki.distance.external.FileBasedSparseFloatDistance.Par

All Implemented Interfaces:

Parameterizer

Enclosing class:

FileBasedSparseFloatDistance

public static class FileBasedSparseFloatDistance.Par
extends java.lang.Object
implements Parameterizer

Parameterization class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
static OptionID	DEFAULTDIST_ID	Optional parameter to specify the distance to return when no distance was given in the file.
protected float	defaultDistance	Distance to return when not defined otherwise.
static OptionID	MATRIX_ID	Parameter that specifies the name of the distance matrix file.
protected java.net.URI	matrixfile	Input file.
protected DistanceParser	parser	Parser for input file.
static OptionID	PARSER_ID	Optional parameter to specify the parsers to provide a database, must extend DistanceParser.

Constructor Summary

Constructors

Constructor	Description
Par()

Method Summary

Modifier and Type	Method	Description
void	configure(Parameterization config)	Configure the class.
FileBasedSparseFloatDistance	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

MATRIX_ID

public static final OptionID MATRIX_ID

Parameter that specifies the name of the distance matrix file.

PARSER_ID

public static final OptionID PARSER_ID

Optional parameter to specify the parsers to provide a database, must extend DistanceParser. If this parameter is not set, AsciiDistanceParser is used as parser for all input files.

DEFAULTDIST_ID

public static final OptionID DEFAULTDIST_ID

Optional parameter to specify the distance to return when no distance was given in the file. Defaults to infinity.

matrixfile

protected java.net.URI matrixfile

Input file.

parser

protected DistanceParser parser

Parser for input file.

defaultDistance

protected float defaultDistance

Distance to return when not defined otherwise.

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 FileBasedSparseFloatDistance 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