de.caff.generics

Class ShortPair

java.lang.Object

de.caff.generics.ShortPair

All Implemented Interfaces:

PrimitiveShortIterable, ShortIndexable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Short>

public final class ShortPair
extends java.lang.Object
implements java.io.Serializable, ShortIndexable

A pair of primitive short values.

This is similar to Pair, but for raw short 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.ShortIndexable

ShortIndexable.Base

Field Summary

Fields

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

Fields inherited from interface de.caff.generics.ShortIndexable

EMPTY, SINGLE_0

Fields inherited from interface de.caff.generics.PrimitiveShortIterable

EMPTY_SHORT_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
ShortPair(short first, short second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsShorts(ShortFunction2<T> function) Apply a 2-short function on this pair.
boolean	equals(java.lang.Object o)
short	get(int index) Get the element at the given index.
int	hashCode()
short	operate(ShortOperator2 operator) Call an 2-short operator on this pair.
int	size() Get the size.
ShortPair	swapped() Get this pair with swapped values.
boolean	test(ShortPredicate2 predicate) Call a 2-short predicate on this pair.
IntPair	toIntPair() Convert this pair of shorts into a pair of ints.
java.lang.String	toString()
Tuple2<java.lang.Short,java.lang.Short>	toTuple() Convert this into a tuple.
IntPair	toUnsignedIntPair() Convert this pair of shorts into a pair of ints assuming unsigned values.
ShortPair	withFirst(short first) Get this pair with a different first value.
ShortPair	withSecond(short 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.ShortIndexable

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

Methods inherited from interface de.caff.generics.PrimitiveShortIterable

asIntIterable, asLongIterable, asUnsignedIntIterable, asUnsignedLongIterable, containsShort, forEachShort, forEachShortFragile

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

first

public final short first

The first value of this pair.

second

public final short second

The second value of this pair.

Constructor Detail

ShortPair

public ShortPair(short first,
                 short second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

toIntPair

@NotNull
public IntPair toIntPair()

Convert this pair of shorts into a pair of ints.

Returns:

int pair with same values

toUnsignedIntPair

@NotNull
public IntPair toUnsignedIntPair()

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

Returns:

int pair with the values of this pair assumed unsigned

withFirst

@NotNull
public ShortPair withFirst(short 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 ShortPair withSecond(short 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 ShortPair 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 short get(int index)

Description copied from interface: ShortIndexable

Get the element at the given index.

Specified by:

get in interface ShortIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsShorts

public <T> T applyAsShorts(@NotNull
                           ShortFunction2<T> function)

Apply a 2-short 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 short operate(@NotNull
                     ShortOperator2 operator)

Call an 2-short 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
                    ShortPredicate2 predicate)

Call a 2-short 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.Short,java.lang.Short> 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