PatternSet (boone)

java.lang.Object
- boone.PatternSet

All Implemented Interfaces:

Storable, java.lang.Cloneable

Direct Known Subclasses:

SpikeSet
```
public class PatternSet
extends java.lang.Object
implements Storable, java.lang.Cloneable
```
Base class that defines a generic data structure for the storage of network related data. The actual usage and semantics of the stored data have to be defined by extending this base class. The stored data is grouped in four different categories, represented by four different lists:
1. A List that holds pattern names
2. A List that holds input patterns
3. A List that holds target patterns
4. A List that holds output patterns
This class provides access to the lists and methods to load and store the DataSet to/from XML.
Version:

$Id: DataSet.java 2271 2015-03-22 jmory $

Author:

Helmut A. Mayer, Johannes Mory

Field Summary

Fields
Modifier and Type	Field and Description
`protected IOFilter`	`filter` The data IO filter (default Boone).
`protected java.util.List<java.util.List<java.lang.Double>>`	`inputs` The input patterns.
`protected java.util.ArrayList<java.lang.String>`	`names` The optional pattern names ordered accordingly.
`protected java.util.List<java.util.List<java.lang.Double>>`	`outputs` The output patterns.
`protected java.util.Properties`	`props` Arbitrary properties to be stored along with data sets.
`protected java.util.List<java.util.List<java.lang.Double>>`	`targets` The target patterns.

Constructor Summary

Constructors
Constructor and Description
`PatternSet()` Creates an empty DataSet with the default Boone IO filter with compression.
`PatternSet(IOFilter filter)` Creates an empty dataset with the given IO filter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addInput(java.util.List<java.lang.Double> feature)` Adds an input feature value for all patterns.
`PatternSet`	`clone()` Creates a (nearly) deep copy of this data set.
`void`	`fromXML(org.jdom2.Element element)` Reads patterns from XML tree.
`IOFilter`	`getFilter()` Returns the IO filter.
`java.util.List<java.lang.Double>`	`getInput(int index)` Returns the input feature values of the given feature for all patterns.
`int`	`getInputPatternSize()` Return the number of values for each input pattern.
`java.util.List<java.util.List<java.lang.Double>>`	`getInputs()` Get the list that holds the network input-related data.
`java.util.ArrayList<java.lang.String>`	`getNames()` Returns the pattern names.
`int`	`getNextElement()` Returns the index of the next pattern.
`java.util.List<java.lang.Double>`	`getOutput(int index)` Returns the output values of the given output for all patterns.
`int`	`getOutputPatternSize()` Return the number of values for each output pattern.
`java.util.List<java.util.List<java.lang.Double>>`	`getOutputs()` Get the list that holds the network output-related data.
`java.util.Properties`	`getProperties()` Get the properties to be stored along with this data set.
`java.util.List<java.lang.Double>`	`getTarget(int index)` Returns the target values of the given target for all patterns.
`java.lang.String`	`getTargetLabel(int value)` Returns the name of the given target value.
`int`	`getTargetLabelCount()` Returns the number of targets with a name.
`java.lang.String`	`getTargetLabelOfPattern(int index)` Returns the target label of the given pattern.
`int`	`getTargetPatternSize()` Return the number of values for each target pattern.
`java.util.List<java.util.List<java.lang.Double>>`	`getTargets()` Get the list that holds the network training-related data.
`boolean`	`hasMoreElements()` Indicates, if there are more patterns in the set.
`PatternSet`	`load(java.io.File file)` Loads data from the given file using the set file filter.
`PatternSet`	`load(IOFilter filter)` Loads data using the given file filter.
`void`	`save(java.io.File file)` Save the data set to the given file.
`void`	`save(IOFilter filter)` Saves the pattern set to the given filter.
`void`	`setFilter(IOFilter filter)` Sets the IO filter.
`void`	`setInputs(java.util.List<java.util.List<java.lang.Double>> inputs)` Sets the network inputs.
`void`	`setProperties(java.util.Properties props)` Set the properties to be stored along with this data set.
`void`	`setTargetLabel(int value, java.lang.String label)` Sets the label for the given target value.
`void`	`setTargets(java.util.List<java.util.List<java.lang.Double>> targets)` Sets the network targets.
`void`	`shuffle()` Reorders the patterns in this set randomly.
`int`	`size()` Return the size of the pattern set, which is the number of input patterns.
`java.lang.String`	`toString()` Returns a string representation of this pattern set.
`org.jdom2.Element`	`toXML(org.jdom2.Element element)` Writes patterns to XML tree.
`java.lang.StringBuffer`	`writeValues(char separator, boolean names, boolean split)` Writes a pattern set into a string buffer.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - names
```
protected java.util.ArrayList<java.lang.String> names
```
    The optional pattern names ordered accordingly. If a pattern has no name, it gets the default name '#', where '#' is the index of the pattern.
  - inputs
```
protected java.util.List<java.util.List<java.lang.Double>> inputs
```
    The input patterns.
  - targets
```
protected java.util.List<java.util.List<java.lang.Double>> targets
```
    The target patterns.
  - outputs
```
protected java.util.List<java.util.List<java.lang.Double>> outputs
```
    The output patterns.
  - props
```
protected java.util.Properties props
```
    Arbitrary properties to be stored along with data sets.
  - filter
```
protected IOFilter filter
```
    The data IO filter (default Boone).
- Constructor Detail
  - PatternSet
```
public PatternSet()
```
    Creates an empty DataSet with the default Boone IO filter with compression.
  - PatternSet
```
public PatternSet(IOFilter filter)
```
    Creates an empty dataset with the given IO filter.
    
    Parameters:
    
    filter - an IO filter
- Method Detail
  - clone
```
public PatternSet clone()
                 throws java.lang.CloneNotSupportedException
```
    Creates a (nearly) deep copy of this data set. Only the names are shallow clones (change, if needed).
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    the cloned DataSet
    
    Throws:
    
    java.lang.CloneNotSupportedException - indicates clone problems, should not happen
  - hasMoreElements
```
public boolean hasMoreElements()
```
    Indicates, if there are more patterns in the set. This is derived from the current pattern index. A pattern must have inputs and targets, otherwise it is not considered to be a pattern. If patterns are exhausted in a stream, then the next patterns are streamed into this set. If there are no more patterns, the set is reset internally, so that the next call to this method is again starting with the first pattern of the complete set.
    
    Returns:
    
    true, if more patterns
  - getNextElement
```
public int getNextElement()
```
    Returns the index of the next pattern.
    
    Returns:
    
    an index
  - getNames
```
public java.util.ArrayList<java.lang.String> getNames()
```
    Returns the pattern names.
    
    Returns:
    
    the ordered list of pattern names
  - getInputs
```
public java.util.List<java.util.List<java.lang.Double>> getInputs()
```
    Get the list that holds the network input-related data.
    
    Returns:
    
    the list holding the data
  - setInputs
```
public void setInputs(java.util.List<java.util.List<java.lang.Double>> inputs)
```
    Sets the network inputs.
    
    Parameters:
    
    inputs - the input patterns
  - getInput
```
public java.util.List<java.lang.Double> getInput(int index)
```
    Returns the input feature values of the given feature for all patterns.
    
    Parameters:
    
    index - the feature index
    
    Returns:
    
    the feature values, null, if index is invalid
  - addInput
```
public boolean addInput(java.util.List<java.lang.Double> feature)
```
    Adds an input feature value for all patterns. If the number of feature values is smaller than the number of patterns, false is returned, i.e., nothing is changed.
    
    Parameters:
    
    feature - a list of feature values
    
    Returns:
    
    true, if successful
  - getTargets
```
public java.util.List<java.util.List<java.lang.Double>> getTargets()
```
    Get the list that holds the network training-related data.
    
    Returns:
    
    the list holding the data
  - setTargets
```
public void setTargets(java.util.List<java.util.List<java.lang.Double>> targets)
```
    Sets the network targets.
    
    Parameters:
    
    targets - the desired ouptput patterns
  - getTarget
```
public java.util.List<java.lang.Double> getTarget(int index)
```
    Returns the target values of the given target for all patterns.
    
    Parameters:
    
    index - the target index
    
    Returns:
    
    the target values, null, if index is invalid
  - getOutputs
```
public java.util.List<java.util.List<java.lang.Double>> getOutputs()
```
    Get the list that holds the network output-related data.
    
    Returns:
    
    the list holding the data
  - getOutput
```
public java.util.List<java.lang.Double> getOutput(int index)
```
    Returns the output values of the given output for all patterns.
    
    Parameters:
    
    index - the output index
    
    Returns:
    
    the output values, null, if index is invalid
  - getProperties
```
public java.util.Properties getProperties()
```
    Get the properties to be stored along with this data set.
    
    Returns:
    
    the property object holding the properties
  - setProperties
```
public void setProperties(java.util.Properties props)
```
    Set the properties to be stored along with this data set.
    
    Parameters:
    
    props - a property object holding the properties
  - getFilter
```
public IOFilter getFilter()
```
    Returns the IO filter.
    
    Returns:
    
    the IO filter
  - setFilter
```
public void setFilter(IOFilter filter)
```
    Sets the IO filter.
    
    Parameters:
    
    filter - an IO filter
  - size
```
public int size()
```
    Return the size of the pattern set, which is the number of input patterns.
  - getInputPatternSize
```
public int getInputPatternSize()
```
    Return the number of values for each input pattern. Use this method only if all input patterns have the same number of values.
  - getTargetPatternSize
```
public int getTargetPatternSize()
```
    Return the number of values for each target pattern. Use this method only if all target patterns have the same number of values.
  - getOutputPatternSize
```
public int getOutputPatternSize()
```
    Return the number of values for each output pattern. Use this method only if all output patterns have the same number of values.
  - load
```
public PatternSet load(java.io.File file)
                throws java.io.IOException
```
    Loads data from the given file using the set file filter. Do not forget to configure the filter for the correct state of compression of the file to be loaded.
    
    Parameters:
    
    file - file to load the data from
    
    Returns:
    
    this set
    
    Throws:
    
    java.io.IOException - reading problem
  - load
```
public PatternSet load(IOFilter filter)
                throws java.io.IOException
```
    Loads data using the given file filter. Do not forget to configure the filter for the correct state of compression of the file to be loaded.
    
    Parameters:
    
    filter - filter to load the data with
    
    Returns:
    
    this set
    
    Throws:
    
    java.io.IOException - reading problem
  - save
```
public void save(java.io.File file)
          throws java.io.IOException
```
    Save the data set to the given file.
    
    Throws:
    
    java.io.IOException - writing problem
  - save
```
public void save(IOFilter filter)
          throws java.io.IOException
```
    Saves the pattern set to the given filter. In streaming mode this causes a next stream to be read. Use this method only, if you are sure what you are doing.
    
    Parameters:
    
    filter - the filter with the file to be written
    
    Throws:
    
    java.io.IOException - writing problem
  - shuffle
```
public void shuffle()
```
    Reorders the patterns in this set randomly.
  - fromXML
```
public void fromXML(org.jdom2.Element element)
```
    Reads patterns from XML tree.
    
    Specified by:
    
    fromXML in interface Storable
    
    Parameters:
    
    element - a JDOM element
  - toXML
```
public org.jdom2.Element toXML(org.jdom2.Element element)
```
    Writes patterns to XML tree.
    
    Specified by:
    
    toXML in interface Storable
    
    Parameters:
    
    element - a JDOM element
    
    Returns:
    
    the set element
  - writeValues
```
public java.lang.StringBuffer writeValues(char separator,
                                          boolean names,
                                          boolean split)
```
    Writes a pattern set into a string buffer.
    
    Parameters:
    
    separator - the character separating values
    
    names - if true, pattern names are added as single line comments (starting with '#')
    
    split - if true, input values and target values appear on separate lines
    
    Returns:
    
    the patterns as string buffer
  - getTargetLabelCount
```
public int getTargetLabelCount()
```
    Returns the number of targets with a name.
    
    Returns:
    
    the number of labeled targets
  - getTargetLabel
```
public java.lang.String getTargetLabel(int value)
```
    Returns the name of the given target value.
    
    Parameters:
    
    value - the target value
    
    Returns:
    
    the target label, null, if no label
  - setTargetLabel
```
public void setTargetLabel(int value,
                           java.lang.String label)
```
    Sets the label for the given target value.
    
    Parameters:
    
    value - the target value
    
    label - the label for the target
  - getTargetLabelOfPattern
```
public java.lang.String getTargetLabelOfPattern(int index)
```
    Returns the target label of the given pattern.
    
    Parameters:
    
    index - the pattern index
    
    Returns:
    
    the label of the pattern target, null if no label
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this pattern set.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string describing the pattern set

Class PatternSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

names

inputs

targets

outputs

props

filter

Constructor Detail

PatternSet

PatternSet

Method Detail

clone

hasMoreElements

getNextElement

getNames

getInputs

setInputs

getInput

addInput

getTargets

setTargets

getTarget

getOutputs

getOutput

getProperties

setProperties

getFilter

setFilter

size

getInputPatternSize

getTargetPatternSize

getOutputPatternSize

load

load

save

save

shuffle

fromXML

toXML

writeValues

getTargetLabelCount

getTargetLabel

setTargetLabel

getTargetLabelOfPattern

toString