io.lacuna.bifurcan

Class FloatMap<V>

java.lang.Object

io.lacuna.bifurcan.FloatMap<V>

All Implemented Interfaces:

ICollection<IMap<Double,V>,IEntry<Double,V>>, IMap<Double,V>, ISortedMap<Double,V>, Cloneable, Iterable<IEntry<Double,V>>, Function<Double,V>

public class FloatMap<V>
extends Object
implements ISortedMap<Double,V>, Cloneable

A map which has floating-point keys, built atop IntMap, with which it shares performance characteristics. Since this is intended foremost as a sorted data structure, it does not allow NaN and treats -0.0 as equivalent to 0.0. Anyone looking for identity-based semantics should use a normal Map instead.

Field Summary

Fields

Modifier and Type	Field and Description
IntMap<V>	map

Constructor Summary

Constructors

Constructor and Description
FloatMap()

Method Summary

Modifier and Type	Method and Description
IEntry<Double,V>	ceil(double key)
IEntry<Double,V>	ceil(Double key)
FloatMap<V>	clone()
Comparator<Double>	comparator()
boolean	contains(double key)
FloatMap<V>	difference(IMap<Double,?> b)
FloatMap<V>	difference(ISet<Double> keys)
IList<IEntry<Double,V>>	entries()
boolean	equals(IMap<Double,V> o, BiPredicate<V,V> valEquals)
boolean	equals(Object obj)
IEntry<Double,V>	floor(double key)
IEntry<Double,V>	floor(Double key)
FloatMap<V>	forked() This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable.
static <V> FloatMap<V>	from(Collection<Map.Entry<Number,V>> collection)
static <V> FloatMap<V>	from(IList<IEntry<Number,V>> list)
static <V> FloatMap<V>	from(IMap<Number,V> m)
static <V> FloatMap<V>	from(Map<Number,V> m)
Optional<V>	get(double key)
V	get(double key, V defaultValue)
V	get(Double key, V defaultValue)
int	hashCode()
OptionalLong	indexOf(double key)
OptionalLong	indexOf(Double key)
FloatMap<V>	intersection(IMap<Double,?> b)
FloatMap<V>	intersection(ISet<Double> keys)
boolean	isLinear()
BiPredicate<Double,Double>	keyEquality()
ToLongFunction<Double>	keyHash()
FloatMap<V>	linear() This returns a data structure which is linear, or temporarily mutable.
<U> FloatMap<U>	mapValues(BiFunction<Double,V,U> f)
FloatMap<V>	merge(IMap<Double,V> b, BinaryOperator<V> mergeFn)
IEntry<Double,V>	nth(long idx)
FloatMap<V>	put(double key, V value)
FloatMap<V>	put(Double key, V value)
FloatMap<V>	put(double key, V value, BinaryOperator<V> merge)
FloatMap<V>	put(Double key, V value, BinaryOperator<V> merge)
FloatMap<V>	put(double key, V value, BinaryOperator<V> merge, Object editor)
FloatMap<V>	put(double key, V value, Object editor)
FloatMap<V>	remove(double key)
FloatMap<V>	remove(Double key)
FloatMap<V>	remove(double key, Object editor)
long	size()
FloatMap<V>	slice(double min, double max)
FloatMap<V>	slice(Double min, Double max)
List<FloatMap<V>>	split(int parts) Splits the collection into roughly even pieces, for parallel processing.
String	toString()
FloatMap<V>	union(IMap<Double,V> m)
FloatMap<V>	update(double key, UnaryOperator<V> update)
FloatMap<V>	update(Double key, UnaryOperator<V> update)
FloatMap<V>	update(double key, UnaryOperator<V> update, Object editor)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.lacuna.bifurcan.ISortedMap

first, last

Methods inherited from interface io.lacuna.bifurcan.IMap

apply, contains, containsAll, containsAll, containsAny, containsAny, get, getOrCreate, hashSortedEntries, iterator, keys, save, spliterator, stream, toMap, values

Methods inherited from interface io.lacuna.bifurcan.ICollection

nth, save

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

map

public IntMap<V> map

Constructor Detail

FloatMap

public FloatMap()

Method Detail

from

public static <V> FloatMap<V> from(IMap<Number,V> m)

from

public static <V> FloatMap<V> from(Map<Number,V> m)

Parameters:

m - a Java map

Returns:

a forked copy of the map

from

public static <V> FloatMap<V> from(Collection<Map.Entry<Number,V>> collection)

Parameters:

collection - a collection of Map.Entry objects

Returns:

an IntMap representing the entries in the collection

from

public static <V> FloatMap<V> from(IList<IEntry<Number,V>> list)

Parameters:

list - a list of IEntry objects

Returns:

an IntMap representing the entries in the list

comparator

public Comparator<Double> comparator()

Specified by:

comparator in interface ISortedMap<Double,V>

keyHash

public ToLongFunction<Double> keyHash()

Specified by:

keyHash in interface IMap<Double,V>

Returns:

the hash function used by the map

keyEquality

public BiPredicate<Double,Double> keyEquality()

Specified by:

keyEquality in interface IMap<Double,V>

Returns:

the key equality semantics used by the map

contains

public boolean contains(double key)

entries

public IList<IEntry<Double,V>> entries()

Specified by:

entries in interface IMap<Double,V>

Returns:

a list containing all the entries within the map

indexOf

public OptionalLong indexOf(double key)

indexOf

public OptionalLong indexOf(Double key)

Specified by:

indexOf in interface IMap<Double,V>

Returns:

the index of key within the collection, if it's present

nth

public IEntry<Double,V> nth(long idx)

Specified by:

nth in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Returns:

the element at idx

size

public long size()

Specified by:

size in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Returns:

the number of elements in the collection

floor

public IEntry<Double,V> floor(double key)

floor

public IEntry<Double,V> floor(Double key)

Specified by:

floor in interface ISortedMap<Double,V>

Returns:

the entry whose key is either equal to key, or just below it. If key is less than the minimum value in the map, returns null.

ceil

public IEntry<Double,V> ceil(double key)

ceil

public IEntry<Double,V> ceil(Double key)

Specified by:

ceil in interface ISortedMap<Double,V>

Returns:

the entry whose key is either equal to key, or just above it. If key is greater than the maximum value in the map, returns null.

slice

public FloatMap<V> slice(double min,
                         double max)

slice

public FloatMap<V> slice(Double min,
                         Double max)

Specified by:

slice in interface ISortedMap<Double,V>

Parameters:

min - the inclusive minimum key value

max - the inclusive maximum key value

Returns:

a map representing all entries within [ min, max]

merge

public FloatMap<V> merge(IMap<Double,V> b,
                         BinaryOperator<V> mergeFn)

Specified by:

merge in interface IMap<Double,V>

Specified by:

merge in interface ISortedMap<Double,V>

Parameters:

b - another map

mergeFn - a function which, in the case of key collisions, takes two values and returns the merged result

Returns:

a new map representing the merger of the two maps

difference

public FloatMap<V> difference(ISet<Double> keys)

Specified by:

difference in interface IMap<Double,V>

Specified by:

difference in interface ISortedMap<Double,V>

Returns:

a new map representing the current map, less the keys in keys

intersection

public FloatMap<V> intersection(ISet<Double> keys)

Specified by:

intersection in interface IMap<Double,V>

Specified by:

intersection in interface ISortedMap<Double,V>

Returns:

a new map representing the current map, but only with the keys in keys

union

public FloatMap<V> union(IMap<Double,V> m)

Specified by:

union in interface IMap<Double,V>

Specified by:

union in interface ISortedMap<Double,V>

Returns:

a combined map, with the values from m shadowing those in this amp

difference

public FloatMap<V> difference(IMap<Double,?> b)

Specified by:

difference in interface IMap<Double,V>

Specified by:

difference in interface ISortedMap<Double,V>

Returns:

a new map representing the current map, less the keys in m

intersection

public FloatMap<V> intersection(IMap<Double,?> b)

Specified by:

intersection in interface IMap<Double,V>

Returns:

a new map representing the current map, but only with the keys in m

put

public FloatMap<V> put(double key,
                       V value)

Parameters:

key - a primitive long key

value - a value

Returns:

an updated FloatMap with value under key

put

public FloatMap<V> put(double key,
                       V value,
                       Object editor)

put

public FloatMap<V> put(double key,
                       V value,
                       BinaryOperator<V> merge)

Parameters:

key - a primitive long key

value - a value

merge - a function which will be invoked if there is a pre-existing value under key, with the current value as the first argument and new value as the second, to determine the combined result

Returns:

an updated map

put

public FloatMap<V> put(double key,
                       V value,
                       BinaryOperator<V> merge,
                       Object editor)

put

public FloatMap<V> put(Double key,
                       V value)

Specified by:

put in interface IMap<Double,V>

Specified by:

put in interface ISortedMap<Double,V>

Returns:

an updated map with value stored under key

put

public FloatMap<V> put(Double key,
                       V value,
                       BinaryOperator<V> merge)

Specified by:

put in interface IMap<Double,V>

Specified by:

put in interface ISortedMap<Double,V>

merge - a function which will be invoked if there is a pre-existing value under key, with the current value as the first argument and new value as the second, to determine the combined result

Returns:

an updated map with value under key

remove

public FloatMap<V> remove(double key)

Returns:

an updated map that does not contain key

remove

public FloatMap<V> remove(double key,
                          Object editor)

remove

public FloatMap<V> remove(Double key)

Specified by:

remove in interface IMap<Double,V>

Specified by:

remove in interface ISortedMap<Double,V>

Returns:

an updated map that does not contain key

mapValues

public <U> FloatMap<U> mapValues(BiFunction<Double,V,U> f)

Specified by:

mapValues in interface IMap<Double,V>

Type Parameters:

U - the new type of the values

Parameters:

f - a function which transforms the values

Returns:

a transformed map which shares the same equality semantics

get

public Optional<V> get(double key)

get

public V get(double key,
             V defaultValue)

get

public V get(Double key,
             V defaultValue)

Specified by:

get in interface IMap<Double,V>

Returns:

the value under key, or defaultValue if there is no such key

update

public FloatMap<V> update(Double key,
                          UnaryOperator<V> update)

Specified by:

update in interface IMap<Double,V>

Specified by:

update in interface ISortedMap<Double,V>

update - a function which takes the existing value, or null if none exists, and returns an updated value.

Returns:

an updated map with update(value) under key.

update

public FloatMap<V> update(double key,
                          UnaryOperator<V> update)

update

public FloatMap<V> update(double key,
                          UnaryOperator<V> update,
                          Object editor)

split

public List<FloatMap<V>> split(int parts)

Description copied from interface: ICollection

Splits the collection into roughly even pieces, for parallel processing. Depending on the size and contents of the collection, this function may not return exactly parts subsets.

Specified by:

split in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Specified by:

split in interface IMap<Double,V>

Parameters:

parts - the target number of pieces

Returns:

a list containing subsets of the collection.

isLinear

public boolean isLinear()

Specified by:

isLinear in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Specified by:

isLinear in interface IMap<Double,V>

Returns:

true, if the collection is linear

forked

public FloatMap<V> forked()

Description copied from interface: ICollection

This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable. This is called "forked" because it means that multiple functions can make divergent changes to the data structure without affecting each other.

If only a single function or scope uses the data structure, it can be left as a linear data structure, which can have significant performance benefits.

If the data structure is already forked, it will simply return itself.

Specified by:

forked in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Specified by:

forked in interface IMap<Double,V>

Specified by:

forked in interface ISortedMap<Double,V>

Returns:

a forked form of the data structure

linear

public FloatMap<V> linear()

Description copied from interface: ICollection

This returns a data structure which is linear, or temporarily mutable. The term "linear", as used here, does not completely align with the formal definition of linear types as used in type theory. It is meant to describe the linear dataflow of the method calls, and as a converse to "forked" data structures.

If ICollection.forked() is called on a linear collection, all references to that linear collection should be discarded.

If the data structure is already linear, it will simply return itself.

Specified by:

linear in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Specified by:

linear in interface IMap<Double,V>

Specified by:

linear in interface ISortedMap<Double,V>

Returns:

a linear form of this data structure

clone

public FloatMap<V> clone()

Specified by:

clone in interface ICollection<IMap<Double,V>,IEntry<Double,V>>

Overrides:

clone in class Object

Returns:

a cloned copy of the collection

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(IMap<Double,V> o,
                      BiPredicate<V,V> valEquals)

Specified by:

equals in interface IMap<Double,V>

Parameters:

o - another map

valEquals - a predicate which checks value equalities

Returns:

true, if the maps are equivalent

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object