LabelledResultsVector (anchor-feature-io 0.2.1 API)

org.anchoranalysis.feature.io.results.LabelledResultsVector

public final class LabelledResultsVector
extends Object

Like a ResultsVector but additionally contains labels to describe the calculated results.

Author:: Owen Feehan

Constructor Summary

Constructors
Constructor	Description
`LabelledResultsVector(Optional<MultiName> group, ResultsVector results)`	Creates with no additional labels other than a group.
`LabelledResultsVector(RowLabels labels, ResultsVector results)`
`LabelledResultsVector(ResultsVector results)`	Creates with no additional labels, and no group.

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`double`	`get(int index)`	The result of a feature-calculation stored at a particular `index`.
`RowLabels`	`getLabels()`	The labels.
`ResultsVector`	`getResults()`	The results.
`int`	`hashCode()`
`int`	`size()`	The number of calculations stored in the vector.
`String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- LabelledResultsVector
  
  public LabelledResultsVector(ResultsVector results)
  
  Creates with no additional labels, and no group.
  
  Parameters:
  
  results - the results.
- LabelledResultsVector
  
  public LabelledResultsVector(Optional<MultiName> group, ResultsVector results)
  
  Creates with no additional labels other than a group.
  
  Parameters:
  
  group - the associated group.
  
  results - the results.
- LabelledResultsVector
  
  public LabelledResultsVector(RowLabels labels, ResultsVector results)
Method Details
- get
  
  public double get(int index)
  
  The result of a feature-calculation stored at a particular index.
  
  Parameters:
  
  index - the index (zero-indexed). It should be >= 0 and < size().
  
  Returns:
  
  the value corresponding to the feature-calculation or Double.NaN if an exception occurred during calculation.
- size
  
  public int size()
  
  The number of calculations stored in the vector.
  
  Returns:
  
  the total number of calculations in the vector.
- getLabels
  
  public RowLabels getLabels()
  
  The labels.
- getResults
  
  public ResultsVector getResults()
  
  The results.
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object