edu.udo.cs.yale.example
Class AttributeWeightedExampleSet

java.lang.Object
  edu.udo.cs.yale.operator.AbstractIOObject
      edu.udo.cs.yale.operator.ResultObjectAdapter
          edu.udo.cs.yale.example.AbstractExampleSet
              edu.udo.cs.yale.example.ExampleSetAdapter
                  edu.udo.cs.yale.example.AttributeWeightedExampleSet

All Implemented Interfaces:

ExampleSet, IOObject, ResultObject, java.lang.Cloneable, java.lang.Iterable<Example>

public class AttributeWeightedExampleSet
extends ExampleSetAdapter

An implementation of ExampleSet that allows the weighting of the attributes. Weights can be queried by the method getWeight(int).

Version:

$Id: AttributeWeightedExampleSet.java,v 1.36 2006/03/21 15:35:39 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private AttributeWeights	attributeWeights Currently used attribute weights.
private Attribute[]	currentSelectedAttributes Currently selected attributes.
static java.lang.String	ORIGINAL_NUMBER_OF_ATTRIBUTES
private WeightApplier	weightApplier This weight applier is used for the examples created by a example reader.

Fields inherited from class edu.udo.cs.yale.example.ExampleSetAdapter

delegate

Fields inherited from interface edu.udo.cs.yale.example.ExampleSet

ATTRIBUTE_NAME, BATCH_NAME, CLUSTER_NAME, CONFIDENCE_NAME, ID_NAME, KNOWN_ATTRIBUTE_TYPES, LABEL_NAME, PREDICTION_NAME, TYPE_ATTRIBUTE, TYPE_BATCH, TYPE_CLUSTER, TYPE_ID, TYPE_LABEL, TYPE_PREDICTION, TYPE_WEIGHT, WEIGHT_NAME

Constructor Summary

AttributeWeightedExampleSet(AttributeWeightedExampleSet exampleSet)
Clone constructor.

AttributeWeightedExampleSet(ExampleSet exampleSet)
Constructs a new AttributeWeightedExampleSet.

AttributeWeightedExampleSet(ExampleSet exampleSet, AttributeWeights weights)
Constructs a new AttributeWeightedExampleSet.

AttributeWeightedExampleSet(ExampleSet exampleSet, AttributeWeights weights, double defaultWeight)
Constructs a new AttributeWeightedExampleSet.

Method Summary

void	addAttribute(Attribute attribute) Adds a new attribute.
AttributeWeightedExampleSet	createCleanExampleSet() Creates a new example set without the deselected attributes.
protected DataTable	createDataTable(IOContainer container) This method is used to create a DataTable from this example set.
private ExampleSet	createExampleSetFromSelection() Creates a new simple ExampleSet without attributes with weight 0.
ExampleSet	createExampleSetFromWeights() Creates a new ExampleSet without attributes with weight 0.
void	deselectAll() Sets the weights of all attributes to 0.0.
boolean	equals(java.lang.Object o) Returns true, if all attributes including labels and other special attributes are equal.
int	flipAttributeUsed(int index) Flips the selection state of the attribute with the given index.
Example	getExample(int index) Returns the example with the given index.
int	getNumberOfUsedAttributes() Returns the number of selected attributes.
double	getWeight(Attribute attribute) Returns the weight of the attribute.
double	getWeight(int i) Returns the weight of the attribute with the given index.
boolean	isAttributeUsed(Attribute attribute) Returns the selection state of the attribute.
boolean	isAttributeUsed(int i) Returns the selection state of the attribute with the given index.
java.util.Iterator<Example>	iterator() Creates a new ExampleSet without attributes with weight 0.
void	removeAttribute(Attribute attribute) Removes an attribute.
void	selectAll() Sets the weights of all attributes to 1.0.
void	selectRandomSubset(int n, java.util.Random random) Randomly selects approximately the given number of attributes.
private void	setAll(double weight) Sets all flags to the given value.
void	setAttributeUsed(Attribute attribute, boolean selected) Sets the selection state of the attribute.
void	setAttributeUsed(int index, boolean selected) Sets the selection state of the attribute with the given index.
void	setWeight(Attribute attribute, double weightValue) Sets the weight of the attribute.
void	setWeight(int index, double weight) Sets the weight of the attribute with the given index.
void	setWeightApplier(WeightApplier weightApplier) Sets the weight applier for this example set.
int	setWeightForBlock(int index, double weight) If a block starts with this attribute the weight of all attributes in the whole block will be set to the given weight.
java.lang.String	toString()

Methods inherited from class edu.udo.cs.yale.example.ExampleSetAdapter

clearUserData, getAttribute, getAttribute, getExampleFromId, getExampleReader, getExampleTable, getNumberOfAttributes, getSize, getSpecialAttribute, getSpecialAttributeNames, getSpecialAttributes, getUserData, getUserDataKeys, remapAllIds, replaceAttribute, setSpecialAttribute, setUserData, size

Methods inherited from class edu.udo.cs.yale.example.AbstractExampleSet

addAllAttributes, clearPredictedLabel, clearWeight, clone, contains, containsValueType, copy, createClusterAttribute, createSpecialAttribute, createWeightAttribute, getActions, getBlockEndIndex, getCluster, getId, getLabel, getName, getPredictedLabel, getVisualisationComponent, getWeight, recalculateAllAttributeStatistics, recalculateAttributeStatistics, recalculateAttributeStatistics, removeAllAttributes, removeAttribute, setAttributes, setCluster, setId, setLabel, setPredictedLabel, setWeight, writeAttributeFile, writeDataFile, writeSparseAttributeFile, writeSparseDataFile

Methods inherited from class edu.udo.cs.yale.operator.ResultObjectAdapter

addAction, toHTML, toResultString

Methods inherited from class edu.udo.cs.yale.operator.AbstractIOObject

read, read, read, write, write

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.udo.cs.yale.operator.ResultObject

toResultString

Methods inherited from interface edu.udo.cs.yale.operator.IOObject

write, write

Field Detail

ORIGINAL_NUMBER_OF_ATTRIBUTES

public static final java.lang.String ORIGINAL_NUMBER_OF_ATTRIBUTES

See Also:

Constant Field Values

weightApplier

private WeightApplier weightApplier

This weight applier is used for the examples created by a example reader.

currentSelectedAttributes

private Attribute[] currentSelectedAttributes

Currently selected attributes. Used for example creation. Must be recalculated after weight changes.

attributeWeights

private AttributeWeights attributeWeights

Currently used attribute weights. Used also for example creation.

Constructor Detail

AttributeWeightedExampleSet

public AttributeWeightedExampleSet(AttributeWeightedExampleSet exampleSet)

Clone constructor.

AttributeWeightedExampleSet

public AttributeWeightedExampleSet(ExampleSet exampleSet)

Constructs a new AttributeWeightedExampleSet. Initially all attributes are weighted with 1.0.

AttributeWeightedExampleSet

public AttributeWeightedExampleSet(ExampleSet exampleSet,
                                   AttributeWeights weights)

Constructs a new AttributeWeightedExampleSet. The attributes are weighted with the given weights. Attributes which are not stored in the map are weighted with 1.0.

AttributeWeightedExampleSet

public AttributeWeightedExampleSet(ExampleSet exampleSet,
                                   AttributeWeights weights,
                                   double defaultWeight)

Constructs a new AttributeWeightedExampleSet. The attributes are weighted with the given weights. Attributes which are not stored in the map are weighted with the given default weight.

Method Detail

setWeightApplier

public void setWeightApplier(WeightApplier weightApplier)

Sets the weight applier for this example set.

getWeight

public double getWeight(Attribute attribute)

Returns the weight of the attribute.

setWeight

public void setWeight(Attribute attribute,
                      double weightValue)

Sets the weight of the attribute. If the weight is 0, the attribute is completely removed.

getNumberOfUsedAttributes

public int getNumberOfUsedAttributes()

Returns the number of selected attributes.

getWeight

public double getWeight(int i)

Returns the weight of the attribute with the given index.

setWeight

public void setWeight(int index,
                      double weight)

Sets the weight of the attribute with the given index.

selectAll

public void selectAll()

Sets the weights of all attributes to 1.0.

deselectAll

public void deselectAll()

Sets the weights of all attributes to 0.0.

setAll

private void setAll(double weight)

Sets all flags to the given value.

setWeightForBlock

public int setWeightForBlock(int index,
                             double weight)

If a block starts with this attribute the weight of all attributes in the whole block will be set to the given weight. Returns the index of the attribute which is the last one in the block or the index of the given attribute itself if it is not the start attribute of a block.

isAttributeUsed

public boolean isAttributeUsed(Attribute attribute)

Returns the selection state of the attribute.

setAttributeUsed

public void setAttributeUsed(Attribute attribute,
                             boolean selected)

Sets the selection state of the attribute.

flipAttributeUsed

public int flipAttributeUsed(int index)

Flips the selection state of the attribute with the given index. (Convenience method for evolutionary algorithms). If a block starts with this attribute the whole block will be switched. Returns the index of the attribute which is the last one in the block or the index of the given attribute itself if it is not the start attribute of a block.

selectRandomSubset

public void selectRandomSubset(int n,
                               java.util.Random random)

Randomly selects approximately the given number of attributes. Will not throw an exception if the given number exceeds the current number of features. If no attributes would be selected a single attribute will be selected.

isAttributeUsed

public boolean isAttributeUsed(int i)

Returns the selection state of the attribute with the given index.

setAttributeUsed

public void setAttributeUsed(int index,
                             boolean selected)

Sets the selection state of the attribute with the given index.

addAttribute

public void addAttribute(Attribute attribute)

Description copied from interface: ExampleSet

Adds a new attribute.

Specified by:

addAttribute in interface ExampleSet

Overrides:

addAttribute in class ExampleSetAdapter

removeAttribute

public void removeAttribute(Attribute attribute)

Description copied from interface: ExampleSet

Removes an attribute.

Specified by:

removeAttribute in interface ExampleSet

Overrides:

removeAttribute in class ExampleSetAdapter

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

toString

public java.lang.String toString()

Overrides:

toString in class AbstractExampleSet

createDataTable

protected DataTable createDataTable(IOContainer container)

Description copied from class: AbstractExampleSet

This method is used to create a DataTable from this example set. The default implementation returns an instance of DataTableExampleSetAdapter. The given IOContainer is used to check if there are compatible attribute weights which would used as column weights of the returned table. Subclasses might want to override this method in order to allow for other data tables.

Overrides:

createDataTable in class AbstractExampleSet

iterator

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

Creates a new ExampleSet without attributes with weight 0. A WeightingExampleReader is returned which creates examples which can handle the attribute weights.

Specified by:

iterator in interface java.lang.Iterable<Example>

Overrides:

iterator in class ExampleSetAdapter

getExample

public Example getExample(int index)

Returns the example with the given index. Since this method creates an example set with the selected attribute each time an example is queries this method should not be used to iterate over examples.

Specified by:

getExample in interface ExampleSet

Overrides:

getExample in class ExampleSetAdapter

createExampleSetFromSelection

private ExampleSet createExampleSetFromSelection()

Creates a new simple ExampleSet without attributes with weight 0. The result is a simple example set without weights.

createCleanExampleSet

public AttributeWeightedExampleSet createCleanExampleSet()

Creates a new example set without the deselected attributes. The result again is a AttributeWeightedExampleSet, all not deselected attributes will use the weights of this example set. Please note that this method does not alter the data in the example table, it simply removes the not used attributes and the next ExampleReader returned by the method iterator() returns a weighted example reader based on the weights and the given WeightApplier. Please make sure that the correct WeightApplier is set before you invoke this method. The default is ScalingWeightApplier. The result example set provides a user data object (Integer) with key ORIGINAL_NUMBER_OF_ATTRIBUTES containing the original number of attributes.

createExampleSetFromWeights

public ExampleSet createExampleSetFromWeights()

Creates a new ExampleSet without attributes with weight 0. All numeric attributes are scaled with the given weight applier. Invoke this method only if you really want to change the data in the example table. In all other cases the use of createCleanExampleSet() is recommended.