Class OrderingFromRelation

  • All Implemented Interfaces:
    OrderingResult

    public class OrderingFromRelation
    extends java.lang.Object
    implements OrderingResult
    Ordering obtained from an outlier score.
    Since:
    0.4.0
    Author:
    Erich Schubert
    • Field Detail

      • 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()