/*
	* Copyright (C) 2002-2019 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.floats;
import it.unimi.dsi.fastutil.booleans.BooleanCollection;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import java.util.Map;
import java.util.SortedMap;
A type-specific SortedMap; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens entrySet(), keySet(), values(), comparator(), SortedMap.subMap(Object, Object), SortedMap.headMap(Object) and SortedMap.tailMap(Object).

See Also:
/** * A type-specific {@link SortedMap}; provides some additional methods that use * polymorphism to avoid (un)boxing. * * <p> * Additionally, this interface strengthens {@link #entrySet()}, * {@link #keySet()}, {@link #values()}, {@link #comparator()}, * {@link SortedMap#subMap(Object,Object)}, {@link SortedMap#headMap(Object)} * and {@link SortedMap#tailMap(Object)}. * * @see SortedMap */
public interface Float2BooleanSortedMap extends Float2BooleanMap, SortedMap<Float, Boolean> {
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Note that this specification strengthens the one given in SortedMap.subMap(Object, Object).

See Also:
/** * Returns a view of the portion of this sorted map whose keys range from * {@code fromKey}, inclusive, to {@code toKey}, exclusive. * * <p> * Note that this specification strengthens the one given in * {@link SortedMap#subMap(Object,Object)}. * * @see SortedMap#subMap(Object,Object) */
Float2BooleanSortedMap subMap(float fromKey, float toKey);
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Note that this specification strengthens the one given in SortedMap.headMap(Object).

See Also:
/** * Returns a view of the portion of this sorted map whose keys are strictly less * than {@code toKey}. * * <p> * Note that this specification strengthens the one given in * {@link SortedMap#headMap(Object)}. * * @see SortedMap#headMap(Object) */
Float2BooleanSortedMap headMap(float toKey);
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

See Also:
/** * Returns a view of the portion of this sorted map whose keys are greater than * or equal to {@code fromKey}. * * <p> * Note that this specification strengthens the one given in * {@link SortedMap#tailMap(Object)}. * * @see SortedMap#tailMap(Object) */
Float2BooleanSortedMap tailMap(float fromKey);
Returns the first (lowest) key currently in this map.
See Also:
  • firstKey.firstKey()
/** * Returns the first (lowest) key currently in this map. * * @see SortedMap#firstKey() */
float firstFloatKey();
Returns the last (highest) key currently in this map.
See Also:
  • lastKey.lastKey()
/** * Returns the last (highest) key currently in this map. * * @see SortedMap#lastKey() */
float lastFloatKey();
{@inheritDoc}

Note that this specification strengthens the one given in SortedMap.subMap(Object, Object).

Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * <p> * Note that this specification strengthens the one given in * {@link SortedMap#subMap(Object,Object)}. * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override default Float2BooleanSortedMap subMap(final Float from, final Float to) { return subMap((from).floatValue(), (to).floatValue()); }
{@inheritDoc}

Note that this specification strengthens the one given in SortedMap.headMap(Object).

Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * <p> * Note that this specification strengthens the one given in * {@link SortedMap#headMap(Object)}. * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override default Float2BooleanSortedMap headMap(final Float to) { return headMap((to).floatValue()); }
{@inheritDoc}

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * <p> * Note that this specification strengthens the one given in * {@link SortedMap#tailMap(Object)}. * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override default Float2BooleanSortedMap tailMap(final Float from) { return tailMap((from).floatValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override default Float firstKey() { return Float.valueOf(firstFloatKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override default Float lastKey() { return Float.valueOf(lastFloatKey()); }
A sorted entry set providing fast iteration.

In some cases (e.g., hash-based classes) iteration over an entry set requires the creation of a large number of entry objects. Some fastutil maps might return entry set objects of type FastSortedEntrySet: in this case, fastIterator() will return an iterator that is guaranteed not to create a large number of objects, possibly by returning always the same entry (of course, mutated).

/** * A sorted entry set providing fast iteration. * * <p> * In some cases (e.g., hash-based classes) iteration over an entry set requires * the creation of a large number of entry objects. Some {@code fastutil} maps * might return {@linkplain #entrySet() entry set} objects of type * {@code FastSortedEntrySet}: in this case, {@link #fastIterator() * fastIterator()} will return an iterator that is guaranteed not to create a * large number of objects, <em>possibly by returning always the same entry</em> * (of course, mutated). */
interface FastSortedEntrySet extends ObjectSortedSet<Float2BooleanMap.Entry>, FastEntrySet {
{@inheritDoc}
/** * {@inheritDoc} */
@Override ObjectBidirectionalIterator<Float2BooleanMap.Entry> fastIterator();
Returns a fast iterator over this entry set, starting from a given element of the domain (optional operation); the iterator might return always the same entry instance, suitably mutated.
Params:
  • from – an element to start from.
Returns:a fast iterator over this sorted entry set starting at from; the iterator might return always the same entry object, suitably mutated.
/** * Returns a fast iterator over this entry set, starting from a given element of * the domain (optional operation); the iterator might return always the same * entry instance, suitably mutated. * * @param from * an element to start from. * @return a fast iterator over this sorted entry set starting at {@code from}; * the iterator might return always the same entry object, suitably * mutated. */
ObjectBidirectionalIterator<Float2BooleanMap.Entry> fastIterator(Float2BooleanMap.Entry from); }
Returns a sorted-set view of the mappings contained in this map.

Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

See Also:
Returns:a sorted-set view of the mappings contained in this map.
Deprecated:Please use the corresponding type-specific method instead.
/** * Returns a sorted-set view of the mappings contained in this map. * <p> * Note that this specification strengthens the one given in the corresponding * type-specific unsorted map. * * @return a sorted-set view of the mappings contained in this map. * @see SortedMap#entrySet() * @deprecated Please use the corresponding type-specific method instead. */
@SuppressWarnings({"unchecked", "rawtypes"}) @Deprecated @Override default ObjectSortedSet<Map.Entry<Float, Boolean>> entrySet() { return (ObjectSortedSet) float2BooleanEntrySet(); }
Returns a type-specific sorted-set view of the mappings contained in this map.

Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

See Also:
Returns:a type-specific sorted-set view of the mappings contained in this map.
/** * Returns a type-specific sorted-set view of the mappings contained in this * map. * <p> * Note that this specification strengthens the one given in the corresponding * type-specific unsorted map. * * @return a type-specific sorted-set view of the mappings contained in this * map. * @see #entrySet() */
@Override ObjectSortedSet<Float2BooleanMap.Entry> float2BooleanEntrySet();
Returns a type-specific sorted-set view of the keys contained in this map.

Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

See Also:
Returns:a sorted-set view of the keys contained in this map.
/** * Returns a type-specific sorted-set view of the keys contained in this map. * <p> * Note that this specification strengthens the one given in the corresponding * type-specific unsorted map. * * @return a sorted-set view of the keys contained in this map. * @see SortedMap#keySet() */
@Override FloatSortedSet keySet();
Returns a type-specific set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends SortedMap.

See Also:
Returns:a set view of the values contained in this map.
/** * Returns a type-specific set view of the values contained in this map. * <p> * Note that this specification strengthens the one given in * {@link Map#values()}, which was already strengthened in the corresponding * type-specific class, but was weakened by the fact that this interface extends * {@link SortedMap}. * * @return a set view of the values contained in this map. * @see SortedMap#values() */
@Override BooleanCollection values();
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

See Also:
/** * Returns the comparator associated with this sorted set, or null if it uses * its keys' natural ordering. * * <p> * Note that this specification strengthens the one given in * {@link SortedMap#comparator()}. * * @see SortedMap#comparator() */
@Override FloatComparator comparator(); }