de.caff.generics

Class IntPair

java.lang.Object

de.caff.generics.IntPair

All Implemented Interfaces:

IntCountable, IntIndexable, PrimitiveIntIterable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Integer>

public final class IntPair
extends java.lang.Object
implements java.io.Serializable, IntIndexable

A pair of primitive int values.

This is similar to Pair, but for raw int values. As these values are defined final, this class is also immutable.

Since:

December 04, 2020

Author:

Rammi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.caff.generics.IntIndexable

IntIndexable.Base, IntIndexable.EntryConsumer, IntIndexable.IntIndexableSpliterator

Field Summary

Fields

Modifier and Type	Field and Description
int	first The first value of this pair.
int	second The second value of this pair.

Fields inherited from interface de.caff.generics.IntIndexable

EMPTY, SINGLE_0

Fields inherited from interface de.caff.generics.PrimitiveIntIterable

EMPTY_INT_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
IntPair(int first, int second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsInts(IntFunction2<T> function) Apply a 2-int function on this pair.
boolean	equals(java.lang.Object o)
int	get(int index) Get the element at the given index.
int	hashCode()
int	operate(IntOperator2 operator) Call an 2-int operator on this pair.
int	size() Get the size.
IntPair	swapped() Get this pair with swapped values.
boolean	test(IntPredicate2 predicate) Call a 2-int predicate on this pair.
LongPair	toLongPair() Convert this pair of ints into a pair of longs.
java.lang.String	toString()
Tuple2<java.lang.Integer,java.lang.Integer>	toTuple() Convert this into a tuple.
LongPair	toUnsignedLongPair() Convert this pair of ints into a pair of longs assuming unsigned values.
IntPair	withFirst(int first) Get this pair with a different first value.
IntPair	withSecond(int second) Get this pair with a different first value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.caff.generics.IntIndexable

addAllTo, addToArray, addToArray, asBase, asCollection, asIndexable, asList, asLongIndexable, asUnsignedIndexable, binarySearch, binarySearch, compare, compareUnsigned, emptyIndexable, equal, equal, firstMatch, foldLeft, forEachIntEntry, frozen, frozenIntSpliterator, getMod, gyt, hash, headSet, indexes, init, initByIndex, intIndexes, intIterator, intIterator, intSpliterator, isEmpty, isOrdered, isStrictlyOrdered, iterator, lastMatch, listIterator, nextMatch, ordered, ordered, previousMatch, range, range, rangeFromSize, reverse, rotated, singleton, subSet, sybSet, tailSet, toArray, toList, toString, view, viewArray, viewArray, viewArray, viewAsBoolean, viewAsByte, viewAsChar, viewAsDouble, viewAsDouble, viewAsFloat, viewAsLong, viewAsLong, viewAsShort, viewAsUnsignedLong, viewByIndex, viewIndexable, viewIndexable, viewIndexable, viewList, viewList, viewList, viewNumberArray, viewOp, with, withAppendedValue, withCachedHash, withExchangedValueAt, withInsertedValueAt, withRemovedValueAt, withSwappedValuesAt, wyth

Methods inherited from interface de.caff.generics.IntCountable

empty, filtered, first, isEqual, isSorted, isStrictlySorted, last, sorted, toString, uniform, viewCollection, viewCollection, viewCollectionN, viewCollectionN

Methods inherited from interface de.caff.generics.PrimitiveIntIterable

average, containsInt, forEachInt, forEachIntFragile, longSum, longSumX, spliterator, stream, sum, sumX

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

first

public final int first

The first value of this pair.

second

public final int second

The second value of this pair.

Constructor Detail

IntPair

public IntPair(int first,
               int second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

toLongPair

@NotNull
public LongPair toLongPair()

Convert this pair of ints into a pair of longs.

Returns:

long pair with same values

toUnsignedLongPair

@NotNull
public LongPair toUnsignedLongPair()

Convert this pair of ints into a pair of longs assuming unsigned values.

Returns:

long pair with the values of this pair assumed unsigned

withFirst

@NotNull
public IntPair withFirst(int first)

Get this pair with a different first value.

Parameters:

first - new first value

Returns:

pair with the given first value, and the second value of this pair

withSecond

@NotNull
public IntPair withSecond(int second)

Get this pair with a different first value.

Parameters:

second - new second value

Returns:

pair with the first value of this pair, and the given second value

swapped

@NotNull
public IntPair swapped()

Get this pair with swapped values.

Returns:

pair with swapped first and second values

size

public int size()

Description copied from interface: Sizeable

Get the size. Size is never negative.

Specified by:

size in interface Sizeable

Returns:

the size of this object, usually the number of contained elements, must not be negative

get

public int get(int index)

Description copied from interface: IntIndexable

Get the element at the given index.

Specified by:

get in interface IntIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsInts

public <T> T applyAsInts(@NotNull
                         IntFunction2<T> function)

Apply a 2-int function on this pair.

Type Parameters:

T - output type

Parameters:

function - function to apply, first becomes its first, second its second argument

Returns:

result of applying the function

operate

public int operate(@NotNull
                   IntOperator2 operator)

Call an 2-int operator on this pair.

Parameters:

operator - operator to apply, first becomes its first, second its second argument

Returns:

result of applying the operator

test

public boolean test(@NotNull
                    IntPredicate2 predicate)

Call a 2-int predicate on this pair.

Parameters:

predicate - predicate to apply, first becomes its first, second its second argument

Returns:

result of testing this pair

toTuple

@NotNull
public Tuple2<java.lang.Integer,java.lang.Integer> toTuple()

Convert this into a tuple.

Returns:

tuple created from this pair

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object