de.lmu.ifi.dbs.elki.result

Class OrderingFromDataStore<T extends java.lang.Comparable<T>>

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.result.OrderingFromDataStore<T>

Type Parameters:

T - Data type in hash map

All Implemented Interfaces:

HierarchicalResult, OrderingResult, Result

public class OrderingFromDataStore<T extends java.lang.Comparable<T>>
extends BasicResult
implements OrderingResult

Result class providing an ordering backed by a hashmap.

Since:

0.2

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	ascending Factor for ascending (+1) and descending (-1) ordering.
protected java.util.Comparator<T>	comparator Comparator to use when sorting
protected DBIDs	ids Database IDs
protected DataStore<? extends T>	map HashMap with object values

Constructor Summary

Constructors

Constructor and Description
OrderingFromDataStore(java.lang.String name, java.lang.String shortname, DBIDs ids, DataStore<? extends T> map) Minimal Constructor
OrderingFromDataStore(java.lang.String name, java.lang.String shortname, DBIDs ids, DataStore<? extends T> map, boolean descending) Constructor without comparator
OrderingFromDataStore(java.lang.String name, java.lang.String shortname, DBIDs ids, DataStore<? extends T> map, java.util.Comparator<T> comparator, boolean descending) Constructor with comparator

Method Summary

Modifier and Type	Method and Description
DBIDs	getDBIDs() Get the full set of DBIDs this ordering is defined for.
ArrayModifiableDBIDs	order(DBIDs ids) Sort the given ids according to this ordering and return an iterator.

Methods inherited from class de.lmu.ifi.dbs.elki.result.BasicResult

getLongName, getShortName

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Field Detail

map

protected DataStore<? extends T extends java.lang.Comparable<T>> map

HashMap with object values

ids

protected DBIDs ids

Database IDs

comparator

protected java.util.Comparator<T extends java.lang.Comparable<T>> comparator

Comparator to use when sorting

ascending

int ascending

Factor for ascending (+1) and descending (-1) ordering.

Constructor Detail

OrderingFromDataStore

public OrderingFromDataStore(java.lang.String name,
                             java.lang.String shortname,
                             DBIDs ids,
                             DataStore<? extends T> map,
                             java.util.Comparator<T> comparator,
                             boolean descending)

Constructor with comparator

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

ids - DBIDs included

map - data hash map

comparator - comparator to use, may be null

descending - ascending (false) or descending (true) order.

OrderingFromDataStore

public OrderingFromDataStore(java.lang.String name,
                             java.lang.String shortname,
                             DBIDs ids,
                             DataStore<? extends T> map,
                             boolean descending)

Constructor without comparator

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

ids - DBIDs included

map - data hash map

descending - ascending (false) or descending (true) order.

OrderingFromDataStore

public OrderingFromDataStore(java.lang.String name,
                             java.lang.String shortname,
                             DBIDs ids,
                             DataStore<? extends T> map)

Minimal Constructor

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

ids - DBIDs included

map - data hash map

Method Detail

getDBIDs

public DBIDs getDBIDs()

Description copied from interface: OrderingResult

Get the full set of DBIDs this ordering is defined for.

Specified by:

getDBIDs in interface OrderingResult

Returns:

DBIDs

order

public ArrayModifiableDBIDs order(DBIDs ids)

Description copied from interface: OrderingResult

Sort the given ids according to this ordering and return an iterator.

Specified by:

order in interface OrderingResult

Parameters:

ids - Collection of ids.

Returns:

iterator for sorted array of ids