it.unimi.dsi.fastutil.bytes.ByteDoublePair 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 priority queues with a small memory footprint and fast access and insertion; provides also big (64-bit) arrays, sets and lists, and fast, practical I/O classes for binary and text files.
/*
* Copyright (C) 2002-2020 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.bytes;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some
* additional methods that use polymorphism to avoid (un)boxing.
*/
public interface ByteDoublePair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public byte leftByte();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Byte left() {
return Byte.valueOf(leftByte());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l
* a new value for the left element.
*
* @implNote This implementation throws an
* {@link UnsupportedOperationException}.
*/
public default ByteDoublePair left(final byte l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default ByteDoublePair left(final Byte l) {
return left((l).byteValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implNote This implementation delegates to {@link #left()}.
*
*/
public default byte firstByte() {
return leftByte();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Byte first() {
return Byte.valueOf(firstByte());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l
* a new value for the left element.
*
* @implNote This implementation delegates to {@link #left(Object)}.
*/
public default ByteDoublePair first(final byte l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default ByteDoublePair first(final Byte l) {
return first((l).byteValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implNote This implementation delegates to {@link #left()}.
*
*/
public default byte keyByte() {
return firstByte();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Byte key() {
return Byte.valueOf(keyByte());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l
* a new value for the left element.
*
* @implNote This implementation delegates to {@link #left(Object)}.
*/
public default ByteDoublePair key(final byte l) {
return left(l);
}
@Deprecated
public default ByteDoublePair key(Byte l) {
return key((l).byteValue());
}
/**
* 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.
*/
@SuppressWarnings("deprecation")
@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.
*
* @implNote This implementation throws an
* {@link UnsupportedOperationException}.
*/
public default ByteDoublePair right(final double r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default ByteDoublePair right(final Double l) {
return right((l).doubleValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implNote This implementation delegates to {@link #right()}.
*
*/
public default double secondDouble() {
return rightDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@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.
*
* @implNote This implementation delegates to {@link #right(Object)}.
*/
public default ByteDoublePair second(final double r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default ByteDoublePair second(final Double l) {
return second((l).doubleValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implNote This implementation delegates to {@link #right()}.
*
*/
public default double valueDouble() {
return rightDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@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.
*
* @implNote This implementation delegates to {@link #right(Object)}.
*/
public default ByteDoublePair value(final double r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default ByteDoublePair 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 ByteDoublePair of(final byte left, final double right) {
return new ByteDoubleImmutablePair(left, right);
}
}