it.unimi.dsi.fastutil.chars.CharFloatPair 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.chars;
/**
* A type-specific {@link it.unimi.dsi.fastutil.Pair Pair}; provides some
* additional methods that use polymorphism to avoid (un)boxing.
*/
public interface CharFloatPair extends it.unimi.dsi.fastutil.Pair {
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*/
public char leftChar();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Character left() {
return Character.valueOf(leftChar());
}
/**
* 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 CharFloatPair left(final char l) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default CharFloatPair left(final Character l) {
return left((l).charValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implNote This implementation delegates to {@link #left()}.
*
*/
public default char firstChar() {
return leftChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Character first() {
return Character.valueOf(firstChar());
}
/**
* 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 CharFloatPair first(final char l) {
return left(l);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default CharFloatPair first(final Character l) {
return first((l).charValue());
}
/**
* Returns the left element of this pair.
*
* @return the left element of this pair.
*
* @implNote This implementation delegates to {@link #left()}.
*
*/
public default char keyChar() {
return firstChar();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Character key() {
return Character.valueOf(keyChar());
}
/**
* 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 CharFloatPair key(final char l) {
return left(l);
}
@Deprecated
public default CharFloatPair key(Character l) {
return key((l).charValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*/
public float rightFloat();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Float right() {
return Float.valueOf(rightFloat());
}
/**
* 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 CharFloatPair right(final float r) {
throw new UnsupportedOperationException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default CharFloatPair right(final Float l) {
return right((l).floatValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implNote This implementation delegates to {@link #right()}.
*
*/
public default float secondFloat() {
return rightFloat();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Float second() {
return Float.valueOf(secondFloat());
}
/**
* 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 CharFloatPair second(final float r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default CharFloatPair second(final Float l) {
return second((l).floatValue());
}
/**
* Returns the right element of this pair.
*
* @return the right element of this pair.
*
* @implNote This implementation delegates to {@link #right()}.
*
*/
public default float valueFloat() {
return rightFloat();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default Float value() {
return Float.valueOf(valueFloat());
}
/**
* 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 CharFloatPair value(final float r) {
return right(r);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
@Override
public default CharFloatPair value(final Float l) {
return value((l).floatValue());
}
/**
* 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 CharFloatPair of(final char left, final float right) {
return new CharFloatImmutablePair(left, right);
}
}