it.uniroma2.sag.kelp.data.example

Class ExamplePair

java.lang.Object

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

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

it.uniroma2.sag.kelp.data.example.ExamplePair

All Implemented Interfaces:

Serializable

public class ExamplePair
extends SimpleExample

It is the instance of an example pair, i.e. an object that consists of a pair \(\) where \(x_i\) and \(x_j\) are examples themselves. This kind of example results widely used in tasks like re-reranking or entailment

Author:

Simone Filice

See Also:

Serialized Form

Field Summary

Fields inherited from class it.uniroma2.sag.kelp.data.example.SimpleExample

logger

Constructor Summary

Constructors

Constructor and Description
ExamplePair()
ExamplePair(Example left, Example right)

Method Summary

Methods

Modifier and Type	Method and Description
Example	getLeftExample() Returns the left example in the pair
Example	getRightExample() Returns the right example in the pair
boolean	isCompatible(Example example) Evaluates whether an example is compatible with this one, i.e., they have the same structure in terms of Example type and representations
void	manipulate(Manipulator manipulator) Manipulates this example according to the provided manipulator.
String	toString()

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

addRepresentation, equals, equalsIgnoreLabels, getNumberOfRepresentations, getRepresentation, getRepresentations, printExample, setRepresentations

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExamplePair

public ExamplePair()

ExamplePair

public ExamplePair(Example left,
           Example right)

Method Detail

getLeftExample

public Example getLeftExample()

Returns the left example in the pair

Returns:

the left example in the pair

getRightExample

public Example getRightExample()

Returns the right example in the pair

Returns:

the right example in the pair

toString

public String toString()

Overrides:

toString in class SimpleExample

manipulate

public void manipulate(Manipulator manipulator)

Manipulates this example according to the provided manipulator. The manipulation strategy is applied both to the representations stored directly in this ExamplePair and the ones stored in the left and right examples

Overrides:

manipulate in class SimpleExample

Parameters:

manipulator - the manipulator

isCompatible

public boolean isCompatible(Example example)

Description copied from class: Example

Evaluates whether an example is compatible with this one, i.e., they have the same structure in terms of Example type and representations

Overrides:

isCompatible in class SimpleExample

Parameters:

example - the example to be compared with this one

Returns:

whether this example is compatible with the input one