de.caff.generics

Class FloatPair

java.lang.Object

de.caff.generics.FloatPair

All Implemented Interfaces:

FloatIndexable, PrimitiveFloatIterable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Float>

public final class FloatPair
extends java.lang.Object
implements java.io.Serializable, FloatIndexable

A pair of primitive float values.

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

FloatIndexable.Base

Field Summary

Fields

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

Fields inherited from interface de.caff.generics.FloatIndexable

EMPTY, SINGLE_0

Fields inherited from interface de.caff.generics.PrimitiveFloatIterable

EMPTY_FLOAT_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
FloatPair(float first, float second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsFloats(FloatFunction2<T> function) Apply a 2-float function on this pair.
boolean	equals(java.lang.Object o)
float	get(int index) Get the element at the given index.
int	hashCode()
float	operate(FloatOperator2 operator) Call an 2-float operator on this pair.
int	size() Get the size.
FloatPair	swapped() Get this pair with swapped values.
boolean	test(FloatPredicate2 predicate) Call a 2-float predicate on this pair.
DoublePair	toDoublePair() Convert this pair of floats into a pair of doubles.
java.lang.String	toString()
Tuple2<java.lang.Float,java.lang.Float>	toTuple() Convert this into a tuple.
FloatPair	withFirst(float first) Get this pair with a different first value.
FloatPair	withSecond(float 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.FloatIndexable

addAllTo, addToArray, addToArray, asBase, asCollection, asDoubleIndexable, asIndexable, asList, based, binarySearch, binarySearch, compare, doubleIterator, emptyIndexable, equal, equal, equal, equalStandard, firstMatch, floatIterator, floatIterator, foldLeft, frozen, gyt, hash, headSet, indexes, init, initByIndex, intIndexes, isEmpty, isOrdered, isStrictlyOrdered, iterator, lastMatch, listIterator, nextMatch, ordered, ordered, previousMatch, reverse, rotated, singleton, subSet, sybSet, tailSet, toArray, toList, toString, view, viewArray, viewArray, viewArray, viewAsBoolean, viewAsByte, viewAsDouble, viewAsInt, viewAsLong, viewAsShort, viewByIndex, viewIndexable, viewIndexable, viewIndexable, viewList, viewList, viewList, viewNumberArray, viewOp, withAppendedValue, withCachedHash, withExchangedValueAt, withInsertedValueAt, withRemovedValueAt, withSwappedValuesAt

Methods inherited from interface de.caff.generics.PrimitiveFloatIterable

asDoubleIterable, containsFloat, containsFloat, forEachFloat, forEachFloatFragile

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

first

public final float first

The first value of this pair.

second

public final float second

The second value of this pair.

Constructor Detail

FloatPair

public FloatPair(float first,
                 float second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

toDoublePair

@NotNull
public DoublePair toDoublePair()

Convert this pair of floats into a pair of doubles.

Returns:

double pair with same values

withFirst

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

Description copied from interface: FloatIndexable

Get the element at the given index.

Specified by:

get in interface FloatIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsFloats

public <T> T applyAsFloats(@NotNull
                           FloatFunction2<T> function)

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

Call an 2-float 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
                    FloatPredicate2 predicate)

Call a 2-float 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.Float,java.lang.Float> 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