Package io.vavr.collection

Purely functional collections based on Traversable.

See: Description

Interface Summary

Interface	Description
BitSet<T>	An immutable BitSet implementation.
CharSeq.CharFunction<R>
CharSeq.CharUnaryOperator
Foldable<T>	Interface of foldable data structures.
IndexedSeq<T>	Interface for immutable, indexed sequences.
Iterator<T>	io.vavr.collection.Iterator is a compositional replacement for java.util.Iterator whose purpose is to iterate once over a sequence of elements.
LinearSeq<T>	Interface for immutable, linear sequences.
List<T>	An immutable List is an eager sequence of elements.
Map<K,V>	An immutable Map interface.
Multimap<K,V>	An immutable Multimap interface.
Ordered<T>	An ordered collection interface.
Seq<T>	Interface for immutable sequential data structures.
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.
Traversable<T>	An interface for inherently recursive, multi-valued data structures.
Tree<T>	A general Tree interface.

Class Summary

Class	Description
Array<T>	Array is a Traversable wrapper for Object[] containing elements of type T.
BitSet.Builder<T>
CharSeq	The CharSeq (read: character sequence) collection essentially is a rich String wrapper having all operations we know from the functional Vavr collections.
HashMap<K,V>	An immutable HashMap implementation based on a Hash array mapped trie (HAMT).
HashMultimap<K,V>	A HashMap-based implementation of Multimap
HashMultimap.Builder<V>
HashSet<T>	An immutable HashSet implementation.
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>
LinkedHashSet<T>	An immutable HashSet implementation that has predictable (insertion-order) iteration.
List.Cons<T>	Non-empty List, consisting of a head and a tail.
List.Nil<T>	Representation of the singleton empty List.
PriorityQueue<T>	A PriorityQueue.
Queue<T>	An immutable Queue stores elements allowing a first-in-first-out (FIFO) retrieval.
Stream.Cons<T>	Non-empty Stream, consisting of a head, and tail.
Stream.Empty<T>	The empty Stream.
Tree.Empty<T>	The empty tree.
Tree.Node<T>	Represents a tree node.
TreeMap<K,V>	SortedMap implementation, backed by a Red/Black Tree.
TreeMultimap<K,V>	A TreeMap-based implementation of Multimap
TreeMultimap.Builder<V>
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.

Enum Summary

Enum	Description
Multimap.ContainerType
Tree.Order	Tree traversal order.

Package io.vavr.collection Description

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	const	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