de.lmu.ifi.dbs.elki.result.outlier

Class OrderingFromRelation

java.lang.Object

de.lmu.ifi.dbs.elki.result.outlier.OrderingFromRelation

All Implemented Interfaces:

OrderingResult, Result

public class OrderingFromRelation
extends java.lang.Object
implements OrderingResult

Ordering obtained from an outlier score.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ascending Factor for ascending (+1) and descending (-1) ordering.
protected DoubleRelation	scores Outlier scores.

Constructor Summary

Constructors

Constructor and Description
OrderingFromRelation(DoubleRelation scores) Ascending constructor.
OrderingFromRelation(DoubleRelation scores, boolean ascending) Constructor for outlier orderings

Method Summary

Modifier and Type	Method and Description
DBIDs	getDBIDs() Get the full set of DBIDs this ordering is defined for.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
java.lang.String	getShortName() A short name for the result, useful for file names.
ArrayModifiableDBIDs	order(DBIDs ids) Sort the given ids according to this ordering and return an iterator.

Methods inherited from class java.lang.Object

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

Field Detail

scores

protected DoubleRelation scores

Outlier scores.

ascending

protected boolean ascending

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

Constructor Detail

OrderingFromRelation

public OrderingFromRelation(DoubleRelation scores,
                            boolean ascending)

Constructor for outlier orderings

Parameters:

scores - outlier score result

ascending - Ascending when true, descending otherwise

OrderingFromRelation

public OrderingFromRelation(DoubleRelation scores)

Ascending constructor.

Parameters:

scores -

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

getLongName

public java.lang.String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public java.lang.String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name