it.unimi.dsi.fastutil.chars

Class Char2DoubleMaps

java.lang.Object

it.unimi.dsi.fastutil.chars.Char2DoubleMaps

public final class Char2DoubleMaps
extends Object

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

See Also:

Collections

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Char2DoubleMaps.EmptyMap An immutable class representing an empty type-specific map.
static class	Char2DoubleMaps.Singleton An immutable class representing a type-specific singleton map.
static class	Char2DoubleMaps.SynchronizedMap A synchronized wrapper class for maps.
static class	Char2DoubleMaps.UnmodifiableMap An unmodifiable wrapper class for maps.

Field Summary

Fields

Modifier and Type	Field and Description
static Char2DoubleMaps.EmptyMap	EMPTY_MAP An empty type-specific map (immutable).

Method Summary

Modifier and Type	Method and Description
static void	fastForEach(Char2DoubleMap map, Consumer<? super Char2DoubleMap.Entry> consumer) Iterates quickly, if possible, on the entry set of the provided map.
static ObjectIterable<Char2DoubleMap.Entry>	fastIterable(Char2DoubleMap map) Returns an iterable yielding an iterator that will be fast, if possible, on the entry set of the provided map.
static ObjectIterator<Char2DoubleMap.Entry>	fastIterator(Char2DoubleMap map) Returns an iterator that will be fast, if possible, on the entry set of the provided map.
static Char2DoubleMap	singleton(Character key, Double value) Returns a type-specific immutable map containing only the specified pair.
static Char2DoubleMap	singleton(char key, double value) Returns a type-specific immutable map containing only the specified pair.
static Char2DoubleMap	synchronize(Char2DoubleMap m) Returns a synchronized type-specific map backed by the given type-specific map.
static Char2DoubleMap	synchronize(Char2DoubleMap m, Object sync) Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
static Char2DoubleMap	unmodifiable(Char2DoubleMap m) Returns an unmodifiable type-specific map backed by the given type-specific map.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MAP

public static final Char2DoubleMaps.EmptyMap EMPTY_MAP

An empty type-specific map (immutable). It is serializable and cloneable.

Method Detail

fastIterator

public static ObjectIterator<Char2DoubleMap.Entry> fastIterator(Char2DoubleMap map)

Returns an 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) iterator on the entry set.

Returns:

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

Since:

8.0.0

fastForEach

public static void fastForEach(Char2DoubleMap map,
                               Consumer<? super Char2DoubleMap.Entry> consumer)

Iterates quickly, if possible, on the entry set of the provided map.

Parameters:

map - a map on which we will try to iterate quickly.

consumer - the consumer that will be passed to Char2DoubleMap.FastEntrySet.fastForEach(Consumer), if possible, or to Iterable.forEach(Consumer).

Since:

8.1.0

fastIterable

public static ObjectIterable<Char2DoubleMap.Entry> fastIterable(Char2DoubleMap map)

Returns an iterable yielding an 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) iterator on the entry set.

Returns:

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

Since:

8.0.0

singleton

public static Char2DoubleMap singleton(char key,
                                       double value)

Returns a type-specific immutable map containing only the specified pair. The returned 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 map.

value - the only value of the returned map.

Returns:

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

singleton

public static Char2DoubleMap singleton(Character key,
                                       Double value)

Returns a type-specific immutable map containing only the specified pair. The returned 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 map.

value - the only value of the returned map.

Returns:

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

synchronize

public static Char2DoubleMap synchronize(Char2DoubleMap m)

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

Parameters:

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

Returns:

a synchronized view of the specified map.

See Also:

Collections.synchronizedMap(Map)

synchronize

public static Char2DoubleMap synchronize(Char2DoubleMap m,
                                         Object sync)

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

Parameters:

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

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

Returns:

a synchronized view of the specified map.

See Also:

Collections.synchronizedMap(Map)

unmodifiable

public static Char2DoubleMap unmodifiable(Char2DoubleMap m)

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

Parameters:

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

Returns:

an unmodifiable view of the specified map.

See Also:

Collections.unmodifiableMap(Map)