it.unimi.dsi.fastutil.shorts.ShortBooleanPair 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.shorts;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some additional methods that
* use polymorphism to avoid (un)boxing.
*/
public interface ShortBooleanPair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public short leftShort();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Short left() {
return Short.valueOf(leftShort());
}
/**
* 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 ShortBooleanPair left(final short l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ShortBooleanPair left(final Short l) {
return left((l).shortValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default short firstShort() {
return leftShort();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Short first() {
return Short.valueOf(firstShort());
}
/**
* 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 ShortBooleanPair first(final short l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ShortBooleanPair first(final Short l) {
return first((l).shortValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default short keyShort() {
return firstShort();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Short key() {
return Short.valueOf(keyShort());
}
/**
* 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 ShortBooleanPair key(final short l) {
return left(l);
}
@Override
@Deprecated
public default ShortBooleanPair key(Short l) {
return key((l).shortValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*/
public boolean rightBoolean();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Boolean right() {
return Boolean.valueOf(rightBoolean());
}
/**
* 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 ShortBooleanPair right(final boolean r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ShortBooleanPair right(final Boolean l) {
return right((l).booleanValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default boolean secondBoolean() {
return rightBoolean();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Boolean second() {
return Boolean.valueOf(secondBoolean());
}
/**
* 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 ShortBooleanPair second(final boolean r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ShortBooleanPair second(final Boolean l) {
return second((l).booleanValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default boolean valueBoolean() {
return rightBoolean();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default Boolean value() {
return Boolean.valueOf(valueBoolean());
}
/**
* 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 ShortBooleanPair value(final boolean r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public default ShortBooleanPair value(final Boolean l) {
return value((l).booleanValue());
}
/**
* 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 ShortBooleanPair of(final short left, final boolean right) {
return new ShortBooleanImmutablePair(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 = Short.compare(x.leftShort(), y.leftShort());
if (t != 0) return t;
return Boolean.compare(x.rightBoolean(), y.rightBoolean());
};
}
}