de.lmu.ifi.dbs.elki.algorithm.clustering.optics

Class OPTICSXi.SteepAreaResult

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.clustering.optics.OPTICSXi.SteepAreaResult

All Implemented Interfaces:

IterableResult<OPTICSXi.SteepArea>, Result, Iterable<OPTICSXi.SteepArea>

Enclosing class:

OPTICSXi

public static class OPTICSXi.SteepAreaResult
extends Object
implements IterableResult<OPTICSXi.SteepArea>

Result containing the chi-steep areas.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Collection<OPTICSXi.SteepArea>	areas Storage

Constructor Summary

Constructors

Constructor and Description
SteepAreaResult(Collection<OPTICSXi.SteepArea> areas) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
String	getShortName() A short name for the result, useful for file names.
Iterator<OPTICSXi.SteepArea>	iterator() Retrieve an iterator for the result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

areas

Collection<OPTICSXi.SteepArea> areas

Storage

Constructor Detail

SteepAreaResult

public SteepAreaResult(Collection<OPTICSXi.SteepArea> areas)

Constructor.

Parameters:

areas - Areas

Method Detail

getLongName

public 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 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

iterator

public Iterator<OPTICSXi.SteepArea> iterator()

Description copied from interface: IterableResult

Retrieve an iterator for the result.

Specified by:

iterator in interface IterableResult<OPTICSXi.SteepArea>

Specified by:

iterator in interface Iterable<OPTICSXi.SteepArea>

Returns:

iterator