org.openimaj.util.pair

Class IndependentPair<A,B>

java.lang.Object

org.openimaj.util.pair.IndependentPair<A,B>

Type Parameters:

A - the class of the first object in the pair

B - the class of the second object in the pair

Direct Known Subclasses:

Pair, ReadWritableIndependentPair

public class IndependentPair<A,B>
extends Object

IndependentPair represents a generic pair of objects of different (independent) types.

Author:

Jonathon Hare

Constructor Summary

Constructors

Constructor and Description
IndependentPair(A obj1, B obj2) Constructs a Pair object with two objects obj1 and obj2

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object thatObject)
A	firstObject()
static <T,Q> List<T>	getFirst(Iterable<? extends IndependentPair<T,Q>> data) Extract the first objects from a list of pairs.
static <T,Q> Function<IndependentPair<T,Q>,T>	getFirstFunction() Get the function that returns the first object from the pair
A	getFirstObject()
static <T,Q> List<Q>	getSecond(Iterable<? extends IndependentPair<T,Q>> data) Extract the second objects from a list of pairs.
static <T,Q> Function<IndependentPair<T,Q>,Q>	getSecondFunction() Get the function that returns the second object from the pair
B	getSecondObject()
static <T,Q> IndependentPair<T,Q>	pair(T t, Q q) Create a pair from the given objects.
static <T,Q> List<IndependentPair<T,Q>>	pairList(List<T> t, List<Q> q) Create a pair list from the given objects.
B	secondObject()
void	setFirstObject(A obj) Set first object in pair to obj
void	setSecondObject(B obj) Set second object in pair to obj
IndependentPair<B,A>	swap() Create a new IndependentPair from this one with the elements swapped
static <T,Q> List<IndependentPair<? extends Q,? extends T>>	swapList(List<? extends IndependentPair<? extends T,? extends Q>> data) Swap the order of the pairs
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndependentPair

public IndependentPair(A obj1,
                       B obj2)

Constructs a Pair object with two objects obj1 and obj2

Parameters:

obj1 - first object in pair

obj2 - second objec in pair

Method Detail

firstObject

public A firstObject()

Returns:

first object in pair

secondObject

public B secondObject()

Returns:

second object in pair

getFirstObject

public A getFirstObject()

Returns:

first object in pair

getSecondObject

public B getSecondObject()

Returns:

second object in pair

setFirstObject

public void setFirstObject(A obj)

Set first object in pair to obj

Parameters:

obj - the object

setSecondObject

public void setSecondObject(B obj)

Set second object in pair to obj

Parameters:

obj - the object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object thatObject)

Overrides:

equals in class Object

pair

public static <T,Q> IndependentPair<T,Q> pair(T t,
                                              Q q)

Create a pair from the given objects.

Type Parameters:

T - Type of first object.

Q - Type of second object.

Parameters:

t - The first object.

q - The second object.

Returns:

The pair.

getFirst

public static <T,Q> List<T> getFirst(Iterable<? extends IndependentPair<T,Q>> data)

Extract the first objects from a list of pairs.

Type Parameters:

T - type of first object

Q - type of second object

Parameters:

data - the data

Returns:

extracted first objects

getSecond

public static <T,Q> List<Q> getSecond(Iterable<? extends IndependentPair<T,Q>> data)

Extract the second objects from a list of pairs.

Type Parameters:

T - type of first object

Q - type of second object

Parameters:

data - the data

Returns:

extracted second objects

getFirstFunction

public static <T,Q> Function<IndependentPair<T,Q>,T> getFirstFunction()

Get the function that returns the first object from the pair

Returns:

the function that returns the first object from the pair

getSecondFunction

public static <T,Q> Function<IndependentPair<T,Q>,Q> getSecondFunction()

Get the function that returns the second object from the pair

Returns:

the function that returns the second object from the pair

pairList

public static <T,Q> List<IndependentPair<T,Q>> pairList(List<T> t,
                                                        List<Q> q)

Create a pair list from the given objects.

Type Parameters:

T - Type of objects.

Parameters:

t - The list of first objects.

q - The list of second objects.

Returns:

The list of pairs.

swap

public IndependentPair<B,A> swap()

Create a new IndependentPair from this one with the elements swapped

Returns:

the swapped pair

swapList

public static <T,Q> List<IndependentPair<? extends Q,? extends T>> swapList(List<? extends IndependentPair<? extends T,? extends Q>> data)

Swap the order of the pairs

Parameters:

data - the input

Returns:

the swapped data