it.unimi.dsi.fastutil.chars

Class Char2IntFunctions

java.lang.Object

it.unimi.dsi.fastutil.chars.Char2IntFunctions

public final class Char2IntFunctions
extends Object

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

See Also:

Function, Collections

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Char2IntFunctions.EmptyFunction An immutable class representing an empty type-specific function.
static class	Char2IntFunctions.PrimitiveFunction An adapter for mapping generic total functions to partial primitive functions.
static class	Char2IntFunctions.Singleton An immutable class representing a type-specific singleton function.
static class	Char2IntFunctions.SynchronizedFunction A synchronized wrapper class for functions.
static class	Char2IntFunctions.UnmodifiableFunction An unmodifiable wrapper class for functions.

Field Summary

Fields

Modifier and Type	Field and Description
static Char2IntFunctions.EmptyFunction	EMPTY_FUNCTION An empty type-specific function (immutable).

Method Summary

Modifier and Type	Method and Description
static Char2IntFunction	primitive(Function<? super Character,? extends Integer> f) Returns a (partial) type-specific function based on the given total generic function.
static Char2IntFunction	singleton(Character key, Integer value) Returns a type-specific immutable function containing only the specified pair.
static Char2IntFunction	singleton(char key, int value) Returns a type-specific immutable function containing only the specified pair.
static Char2IntFunction	synchronize(Char2IntFunction f) Returns a synchronized type-specific function backed by the given type-specific function.
static Char2IntFunction	synchronize(Char2IntFunction f, Object sync) Returns a synchronized type-specific function backed by the given type-specific function, using an assigned object to synchronize.
static Char2IntFunction	unmodifiable(Char2IntFunction f) Returns an unmodifiable type-specific function backed by the given type-specific function.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_FUNCTION

public static final Char2IntFunctions.EmptyFunction EMPTY_FUNCTION

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

Method Detail

singleton

public static Char2IntFunction singleton(char key,
                                         int value)

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

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

Parameters:

key - the only key of the returned function.

value - the only value of the returned function.

Returns:

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

singleton

public static Char2IntFunction singleton(Character key,
                                         Integer value)

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

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

Parameters:

key - the only key of the returned function.

value - the only value of the returned function.

Returns:

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

synchronize

public static Char2IntFunction synchronize(Char2IntFunction f)

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

Parameters:

f - the function to be wrapped in a synchronized function.

Returns:

a synchronized view of the specified function.

See Also:

Collections.synchronizedMap(java.util.Map)

synchronize

public static Char2IntFunction synchronize(Char2IntFunction f,
                                           Object sync)

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

Parameters:

f - the function to be wrapped in a synchronized function.

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

Returns:

a synchronized view of the specified function.

See Also:

Collections.synchronizedMap(java.util.Map)

unmodifiable

public static Char2IntFunction unmodifiable(Char2IntFunction f)

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

Parameters:

f - the function to be wrapped in an unmodifiable function.

Returns:

an unmodifiable view of the specified function.

See Also:

Collections.unmodifiableMap(java.util.Map)

primitive

public static Char2IntFunction primitive(Function<? super Character,? extends Integer> f)

Returns a (partial) type-specific function based on the given total generic function.

The returned function contains all keys which are not mapped to null. If the function already is a primitive function, it is returned without changes.

Warning: If the given function is a “widened” primitive function (e.g. an Int2IntFunction given to Short2ShortFunctions), it still is wrapped into a proxy, decreasing performance.

Parameters:

f - the function to be converted to a type-specific function.

Returns:

a primitive view of the specified function.

Throws:

NullPointerException - if f is null.

Since:

8.1.0

See Also:

Char2IntFunctions.PrimitiveFunction