Package io.vavr.collection

package io.vavr.collection

Purely functional collections based on Traversable.

Performance Characteristics of Vavr Collections

Time Complexity of Sequential Operations

	head()	tail()	get(int)	update(int, T)	prepend(T)	append(T)
Array	const	linear	const	linear	linear	linear
CharSeq	const	linear	const	linear	linear	linear
Iterator	const	const	—	—	—	—
List	const	const	linear	linear	const	linear
Queue	const	consta	linear	linear	const	const
PriorityQueue	log	log	—	—	log	log
Stream	const	const	linear	linear	constlazy	constlazy
Vector	consteff	consteff	consteff	consteff	consteff	consteff

Time Complexity of Map/Set Operations

	contains/Key	add/put	remove	min
HashMap	consteff	consteff	consteff	linear
HashSet	consteff	consteff	consteff	linear
LinkedHashMap	consteff	linear	linear	linear
LinkedHashSet	consteff	linear	linear	linear
Tree	log	log	log	log
TreeMap	log	log	log	log
TreeSet	log	log	log	log

• const · constant time
• const^a · amortized constant time, few operations may take longer
• const^eff · effectively constant time, depending on assumptions like distribution of hash keys
• const^lazy · lazy constant time, the operation is deferred
• log · logarithmic time
• linear · linear time

Related Packages

Package	Description
io.vavr	Beside API the io.vavr package contains core types like (Checked)Functions and Tuples.
io.vavr.concurrent	This package contains basic building blocks for creating fast, asynchronous, non-blocking parallel code.
io.vavr.control	Control structures like the disjoint union type Either, the optional value type Option and Try for exception handling.

Class	Description
AbstractIterator<T>	Provides a common Object.toString() implementation.
AbstractMultimap<K, V, M extends Multimap<K,V>>	An abstract base implementation of the Multimap interface that provides common functionality for concrete Multimap implementations.
AbstractMultimap.SerializableSupplier<T>
AbstractQueue<T, Q extends AbstractQueue<T,Q>>
Array<T>	Array is an immutable Traversable wrapper for Object[] containing elements of type T.
ArrayModule
ArrayModule.Combinations
ArrayType<T>	Helper to replace reflective array access.
ArrayType.BooleanArrayType
ArrayType.ByteArrayType
ArrayType.CharArrayType
ArrayType.DoubleArrayType
ArrayType.FloatArrayType
ArrayType.IntArrayType
ArrayType.LongArrayType
ArrayType.ObjectArrayType
ArrayType.ShortArrayType
BitMappedTrie<T>	A `bit-mapped trie` is a very wide and shallow tree (for integer indices the depth will be `≤6`).
BitSet<T>	An immutable BitSet implementation.
BitSet.Builder<T>	Builder of the BitSet.
BitSetModule
BitSetModule.AbstractBitSet<T>
BitSetModule.BitSet1<T>
BitSetModule.BitSet2<T>
BitSetModule.BitSetIterator<T>
BitSetModule.BitSetN<T>
CharSeq	The CharSeq (read: character sequence) collection essentially is a rich String wrapper having all operations we know from the functional Vavr collections.
CharSeq.CharFunction<R>	Represents a function that accepts a char-valued argument and produces a result.
CharSeq.CharUnaryOperator	Represents an operation on a single char-valued operand that produces a char-valued result.
CharSeqModule
CharSeqModule.Combinations
Collections	Internal class, containing helpers.
Collections.IterableWithSize<T>
Comparators	INTERNAL: Common Comparator related functions (not intended to be public).
Foldable<T>	Represents a data structure that can be folded (reduced) into a single value.
GwtIncompatible
HashArrayMappedTrie<K,V>	An immutable Hash array mapped trie (HAMT).
HashArrayMappedTrieModule
HashArrayMappedTrieModule.AbstractNode<K,V>	An abstract base class for nodes of a HAMT.
HashArrayMappedTrieModule.Action
HashArrayMappedTrieModule.ArrayNode<K,V>	Representation of a HAMT array node.
HashArrayMappedTrieModule.EmptyNode<K,V>	The empty node.
HashArrayMappedTrieModule.IndexedNode<K,V>	Representation of a HAMT indexed node.
HashArrayMappedTrieModule.LeafList<K,V>	Representation of a HAMT leaf node with more than one element.
HashArrayMappedTrieModule.LeafNode<K,V>	Representation of a HAMT leaf.
HashArrayMappedTrieModule.LeafNodeIterator<K,V>
HashArrayMappedTrieModule.LeafSingleton<K,V>	Representation of a HAMT leaf node with single element.
HashMap<K,V>	An immutable HashMap implementation based on a Hash array mapped trie (HAMT).
HashMap.SerializationProxy<K,V>
HashMultimap<K,V>	A HashMap-based implementation of Multimap
HashMultimap.Builder<V>	Builder for creating HashMultimap instances with different container types.
HashSet<T>	An immutable HashSet implementation.
HashSet.SerializationProxy<T>	A serialization proxy which, in this context, is used to deserialize immutable, linked Lists with final instance fields.
IndexedSeq<T>	Represents an immutable, indexed sequence of elements.
IndexedSeqModule
IndexedSeqModule.Search
IndexedSeqModule.Slice
Iterator<T>	A compositional alternative to java.util.Iterator designed for single-pass traversal of a sequence.
IteratorModule
IteratorModule.BigDecimalHelper
IteratorModule.CachedIterator<T>
IteratorModule.ConcatIterator<T>
IteratorModule.ConcatIterator.Cell<T>
IteratorModule.DistinctIterator<T,U>
IteratorModule.EmptyIterator
IteratorModule.GroupedIterator<T>
JavaConverters	THIS CLASS IS INTENDED TO BE USED INTERNALLY ONLY!
JavaConverters.ChangePolicy
JavaConverters.HasDelegate<C extends Traversable<?>>	Encapsulates the access to delegate and performs mutability checks.
JavaConverters.ListView<T, C extends Seq<T>>
JavaConverters.ListView.Iterator<T, C extends Seq<T>>
JavaConverters.ListView.ListIterator<T, C extends Seq<T>>
LeafVisitor<T>
LinearSeq<T>	Interface for immutable, linear sequences.
LinearSeqModule
LinearSeqModule.Search
LinearSeqModule.Slice
LinkedHashMap<K,V>	An immutable LinkedHashMap implementation that has predictable (insertion-order) iteration.
LinkedHashMultimap<K,V>	A LinkedHashMap-based implementation of Multimap
LinkedHashMultimap.Builder<V>	Builder class for creating LinkedHashMultimap instances.
LinkedHashSet<T>	An immutable HashSet implementation that has predictable (insertion-order) iteration.
LinkedHashSet.SerializationProxy<T>	A serialization proxy which, in this context, is used to deserialize immutable, linked Lists with final instance fields.
List<T>	An immutable List is an eager sequence of elements.
List.Cons<T>	Non-empty List, consisting of a head and a tail.
List.Cons.SerializationProxy<T>	A serialization proxy which, in this context, is used to deserialize immutable, linked Lists with final instance fields.
List.Nil<T>	Representation of the singleton empty List.
ListModule
ListModule.Combinations
ListModule.SplitAt
Map<K,V>	An immutable Map interface.
Maps	INTERNAL: Common Map functions (not intended to be public).
Maps.OfEntries<K, V, M extends Map<K,V>>
Multimap<K,V>	An immutable Multimap interface.
Multimap.ContainerType	Defines the type of container used to store values associated with keys in a Multimap.
Multimaps	INTERNAL: Common Multimap functions (not intended to be public).
NaturalComparator<T>
NodeModifier
Ordered<T>	A collection whose elements are arranged according to a well-defined order.
PriorityQueue<T>	A PriorityQueue.
PriorityQueueBase
PriorityQueueBase.Node<T>
Queue<T>	An immutable Queue stores elements allowing a first-in-first-out (FIFO) retrieval.
RedBlackTree<T>	Purely functional Red/Black Tree, inspired by Kazu Yamamoto's Haskell implementation.
RedBlackTree.Color
RedBlackTreeModule
RedBlackTreeModule.Empty<T>	The empty tree node.
RedBlackTreeModule.Node<T>	A non-empty tree node.
Seq<T>	Base interface for immutable, sequential collections.
Set<T>	An immutable Set interface.
SortedMap<K,V>	An immutable SortedMap interface.
SortedMultimap<K,V>	An immutable SortedMultimap interface.
SortedSet<T>	An immutable SortedSet interface.
Stream<T>	An immutable Stream is lazy sequence of elements which may be infinitely long.
Stream.Cons<T>	Non-empty Stream, consisting of a head, and tail.
Stream.Empty<T>	The empty Stream.
StreamModule
StreamModule.AppendElements<T>
StreamModule.AppendSelf<T>
StreamModule.Combinations
StreamModule.ConsImpl<T>
StreamModule.DropRight
StreamModule.FlatMapIterator<T,U>
StreamModule.SerializationProxy<T>	A serialization proxy which, in this context, is used to deserialize immutable, linked Streams with final instance fields.
StreamModule.StreamFactory
StreamModule.StreamIterator<T>
Traversable<T>	Represents a recursive, multi-valued data structure whose elements can be traversed in order.
TraversableModule
Tree<T>	A general Tree interface.
Tree.Empty<T>	The empty tree.
Tree.Node<T>	Represents a tree node.
Tree.Node.SerializationProxy<T>	A serialization proxy which, in this context, is used to deserialize immutable nodes with final instance fields.
Tree.Order	Tree traversal order.
TreeMap<K,V>	An immutable SortedMap implementation backed by a Red-Black tree.
TreeMap.EntryComparator<K,V>
TreeMap.EntryComparator.Natural<K,V>
TreeMap.EntryComparator.Specific<K,V>
TreeModule	Because the empty tree Empty cannot be a child of an existing tree, method implementations distinguish between the empty and non-empty case.
TreeMultimap<K,V>	A TreeMap-based implementation of Multimap
TreeMultimap.Builder<V>	Builder class for creating TreeMultimap instances.
TreeSet<T>	SortedSet implementation, backed by a Red/Black Tree.
Vector<T>	Vector is the default Seq implementation that provides effectively constant time access to any element.
VectorModule
VectorModule.Combinations