de.lmu.ifi.dbs.elki.distance.distancefunction.external

Class NumberDistanceParser<D extends NumberDistance<D,?>>

java.lang.Object

de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

de.lmu.ifi.dbs.elki.distance.distancefunction.external.NumberDistanceParser<D>

Type Parameters:

D - distance type

All Implemented Interfaces:

DistanceParser<D>

@Title(value="Number Distance Parser")
@Description(value="Parser for the following line format:\nid1 id2 distanceValue, where id1 and is2 are integers representing the two ids belonging to the distance value.\n The ids and the distance value are separated by whitespace. Empty lines and lines beginning with \"#\" will be ignored.")
public class NumberDistanceParser<D extends NumberDistance<D,?>>
extends AbstractParser
implements DistanceParser<D>

Provides a parser for parsing one distance value per line.

A line must have the following format: id1 id2 distanceValue, where id1 and id2 are integers representing the two ids belonging to the distance value. Lines starting with "#" will be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumberDistanceParser.Parameterizer<D extends NumberDistance<D,?>> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
private D	distanceFactory The distance function.
private static Logging	LOG The logger for this class.

Fields inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

ATTRIBUTE_CONCATENATION, comment, COMMENT_PATTERN, DEFAULT_SEPARATOR, NUMBER_PATTERN, QUOTE_CHARS, tokenizer

Fields inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.external.DistanceParser

DISTANCE_ID

Constructor Summary

Constructors

Constructor and Description
NumberDistanceParser(Pattern colSep, String quoteChars, Pattern comment, D distanceFactory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(DBIDRef id1, DBIDRef id2, Map<DBIDPair,D> cache) Returns true if the specified distance cache contains a distance value for the specified ids.
protected Logging	getLogger() Get the logger for this class.
DistanceParsingResult<D>	parse(InputStream in) Returns a list of the objects parsed from the specified input stream and a list of the labels associated with the objects.
private void	put(DBID id1, DBID id2, D distance, Map<DBIDPair,D> cache) Puts the specified distance value for the given ids to the distance cache.

Methods inherited from class de.lmu.ifi.dbs.elki.datasource.parser.AbstractParser

lengthWithoutLinefeed, toString

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

The logger for this class.

distanceFactory

private final D extends NumberDistance<D,?> distanceFactory

The distance function.

Constructor Detail

NumberDistanceParser

public NumberDistanceParser(Pattern colSep,
                    String quoteChars,
                    Pattern comment,
                    D distanceFactory)

Constructor.

Parameters:

colSep - Column separator pattern

quoteChars - Quote characters

comment - Comment pattern

distanceFactory - Distance factory to use

Method Detail

parse

public DistanceParsingResult<D> parse(InputStream in)

Description copied from interface: DistanceParser

Returns a list of the objects parsed from the specified input stream and a list of the labels associated with the objects.

Specified by:

parse in interface DistanceParser<D extends NumberDistance<D,?>>

Parameters:

in - the stream to parse objects from

Returns:

a list containing those objects parsed from the input stream and their associated labels.

put

private void put(DBID id1,
       DBID id2,
       D distance,
       Map<DBIDPair,D> cache)

Puts the specified distance value for the given ids to the distance cache.

Parameters:

id1 - the first id

id2 - the second id

distance - the distance value

cache - the distance cache

containsKey

public boolean containsKey(DBIDRef id1,
                  DBIDRef id2,
                  Map<DBIDPair,D> cache)

Returns true if the specified distance cache contains a distance value for the specified ids.

Parameters:

id1 - the first id

id2 - the second id

cache - the distance cache

Returns:

true if this cache contains a distance value for the specified ids, false otherwise

getLogger

protected Logging getLogger()

Description copied from class: AbstractParser

Get the logger for this class.

Specified by:

getLogger in class AbstractParser

Returns:

Logger.