it.unimi.dsi.fastutil.objects.ReferenceDoublePair Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fastutil Show documentation
Show all versions of fastutil Show documentation
fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.
/*
* Copyright (C) 2020-2023 Sebastiano Vigna
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package it.unimi.dsi.fastutil.objects;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some additional methods that
* use polymorphism to avoid (un)boxing.
*/
public interface ReferenceDoublePair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*/
public double rightDouble();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double right() {
return Double.valueOf(rightDouble());
}
/**
* Sets the right element of this pair (optional operation).
*
* @param r a new value for the right element.
*
* @implSpec This implementation throws an {@link UnsupportedOperationException}.
*/
public default ReferenceDoublePair right(final double r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ReferenceDoublePair right(final Double l) {
return right((l).doubleValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default double secondDouble() {
return rightDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double second() {
return Double.valueOf(secondDouble());
}
/**
* Sets the right element of this pair (optional operation).
*
* @param r a new value for the right element.
*
* @implSpec This implementation delegates to {@link #right(Object)}.
*/
public default ReferenceDoublePair second(final double r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ReferenceDoublePair second(final Double l) {
return second((l).doubleValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default double valueDouble() {
return rightDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double value() {
return Double.valueOf(valueDouble());
}
/**
* Sets the right element of this pair (optional operation).
*
* @param r a new value for the right element.
*
* @implSpec This implementation delegates to {@link #right(Object)}.
*/
public default ReferenceDoublePair value(final double r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ReferenceDoublePair value(final Double l) {
return value((l).doubleValue());
}
/**
* Returns a new type-specific immutable {@link it.unimi.dsi.fastutil.Pair Pair} with given left and
* right value.
*
* @param left the left value.
* @param right the right value.
*/
public static ReferenceDoublePair of(final K left, final double right) {
return new ReferenceDoubleImmutablePair(left, right);
}
}