Package elki.result
Class EvaluationResult
- java.lang.Object
-
- elki.result.EvaluationResult
-
- All Implemented Interfaces:
TextWriteable
,java.lang.Iterable<EvaluationResult.MeasurementGroup>
- Direct Known Subclasses:
EvaluateClustering.ScoreResult
,RepresentativeUncertainClustering.RepresentativenessEvaluation
public class EvaluationResult extends java.lang.Object implements TextWriteable, java.lang.Iterable<EvaluationResult.MeasurementGroup>
Abstract evaluation result.- Since:
- 0.7.0
- Author:
- Erich Schubert
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EvaluationResult.Measurement
Class representing a single measurement.static class
EvaluationResult.MeasurementGroup
A group of evaluation measurements.
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.ArrayList<EvaluationResult.MeasurementGroup>
groups
Measurements.(package private) java.util.ArrayList<java.lang.String>
header
Header lines.static java.lang.String
RANKING
Result name for aggregating ranking evaluations.
-
Constructor Summary
Constructors Constructor Description EvaluationResult()
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHeader(java.lang.String line)
Add a header line to this result.static EvaluationResult
findOrCreate(java.lang.Object parent, java.lang.String name)
Find or create an evaluation result.EvaluationResult.MeasurementGroup
findOrCreateGroup(java.lang.String label)
Find or add a new measurement group.java.lang.Iterable<java.lang.String>
getHeaderLines()
Get the header lines.java.util.Iterator<EvaluationResult.MeasurementGroup>
iterator()
EvaluationResult.MeasurementGroup
newGroup(java.lang.String string)
Add a new measurement group.int
numLines()
Number of lines recommended for display.boolean
visualizeSingleton()
Flag to indicate that these results should be visualized using a single visualizer.void
writeToText(TextWriterStream out, java.lang.String label)
Write self to the givenTextWriterStream
-
-
-
Field Detail
-
RANKING
public static final java.lang.String RANKING
Result name for aggregating ranking evaluations.- See Also:
- Constant Field Values
-
groups
java.util.ArrayList<EvaluationResult.MeasurementGroup> groups
Measurements.
-
header
java.util.ArrayList<java.lang.String> header
Header lines.
-
-
Method Detail
-
newGroup
public EvaluationResult.MeasurementGroup newGroup(java.lang.String string)
Add a new measurement group.- Parameters:
string
- Group name- Returns:
- Measurement group.
-
findOrCreateGroup
public EvaluationResult.MeasurementGroup findOrCreateGroup(java.lang.String label)
Find or add a new measurement group.- Parameters:
label
- Group name- Returns:
- Measurement group.
-
writeToText
public void writeToText(TextWriterStream out, java.lang.String label)
Description copied from interface:TextWriteable
Write self to the givenTextWriterStream
- Specified by:
writeToText
in interfaceTextWriteable
- Parameters:
out
- Output writerlabel
- Label
-
addHeader
public void addHeader(java.lang.String line)
Add a header line to this result.- Parameters:
line
- Header line
-
getHeaderLines
public java.lang.Iterable<java.lang.String> getHeaderLines()
Get the header lines.- Returns:
- Header lines
-
iterator
public java.util.Iterator<EvaluationResult.MeasurementGroup> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<EvaluationResult.MeasurementGroup>
-
numLines
public int numLines()
Number of lines recommended for display.- Returns:
- Number of lines
-
findOrCreate
public static EvaluationResult findOrCreate(java.lang.Object parent, java.lang.String name)
Find or create an evaluation result.- Parameters:
parent
- Parent resultname
- Long name- Returns:
- Evaluation result
-
visualizeSingleton
public boolean visualizeSingleton()
Flag to indicate that these results should be visualized using a single visualizer.- Returns:
- Singleton
-
-