it.unimi.dsi.fastutil.longs.LongLongPair Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fastutil-core Show documentation
Show all versions of fastutil-core Show documentation
fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast operations; 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. This jar (fastutil-core.jar) contains data structures based on integers, longs, doubles, and objects, only; fastutil.jar contains all classes. If you have both jars in your dependencies, this jar should be excluded.
/*
* Copyright (C) 2020-2021 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.longs;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some
* additional methods that use polymorphism to avoid (un)boxing.
*/
public interface LongLongPair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public long leftLong();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long left() {
return Long.valueOf(leftLong());
}
/**
* 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 LongLongPair left(final long l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default LongLongPair left(final Long l) {
return left((l).longValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default long firstLong() {
return leftLong();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long first() {
return Long.valueOf(firstLong());
}
/**
* 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 LongLongPair first(final long l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default LongLongPair first(final Long l) {
return first((l).longValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implSpec This implementation delegates to {@link #left()}.
*
*/
public default long keyLong() {
return firstLong();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long key() {
return Long.valueOf(keyLong());
}
/**
* 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 LongLongPair key(final long l) {
return left(l);
}
@Override
@Deprecated
public default LongLongPair key(Long l) {
return key((l).longValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*/
public long rightLong();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long right() {
return Long.valueOf(rightLong());
}
/**
* 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 LongLongPair right(final long r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default LongLongPair right(final Long l) {
return right((l).longValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default long secondLong() {
return rightLong();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long second() {
return Long.valueOf(secondLong());
}
/**
* 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 LongLongPair second(final long r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default LongLongPair second(final Long l) {
return second((l).longValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implSpec This implementation delegates to {@link #right()}.
*
*/
public default long valueLong() {
return rightLong();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Long value() {
return Long.valueOf(valueLong());
}
/**
* 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 LongLongPair value(final long r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default LongLongPair value(final Long l) {
return value((l).longValue());
}
/**
* 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 LongLongPair of(final long left, final long right) {
return new LongLongImmutablePair(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 = Long.compare(x.leftLong(), y.leftLong());
if (t != 0)
return t;
return Long.compare(x.rightLong(), y.rightLong());
};
}
}