org.lenskit.util.keys

Class KeyedObjectMap<T>

java.lang.Object

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectFunction<V>

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectMap<V>

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectSortedMap<T>

org.lenskit.util.keys.KeyedObjectMap<T>

All Implemented Interfaces:

Long2ObjectFunction<T>, Long2ObjectMap<T>, Long2ObjectSortedMap<T>, java.io.Serializable, java.lang.Iterable<T>, java.util.function.Function<java.lang.Long,T>, java.util.function.LongFunction<T>, java.util.Map<java.lang.Long,T>, java.util.SortedMap<java.lang.Long,T>

@Immutable
public class KeyedObjectMap<T>
extends AbstractLong2ObjectSortedMap<T>
implements java.io.Serializable, java.lang.Iterable<T>

A map that allows objects with long keys to be looked up by key. This structure works on objects that have an associated key, such as recommendation results or ratings (keyed by user or item ID). The key is extracted from an object by means of a KeyExtractor. This allows the objects to be stored directly, without separate storage for keys. This map stores objects in a list sorted by key, and looks them up with binary search. Therefore, the key extractor should generally be fast (e.g. just calling a getter), in order for this class to be performant.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectSortedMap

AbstractLong2ObjectSortedMap.KeySetIterator<V>, AbstractLong2ObjectSortedMap.ValuesCollection, AbstractLong2ObjectSortedMap.ValuesIterator<V>

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectMap

AbstractLong2ObjectMap.BasicEntry<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectSortedMap

Long2ObjectSortedMap.FastSortedEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectMap

Long2ObjectMap.Entry<V>, Long2ObjectMap.FastEntrySet<V>

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
KeyedObjectMap(java.lang.Iterable<? extends T> objs, KeyExtractor<? super T> ex) Create a new keyed object map from a collection of data.

Method Summary

Modifier and Type	Method and Description
LongComparator	comparator()
boolean	containsKey(long k)
boolean	containsValue(java.lang.Object v)
static <T extends KeyedObject> KeyedObjectMap<T>	create(java.util.Collection<? extends T> objs) Create a new keyed object map.
static <T> KeyedObjectMap<T>	create(java.lang.Iterable<? extends T> objs, KeyExtractor<? super T> ex) Create a new keyed object map.
long	firstLongKey()
T	get(long k)
KeyedObjectMap<T>	headMap(long l)
ObjectBidirectionalIterator<T>	iterator()
LongSortedSet	keySet()
long	lastLongKey()
ObjectSortedSet<Long2ObjectMap.Entry<T>>	long2ObjectEntrySet()
static <T extends KeyedObject> KeyedObjectMapBuilder<T>	newBuilder() Create a new builder for a keyed object map over a self-keying type.
static <T> KeyedObjectMapBuilder<T>	newBuilder(KeyExtractor<? super T> ex) Create a new builder for a keyed object map.
int	size()
KeyedObjectMap<T>	subMap(long from, long to)
KeyedObjectMap<T>	tailMap(long l)
ObjectCollection<T>	values()

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectMap

equals, hashCode, isEmpty, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectMap

clear, compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, defaultReturnValue, defaultReturnValue, get, getOrDefault, getOrDefault, merge, merge, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectFunction

apply, put, remove

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, isEmpty, putAll, replaceAll

Constructor Detail

KeyedObjectMap

public KeyedObjectMap(java.lang.Iterable<? extends T> objs,
                      KeyExtractor<? super T> ex)

Create a new keyed object map from a collection of data.

Parameters:

objs - The input data.

Method Detail

newBuilder

public static <T> KeyedObjectMapBuilder<T> newBuilder(KeyExtractor<? super T> ex)

Create a new builder for a keyed object map.

Parameters:

ex - The key extractor.

T - The keyed object type.

Returns:

A builder for a keyed object map.

newBuilder

public static <T extends KeyedObject> KeyedObjectMapBuilder<T> newBuilder()

Create a new builder for a keyed object map over a self-keying type.

Parameters:

T - The keyed object type.

Returns:

A builder for a keyed object map.

create

public static <T extends KeyedObject> KeyedObjectMap<T> create(java.util.Collection<? extends T> objs)

Create a new keyed object map.

Parameters:

objs - A collection of objects to put in the map.

T - The keyed object type.

Returns:

A keyed object map of the objects in objs.

create

public static <T> KeyedObjectMap<T> create(java.lang.Iterable<? extends T> objs,
                                           KeyExtractor<? super T> ex)

Create a new keyed object map.

Parameters:

objs - A collection of objects to put in the map.

ex - The key extractor.

T - The keyed object type.

Returns:

A keyed object map of the objects in objs.

long2ObjectEntrySet

public ObjectSortedSet<Long2ObjectMap.Entry<T>> long2ObjectEntrySet()

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<T>

Specified by:

long2ObjectEntrySet in interface Long2ObjectSortedMap<T>

keySet

public LongSortedSet keySet()

Specified by:

keySet in interface Long2ObjectMap<T>

Specified by:

keySet in interface Long2ObjectSortedMap<T>

Specified by:

keySet in interface java.util.Map<java.lang.Long,T>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Long,T>

Overrides:

keySet in class AbstractLong2ObjectSortedMap<T>

values

public ObjectCollection<T> values()

Specified by:

values in interface Long2ObjectMap<T>

Specified by:

values in interface Long2ObjectSortedMap<T>

Specified by:

values in interface java.util.Map<java.lang.Long,T>

Specified by:

values in interface java.util.SortedMap<java.lang.Long,T>

Overrides:

values in class AbstractLong2ObjectSortedMap<T>

iterator

public ObjectBidirectionalIterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

comparator

public LongComparator comparator()

Specified by:

comparator in interface Long2ObjectSortedMap<T>

Specified by:

comparator in interface java.util.SortedMap<java.lang.Long,T>

subMap

public KeyedObjectMap<T> subMap(long from,
                                long to)

Specified by:

subMap in interface Long2ObjectSortedMap<T>

headMap

public KeyedObjectMap<T> headMap(long l)

Specified by:

headMap in interface Long2ObjectSortedMap<T>

tailMap

public KeyedObjectMap<T> tailMap(long l)

Specified by:

tailMap in interface Long2ObjectSortedMap<T>

firstLongKey

public long firstLongKey()

Specified by:

firstLongKey in interface Long2ObjectSortedMap<T>

lastLongKey

public long lastLongKey()

Specified by:

lastLongKey in interface Long2ObjectSortedMap<T>

get

public T get(long k)

Specified by:

get in interface Long2ObjectFunction<T>

containsKey

public boolean containsKey(long k)

Specified by:

containsKey in interface Long2ObjectFunction<T>

Specified by:

containsKey in interface Long2ObjectMap<T>

Overrides:

containsKey in class AbstractLong2ObjectMap<T>

containsValue

public boolean containsValue(java.lang.Object v)

Specified by:

containsValue in interface java.util.Map<java.lang.Long,T>

Overrides:

containsValue in class AbstractLong2ObjectMap<T>

size

public int size()

Specified by:

size in interface Long2ObjectMap<T>

Specified by:

size in interface java.util.Map<java.lang.Long,T>