de.lmu.ifi.dbs.elki.result
Class OrderingFromHashMap<T extends Comparable<T>>

java.lang.Object
  de.lmu.ifi.dbs.elki.result.OrderingFromHashMap<T>

Type Parameters:

T - Data type in hash map

All Implemented Interfaces:

OrderingResult, Result

public class OrderingFromHashMap<T extends Comparable<T>>
extends Object
implements OrderingResult

Result class providing an ordering backed by a hashmap.

Author:

Erich Schubert

Nested Class Summary

protected class	OrderingFromHashMap.DerivedComparator Internal comparator, accessing the map but then using the provided comparator to sort objects
protected class	OrderingFromHashMap.ImpliedComparator Internal comparator, accessing the map to sort objects

Field Summary

(package private) int	ascending Factor for ascending (+1) and descending (-1) ordering.
protected Comparator<T>	comparator Comparator to use when sorting
protected HashMap<Integer,T>	map HashMap with object values

Constructor Summary

OrderingFromHashMap(HashMap<Integer,T> map)
Minimal Constructor

OrderingFromHashMap(HashMap<Integer,T> map, boolean descending)
Constructor without comparator

OrderingFromHashMap(HashMap<Integer,T> map, Comparator<T> comparator, boolean descending)
Constructor with comparator

Method Summary

String	getName() Get a user-understandable name for this result.
IterableIterator<Integer>	iter(Collection<Integer> ids) Sort the given collection according to this map.

Methods inherited from class java.lang.Object

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

Field Detail

map

protected HashMap<Integer,T extends Comparable<T>> map

HashMap with object values

comparator

protected Comparator<T extends Comparable<T>> comparator

Comparator to use when sorting

ascending

int ascending

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

Constructor Detail

OrderingFromHashMap

public OrderingFromHashMap(HashMap<Integer,T> map,
                           Comparator<T> comparator,
                           boolean descending)

Constructor with comparator

Parameters:

map - data hash map

comparator - comparator to use, may be null

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

OrderingFromHashMap

public OrderingFromHashMap(HashMap<Integer,T> map,
                           boolean descending)

Constructor without comparator

Parameters:

map - data hash map

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

OrderingFromHashMap

public OrderingFromHashMap(HashMap<Integer,T> map)

Minimal Constructor

Parameters:

map - data hash map

Method Detail

iter

public IterableIterator<Integer> iter(Collection<Integer> ids)

Sort the given collection according to this map.

Specified by:

iter in interface OrderingResult

Parameters:

ids - Collection of ids.

Returns:

iterator for sorted array of ids

getName

public String getName()

Description copied from interface: Result

Get a user-understandable name for this result. Defaults may be returned such as "list" for a list result.

Specified by:

getName in interface Result

Returns:

result name