it.uniroma2.sag.kelp.data.example

Class SimpleExample

java.lang.Object

it.uniroma2.sag.kelp.data.example.Example

it.uniroma2.sag.kelp.data.example.SimpleExample

All Implemented Interfaces:

Serializable

public class SimpleExample
extends Example

An Example composed by a set of Representations.

Author:

Simone Filice

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleExample() Initializes an empty example (0 labels and 0 representations)
SimpleExample(Label[] labels, HashMap<String,Representation> representations) Initializes a SimpleExample with the input representations and labels

Method Summary

Methods

Modifier and Type	Method and Description
void	addRepresentation(String representationName, Representation representation) Adds a representation to this example
boolean	equals(Object example)
boolean	equalsIgnoreLabels(SimpleExample example) Asserts whether this example and the input one have identical representations, ignoring their labels
int	getNumberOfRepresentations() Returns the number of representations in which this example is modeled
Representation	getRepresentation(String representationName) Returns the representation corresponding to representationName
Map<String,Representation>	getRepresentations() Returns the example representations
Vector	getZeroVector(String representationIdentifier)
void	normalize() Normalize each normalizable representation of this example
String	printExample(String... representations)
void	setRepresentations(HashMap<String,Representation> representations) Sets the example representations
String	toString()

Methods inherited from class it.uniroma2.sag.kelp.data.example.Example

addLabel, clone, getClassificationLabels, getId, getLabels, getNumberOfClassificationLabels, getNumberOfRegressionLabels, getRegressionLabels, getRegressionValue, getRegressionValues, getTextualLabelPart, isExampleOf, setClassificationLabels, setLabels, setRegressionValues

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleExample

public SimpleExample()

Initializes an empty example (0 labels and 0 representations)

SimpleExample

public SimpleExample(Label[] labels,
             HashMap<String,Representation> representations)

Initializes a SimpleExample with the input representations and labels

Parameters:

labels - the classes whose this instance is a positive example

representations - the various representations in which the instance is represented

Method Detail

setRepresentations

public void setRepresentations(HashMap<String,Representation> representations)

Sets the example representations

Parameters:

representations - to associate to this example

getRepresentations

public Map<String,Representation> getRepresentations()

Returns the example representations

Returns:

the representations of this example

addRepresentation

public void addRepresentation(String representationName,
                     Representation representation)

Adds a representation to this example

Parameters:

representationName - the identifier of the representation to be added

representation - the representation to be added

getNumberOfRepresentations

public int getNumberOfRepresentations()

Returns the number of representations in which this example is modeled

Returns:

the number of representations

getRepresentation

public Representation getRepresentation(String representationName)

Returns the representation corresponding to representationName

Parameters:

representationName - it is a representation identifier

Returns:

the representation corresponding to representationName

equals

public boolean equals(Object example)

Overrides:

equals in class Example

equalsIgnoreLabels

public boolean equalsIgnoreLabels(SimpleExample example)

Asserts whether this example and the input one have identical representations, ignoring their labels

Parameters:

example -

Returns:

true if this example and the input one have identical representations, false otherwise

normalize

public void normalize()

Normalize each normalizable representation of this example

Specified by:

normalize in class Example

toString

public String toString()

Overrides:

toString in class Object

printExample

public String printExample(String... representations)

getZeroVector

public Vector getZeroVector(String representationIdentifier)

Specified by:

getZeroVector in class Example