org.lenskit.util.keys

Class LongSortedArraySet

java.lang.Object

java.util.AbstractCollection<java.lang.Long>

it.unimi.dsi.fastutil.longs.AbstractLongCollection

it.unimi.dsi.fastutil.longs.AbstractLongSet

it.unimi.dsi.fastutil.longs.AbstractLongSortedSet

org.lenskit.util.keys.LongSortedArraySet

All Implemented Interfaces:

LongBidirectionalIterable, LongCollection, LongIterable, LongSet, LongSortedSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.Set<java.lang.Long>, java.util.SortedSet<java.lang.Long>

@Immutable
public class LongSortedArraySet
extends AbstractLongSortedSet
implements java.io.Serializable

A sorted set of longs implemented using a sorted array. It’s much faster than LongArraySet as it is able to use binary searches, while maintaining the space compactness of array-backed sets. Long sorted array sets are immutable.

No orders are supported other than the natural ordering.

Since:

3.0 (a different version existed earlier.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LongSortedArraySet(java.util.Collection<java.lang.Long> items) Construct a new array set from a collection of items.
LongSortedArraySet(long[] items) Construct a new array set from an array of items.
LongSortedArraySet(SortedKeyIndex ks) Construct a new long sorted array set from a key domain.

Method Summary

Modifier and Type	Method and Description
LongComparator	comparator()
boolean	contains(long key)
long	firstLong()
SortedKeyIndex	getDomain() Deprecated. Use getIndex().
SortedKeyIndex	getIndex() Get the underlying key index implementation.
LongSortedSet	headSet(long key)
LongBidirectionalIterator	iterator()
LongBidirectionalIterator	iterator(long key)
long	lastLong()
LongSortedSet	randomSubset(java.util.Random rng, int n, LongSet... exclude) Compute a random subset of this set.
int	size()
LongSortedSet	subSet(long startKey, long endKey)
LongSortedSet	tailSet(long key)

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

equals, hashCode, rem, remove

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

add, add, addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toLongArray, toLongArray, toString

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

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

first, headSet, last, subSet, tailSet

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

add, contains, rem, remove, remove

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

add, addAll, containsAll, removeAll, retainAll, toArray, toLongArray, toLongArray

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

forEach, forEach

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Constructor Detail

LongSortedArraySet

public LongSortedArraySet(@Nonnull
                          SortedKeyIndex ks)

Construct a new long sorted array set from a key domain.

Parameters:

ks - The key set storage.

LongSortedArraySet

public LongSortedArraySet(@Nonnull
                          java.util.Collection<java.lang.Long> items)

Construct a new array set from a collection of items.

Parameters:

items - The set’s contents.

LongSortedArraySet

public LongSortedArraySet(long[] items)

Construct a new array set from an array of items.

Parameters:

items - The items to initialize the set with. The items are copied, the array is not reused.

Method Detail

getIndex

public SortedKeyIndex getIndex()

Get the underlying key index implementation.

getDomain

@Deprecated
public SortedKeyIndex getDomain()

Deprecated. Use getIndex().

Get the index backing this array set.

comparator

public LongComparator comparator()

Specified by:

comparator in interface LongSortedSet

Specified by:

comparator in interface java.util.SortedSet<java.lang.Long>

firstLong

public long firstLong()

Specified by:

firstLong in interface LongSortedSet

lastLong

public long lastLong()

Specified by:

lastLong in interface LongSortedSet

iterator

public LongBidirectionalIterator iterator()

Specified by:

iterator in interface LongBidirectionalIterable

Specified by:

iterator in interface LongCollection

Specified by:

iterator in interface LongIterable

Specified by:

iterator in interface LongSet

Specified by:

iterator in interface LongSortedSet

Specified by:

iterator in interface java.lang.Iterable<java.lang.Long>

Specified by:

iterator in interface java.util.Collection<java.lang.Long>

Specified by:

iterator in interface java.util.Set<java.lang.Long>

Overrides:

iterator in class AbstractLongSortedSet

iterator

public LongBidirectionalIterator iterator(long key)

Specified by:

iterator in interface LongSortedSet

subSet

public LongSortedSet subSet(long startKey,
                            long endKey)

Specified by:

subSet in interface LongSortedSet

headSet

public LongSortedSet headSet(long key)

Specified by:

headSet in interface LongSortedSet

tailSet

public LongSortedSet tailSet(long key)

Specified by:

tailSet in interface LongSortedSet

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Long>

Specified by:

size in interface java.util.Set<java.lang.Long>

Specified by:

size in class java.util.AbstractCollection<java.lang.Long>

contains

public boolean contains(long key)

Specified by:

contains in interface LongCollection

Overrides:

contains in class AbstractLongCollection

randomSubset

public LongSortedSet randomSubset(java.util.Random rng,
                                  int n,
                                  LongSet... exclude)

Compute a random subset of this set.

Parameters:

n - The desired set size.

exclude - One or more sets of items to exclude.

Returns:

A random subset of this set, excluding any items in exclude.