Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.normalization
Class DummyNormalization<O extends DatabaseObject>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          extended by de.lmu.ifi.dbs.elki.normalization.DummyNormalization<O>
All Implemented Interfaces:
Loggable, Normalization<O>, Parameterizable

public class DummyNormalization<O extends DatabaseObject>
extends AbstractParameterizable
implements Normalization<O>

Dummy normalization that does nothing. This class is used at normalization of multi-represented objects if one representation needs no normalization.

Author:
Elke Achtert

Field Summary
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
optionHandler
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug
 
Constructor Summary
DummyNormalization()
           
 
Method Summary
 String description()
          Returns a description of the class and the required parameters.
 List<O> normalize(List<O> featureVectors)
          Performs a normalization on a set of feature vectors.
 List<ObjectAndAssociations<O>> normalizeObjects(List<ObjectAndAssociations<O>> objectAndAssociationsList)
          Performs a normalization on a list of database objects and their associations.
 List<O> restore(List<O> featureVectors)
          Transforms a set of feature vectores to the original attribute ranges.
 O restore(O featureVector)
          Transforms a feature vector to the original attribute ranges.
 String[] setParameters(String[] args)
          Sets the attributes of the class accordingly to the given parameters.
 String toString()
          Returns a string representation of this object.
 String toString(String pre)
          Returns a string representation of this normalization.
 LinearEquationSystem transform(LinearEquationSystem linearEquationSystem)
          Transforms a linear equation system describing linear dependencies derived on the normalized space into a linear equation system describing linear dependencies quantitatively adapted to the original space.
 
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
addOption, checkGlobalParameterConstraints, deleteOption, description, description, getAttributeSettings, getParameters, getParameterValue, getPossibleOptions, inlineDescription, isSet, setParameters
 
Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, getAttributeSettings, getParameters, getPossibleOptions, inlineDescription
 

Constructor Detail

DummyNormalization

public DummyNormalization()
Method Detail

normalizeObjects

public List<ObjectAndAssociations<O>> normalizeObjects(List<ObjectAndAssociations<O>> objectAndAssociationsList)
                                                                       throws NonNumericFeaturesException
Description copied from interface: Normalization
Performs a normalization on a list of database objects and their associations.

Specified by:
normalizeObjects in interface Normalization<O extends DatabaseObject>
Parameters:
objectAndAssociationsList - the list of database objects and their associations
Returns:
the specified objectAndAssociationsList
Throws:
NonNumericFeaturesException - if feature vectors differ in length or values are not suitable to normalization
See Also:
Normalization.normalizeObjects(java.util.List)

normalize

public List<O> normalize(List<O> featureVectors)
                                         throws NonNumericFeaturesException
Description copied from interface: Normalization
Performs a normalization on a set of feature vectors.

Specified by:
normalize in interface Normalization<O extends DatabaseObject>
Parameters:
featureVectors - a set of feature vectors to be normalized
Returns:
the specified featureVectors
Throws:
NonNumericFeaturesException - if feature vectors differ in length or values are not suitable to normalization
See Also:
Normalization.normalize(java.util.List)

restore

public List<O> restore(List<O> featureVectors)
                                       throws NonNumericFeaturesException
Description copied from interface: Normalization
Transforms a set of feature vectores to the original attribute ranges.

Specified by:
restore in interface Normalization<O extends DatabaseObject>
Parameters:
featureVectors - a set of feature vectors to be transformed into original space
Returns:
the specified featureVectors
Throws:
NonNumericFeaturesException - if feature vectors differ in length or are not compatible with values initialized during normalization
See Also:
Normalization.restore(java.util.List)

restore

public O restore(O featureVector)
                                 throws NonNumericFeaturesException
Description copied from interface: Normalization
Transforms a feature vector to the original attribute ranges.

Specified by:
restore in interface Normalization<O extends DatabaseObject>
Parameters:
featureVector - a feature vector to be transformed into original space
Returns:
the specified featureVector
Throws:
NonNumericFeaturesException - feature vector is not compatible with values initialized during normalization
See Also:
Normalization.restore(DatabaseObject)

transform

public LinearEquationSystem transform(LinearEquationSystem linearEquationSystem)
                               throws NonNumericFeaturesException
Description copied from interface: Normalization
Transforms a linear equation system describing linear dependencies derived on the normalized space into a linear equation system describing linear dependencies quantitatively adapted to the original space.

Specified by:
transform in interface Normalization<O extends DatabaseObject>
Parameters:
linearEquationSystem - the linear equation system to be transformed
Returns:
the specified linear equation system
Throws:
NonNumericFeaturesException - if specified linear equation system is not compatible with values initialized during normalization
See Also:
Normalization.transform(de.lmu.ifi.dbs.elki.math.linearalgebra.LinearEquationSystem)

toString

public String toString(String pre)
Description copied from interface: Normalization
Returns a string representation of this normalization. The specified prefix pre will be the prefix of each new line. This method is used to write the parameters of a normalization to a result of an algorithm using this normalization.

Specified by:
toString in interface Normalization<O extends DatabaseObject>
Parameters:
pre - the prefix of each new line
Returns:
a string representation of this normalization
See Also:
Normalization.toString(String)

description

public String description()
Description copied from interface: Parameterizable
Returns a description of the class and the required parameters.

This description should be suitable for a usage description as for a standalone application.

Specified by:
description in interface Parameterizable
Overrides:
description in class AbstractParameterizable
Returns:
String a description of the class and the required parameters
See Also:
Parameterizable.description()

setParameters

public String[] setParameters(String[] args)
                       throws IllegalArgumentException
Description copied from interface: Parameterizable
Sets the attributes of the class accordingly to the given parameters. Returns a new String array containing those entries of the given array that are neither expected nor used by this Parameterizable.

Specified by:
setParameters in interface Parameterizable
Overrides:
setParameters in class AbstractParameterizable
Parameters:
args - parameters to set the attributes accordingly to
Returns:
String[] an array containing the unused parameters
Throws:
IllegalArgumentException
See Also:
Parameterizable.setParameters(String[])

toString

public String toString()
Returns a string representation of this object.

Overrides:
toString in class Object
Returns:
a string representation of this object

Release 0.1 (2008-07-10_1838)