com.rapidminer.example.set
Class SimilarityExampleSet

java.lang.Object
  extended by com.rapidminer.operator.AbstractIOObject
      extended by com.rapidminer.operator.ResultObjectAdapter
          extended by com.rapidminer.example.set.AbstractExampleSet
              extended by com.rapidminer.example.set.SimilarityExampleSet
All Implemented Interfaces:
ExampleSet, IOObject, ResultObject, Saveable, LoggingHandler, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Example>

public class SimilarityExampleSet
extends AbstractExampleSet

This similarity based example set is used for the operator ExampleSet2SimilarityExampleSet.

Author:
Ingo Mierswa
See Also:
Serialized Form

Constructor Summary
SimilarityExampleSet(ExampleSet parent, DistanceMeasure measure)
           
SimilarityExampleSet(SimilarityExampleSet exampleSet)
          Clone constructor.
 
Method Summary
 boolean equals(java.lang.Object o)
          Returns true, if all attributes including labels and other special attributes are equal.
 Attributes getAttributes()
          Returns the data structure holding all attributes.
 Example getExample(int index)
          Returns the i-th example.
 ExampleTable getExampleTable()
          Returns the underlying example table.
 int hashCode()
          Returns the hash code of all attributes.
 java.util.Iterator<Example> iterator()
           
 int size()
          Returns the number of examples in this example set.
 
Methods inherited from class com.rapidminer.example.set.AbstractExampleSet
clone, copy, createDataTable, getActions, getExampleFromId, getExampleIndicesFromId, getExtension, getFileDescription, getName, getResultIcon, getStatistics, getStatistics, getVisualizationComponent, getVisualizationComponent, recalculateAllAttributeStatistics, recalculateAttributeStatistics, remapIds, toString, writeAttributeFile, writeDataFile, writeSparseAttributeFile, writeSparseDataFile
 
Methods inherited from class com.rapidminer.operator.ResultObjectAdapter
addAction, isSavable, log, logError, logNote, logWarning, save, toHTML, toResultString
 
Methods inherited from class com.rapidminer.operator.AbstractIOObject
getLog, getSource, initWriting, read, setLoggingHandler, setSource, write
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.rapidminer.operator.ResultObject
toResultString
 
Methods inherited from interface com.rapidminer.operator.IOObject
getLog, getSource, setLoggingHandler, setSource, write
 

Constructor Detail

SimilarityExampleSet

public SimilarityExampleSet(ExampleSet parent,
                            DistanceMeasure measure)

SimilarityExampleSet

public SimilarityExampleSet(SimilarityExampleSet exampleSet)
Clone constructor.

Method Detail

equals

public boolean equals(java.lang.Object o)
Description copied from class: AbstractExampleSet
Returns true, if all attributes including labels and other special attributes are equal.

Specified by:
equals in interface ExampleSet
Overrides:
equals in class AbstractExampleSet

hashCode

public int hashCode()
Description copied from class: AbstractExampleSet
Returns the hash code of all attributes.

Specified by:
hashCode in interface ExampleSet
Overrides:
hashCode in class AbstractExampleSet

getAttributes

public Attributes getAttributes()
Description copied from interface: ExampleSet
Returns the data structure holding all attributes.


getExample

public Example getExample(int index)
Description copied from interface: ExampleSet
Returns the i-th example. It is not guaranteed that asking for an example by using the index in the example table is efficiently implemented. Therefore for-loops for iterations are not an option and an ExampleReader should be used.


iterator

public java.util.Iterator<Example> iterator()

getExampleTable

public ExampleTable getExampleTable()
Description copied from interface: ExampleSet
Returns the underlying example table. Most operators should operate on the example set and manipulate example to change table data instead of using the table directly.


size

public int size()
Description copied from interface: ExampleSet
Returns the number of examples in this example set. This number should not be used to create for-loops to iterate through all examples.



Copyright © 2001-2009 by Rapid-I