Package it.unimi.dsi.fastutil.ints

Class Int2IntSortedMaps

java.lang.Object

it.unimi.dsi.fastutil.ints.Int2IntSortedMaps

public final class Int2IntSortedMaps
extends java.lang.Object

A class providing static methods and objects that do useful things with type-specific sorted maps.

See Also:

Collections

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Int2IntSortedMaps.EmptySortedMap	An immutable class representing an empty type-specific sorted map.
static class	Int2IntSortedMaps.Singleton	An immutable class representing a type-specific singleton sorted map.
static class	Int2IntSortedMaps.SynchronizedSortedMap	A synchronized wrapper class for sorted maps.
static class	Int2IntSortedMaps.UnmodifiableSortedMap	An unmodifiable wrapper class for sorted maps.

Field Summary

Fields

Modifier and Type	Field	Description
static Int2IntSortedMaps.EmptySortedMap	EMPTY_MAP	An empty sorted map (immutable).

Method Summary

Modifier and Type	Method	Description
static java.util.Comparator<? super java.util.Map.Entry<java.lang.Integer,?>>	entryComparator(IntComparator comparator)	Returns a comparator for entries based on a given comparator on keys.
static ObjectBidirectionalIterable<Int2IntMap.Entry>	fastIterable(Int2IntSortedMap map)	Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static ObjectBidirectionalIterator<Int2IntMap.Entry>	fastIterator(Int2IntSortedMap map)	Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
static Int2IntSortedMap	singleton(int key, int value)	Returns a type-specific immutable sorted map containing only the specified pair.
static Int2IntSortedMap	singleton(int key, int value, IntComparator comparator)	Returns a type-specific immutable sorted map containing only the specified pair.
static Int2IntSortedMap	singleton(java.lang.Integer key, java.lang.Integer value)	Returns a type-specific immutable sorted map containing only the specified pair.
static Int2IntSortedMap	singleton(java.lang.Integer key, java.lang.Integer value, IntComparator comparator)	RETURNS a type-specific immutable sorted map containing only the specified pair.
static Int2IntSortedMap	synchronize(Int2IntSortedMap m)	Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.
static Int2IntSortedMap	synchronize(Int2IntSortedMap m, java.lang.Object sync)	Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.
static Int2IntSortedMap	unmodifiable(Int2IntSortedMap m)	Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_MAP

public static final Int2IntSortedMaps.EmptySortedMap EMPTY_MAP

An empty sorted map (immutable). It is serializable and cloneable.

Method Detail

entryComparator

public static java.util.Comparator<? super java.util.Map.Entry<java.lang.Integer,?>> entryComparator(IntComparator comparator)

Returns a comparator for entries based on a given comparator on keys.

Parameters:

comparator - a comparator on keys.

Returns:

the associated comparator on entries.

fastIterator

public static ObjectBidirectionalIterator<Int2IntMap.Entry> fastIterator(Int2IntSortedMap map)

Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.

Parameters:

map - a map from which we will try to extract a (fast) bidirectional iterator on the entry set.

Returns:

a bidirectional iterator on the entry set of the given map that will be fast, if possible.

Since:

8.0.0

fastIterable

public static ObjectBidirectionalIterable<Int2IntMap.Entry> fastIterable(Int2IntSortedMap map)

Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.

Parameters:

map - a map from which we will try to extract an iterable yielding a (fast) bidirectional iterator on the entry set.

Returns:

an iterable yielding a bidirectional iterator on the entry set of the given map that will be fast, if possible.

Since:

8.0.0

singleton

public static Int2IntSortedMap singleton(java.lang.Integer key,
                                         java.lang.Integer value)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.

Note that albeit the returned map is immutable, its default return value may be changed.

Parameters:

key - the only key of the returned sorted map.

value - the only value of the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Int2IntSortedMap singleton(java.lang.Integer key,
                                         java.lang.Integer value,
                                         IntComparator comparator)

RETURNS a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.

Note that albeit the returned map is immutable, its default return value may be changed.

Parameters:

key - the only key of the returned sorted map.

value - the only value of the returned sorted map.

comparator - the comparator to use in the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Int2IntSortedMap singleton(int key,
                                         int value)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.

Note that albeit the returned map is immutable, its default return value may be changed.

Parameters:

key - the only key of the returned sorted map.

value - the only value of the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

singleton

public static Int2IntSortedMap singleton(int key,
                                         int value,
                                         IntComparator comparator)

Returns a type-specific immutable sorted map containing only the specified pair. The returned sorted map is serializable and cloneable.

Note that albeit the returned map is immutable, its default return value may be changed.

Parameters:

key - the only key of the returned sorted map.

value - the only value of the returned sorted map.

comparator - the comparator to use in the returned sorted map.

Returns:

a type-specific immutable sorted map containing just the pair <key,value>.

synchronize

public static Int2IntSortedMap synchronize(Int2IntSortedMap m)

Returns a synchronized type-specific sorted map backed by the given type-specific sorted map.

Parameters:

m - the sorted map to be wrapped in a synchronized sorted map.

Returns:

a synchronized view of the specified sorted map.

See Also:

Collections.synchronizedSortedMap(SortedMap)

synchronize

public static Int2IntSortedMap synchronize(Int2IntSortedMap m,
                                           java.lang.Object sync)

Returns a synchronized type-specific sorted map backed by the given type-specific sorted map, using an assigned object to synchronize.

Parameters:

m - the sorted map to be wrapped in a synchronized sorted map.

sync - an object that will be used to synchronize the access to the sorted sorted map.

Returns:

a synchronized view of the specified sorted map.

See Also:

Collections.synchronizedSortedMap(SortedMap)

unmodifiable

public static Int2IntSortedMap unmodifiable(Int2IntSortedMap m)

Returns an unmodifiable type-specific sorted map backed by the given type-specific sorted map.

Parameters:

m - the sorted map to be wrapped in an unmodifiable sorted map.

Returns:

an unmodifiable view of the specified sorted map.

See Also:

Collections.unmodifiableSortedMap(SortedMap)