at.tuwien.ifs.somtoolbox.layers
Class MappedInputs

java.lang.Object
  extended by at.tuwien.ifs.somtoolbox.layers.MappedInputs

public class MappedInputs
extends Object

Wrapper class for input data mapped onto units. This class holds the names and distances of input data, both sorted by ascending distance.

Version:
$Id: MappedInputs.java 3587 2010-05-21 10:35:33Z mayer $
Author:
Michael Dittenbach

Field Summary
private  Vector<Double> inputDistances
           
private  Vector<String> inputNames
           
private  int number
           
 
Constructor Summary
MappedInputs()
          Default Constructor.
 
Method Summary
 void addMappedInput(String name, Double dist)
          Adds an input datum defined by argument name and distance to the list.
 void clearMappedInputs()
          Clears all input data.
 double[] getMappedInputDistances()
          Returns an array of distances between this unit's weight vector and the vectors of the mapped input data.
 String[] getMappedInputNames()
          Returns an array of strings containing the identifiers of the mapped input data.
 int getNumberOfMappedInputs()
          Returns the number of mapped input data.
 boolean isMapped(String name)
          Checks if an input datum with identifier name is contained.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

inputDistances

private Vector<Double> inputDistances

inputNames

private Vector<String> inputNames

number

private int number
Constructor Detail

MappedInputs

public MappedInputs()
Default Constructor.

Method Detail

addMappedInput

public void addMappedInput(String name,
                           Double dist)
Adds an input datum defined by argument name and distance to the list. It is inserted at a position to retain ordering by ascending distance.

Parameters:
name - the identification string of the input datum.
dist - the distance between a unit's weight vector and the inptu datum. This value is precalcuated and independent from this class.

clearMappedInputs

public void clearMappedInputs()
Clears all input data. This method removes all elements from the lists and sets the number variable to 0 accordingly.


getMappedInputDistances

public double[] getMappedInputDistances()
Returns an array of distances between this unit's weight vector and the vectors of the mapped input data. The array is sorted from smallest to largest distance.

Returns:
an array of distances between this unit's weight vector and the vectors of the mapped input data.

getMappedInputNames

public String[] getMappedInputNames()
Returns an array of strings containing the identifiers of the mapped input data. The array is sorted from the input with the smallest distance to the one having the largest in analogy to getMappedInputDistances().

Returns:
an array of strings containing the identifiers of the mapped input data.

getNumberOfMappedInputs

public int getNumberOfMappedInputs()
Returns the number of mapped input data.

Returns:
the number of mapped input data.

isMapped

public boolean isMapped(String name)
Checks if an input datum with identifier name is contained.

Parameters:
name - the name of the input datum to be checked.
Returns:
true if an input datum with identifier specified by argument name is mapped onto this unit, false otherwise.