de.caff.generics

Class DoublePair

java.lang.Object

de.caff.generics.DoublePair

All Implemented Interfaces:

DoubleIndexable, PrimitiveDoubleIterable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Double>

public final class DoublePair
extends java.lang.Object
implements java.io.Serializable, DoubleIndexable

A pair of primitive double values.

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

DoubleIndexable.Base, DoubleIndexable.DoubleIndexableSpliterator

Field Summary

Fields

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

Fields inherited from interface de.caff.generics.DoubleIndexable

EMPTY, SINGLE_0

Fields inherited from interface de.caff.generics.PrimitiveDoubleIterable

EMPTY_DOUBLE_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
DoublePair(double first, double second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsDoubles(DoubleFunction2<T> function) Apply a 2-double function on this pair.
boolean	equals(java.lang.Object o)
double	get(int index) Get the element at the given index.
int	hashCode()
double	operate(DoubleOperator2 operator) Call an 2-double operator on this pair.
int	size() Get the size.
DoublePair	swapped() Get this pair with swapped values.
boolean	test(DoublePredicate2 predicate) Call a 2-double predicate on this pair.
java.lang.String	toString()
Tuple2<java.lang.Double,java.lang.Double>	toTuple() Convert this into a tuple.
DoublePair	withFirst(double first) Get this pair with a different first value.
DoublePair	withSecond(double 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.DoubleIndexable

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

Methods inherited from interface de.caff.generics.PrimitiveDoubleIterable

average, containsDouble, containsDouble, forEachDouble, forEachDoubleFragile, spliterator, stream, sum

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

first

public final double first

The first value of this pair.

second

public final double second

The second value of this pair.

Constructor Detail

DoublePair

public DoublePair(double first,
                  double second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

withFirst

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

Description copied from interface: DoubleIndexable

Get the element at the given index.

Specified by:

get in interface DoubleIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsDoubles

public <T> T applyAsDoubles(@NotNull
                            DoubleFunction2<T> function)

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

Call an 2-double 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
                    DoublePredicate2 predicate)

Call a 2-double 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.Double,java.lang.Double> 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