it.unimi.dsi.fastutil.doubles.DoubleCharPair 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.doubles;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some additional methods that
* use polymorphism to avoid (un)boxing.
*/
public interface DoubleCharPair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public double leftDouble();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double left() {
return Double.valueOf(leftDouble());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation throws an {@link UnsupportedOperationException}.
*/
public default DoubleCharPair left(final double l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default DoubleCharPair left(final Double l) {
return left((l).doubleValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default double firstDouble() {
return leftDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double first() {
return Double.valueOf(firstDouble());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation delegates to {@link #left(Object)}.
*/
public default DoubleCharPair first(final double l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default DoubleCharPair first(final Double l) {
return first((l).doubleValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default double keyDouble() {
return firstDouble();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Double key() {
return Double.valueOf(keyDouble());
}
/**
* Sets the left element of this pair (optional operation).
*
* @param l a new value for the left element.
*
* @implSpec This implementation delegates to {@link #left(Object)}.
*/
public default DoubleCharPair key(final double l) {
return left(l);
}
@Override
@Deprecated
public default DoubleCharPair key(Double l) {
return key((l).doubleValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*/
public char rightChar();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character right() {
return Character.valueOf(rightChar());
}
/**
* 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 DoubleCharPair right(final char r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default DoubleCharPair right(final Character l) {
return right((l).charValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default char secondChar() {
return rightChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character second() {
return Character.valueOf(secondChar());
}
/**
* 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 DoubleCharPair second(final char r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default DoubleCharPair second(final Character l) {
return second((l).charValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default char valueChar() {
return rightChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Character value() {
return Character.valueOf(valueChar());
}
/**
* 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 DoubleCharPair value(final char r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default DoubleCharPair value(final Character l) {
return value((l).charValue());
}
/**
* 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 DoubleCharPair of(final double left, final char right) {
return new DoubleCharImmutablePair(left, right);
}
/**
* Returns a lexicographical comparator for pairs.
*
*
* The comparator returned by this method implements lexicographical order. It compares first the
* left elements: if the result of the comparison is nonzero, it returns said result. Otherwise,
* this comparator returns the result of the comparison of the right elements.
*
* @return a lexicographical comparator for pairs.
*/
public static java.util.Comparator lexComparator() {
return (x, y) -> {
final int t = Double.compare(x.leftDouble(), y.leftDouble());
if (t != 0) return t;
return Character.compare(x.rightChar(), y.rightChar());
};
}
}