io.vavr.collection (vavr 1.0.0-alpha-4 API)

Interface Summary
Interface	Description
CharSeq.CharFunction<R>
CharSeq.CharUnaryOperator
Foldable<T>	Deprecated Marked for removal.
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.
Map<K,V>	An immutable `Map` interface.
Multimap<K,V>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
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>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
SortedSet<T>	An immutable `SortedSet` interface.
Traversable<T>	An interface for inherently recursive, multi-valued data structures.

Class Summary
Class	Description
Array<T>	Array is a Traversable wrapper for `Object[]` containing elements of type `T`.
BitSet<T>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
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>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
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>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
LinkedHashMultimap.Builder<V>
LinkedHashSet<T>	An immutable `HashSet` implementation that has predictable (insertion-order) iteration.
List<T>	An immutable `List` is an eager sequence of elements.
List.Cons<T>	Deprecated will be removed from the public API
List.Nil<T>	Deprecated will be removed from the public API
PriorityQueue<T>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
Queue<T>	An immutable `Queue` stores elements allowing a first-in-first-out (FIFO) retrieval.
Stream<T>	An immutable `Stream` is lazy sequence of elements which may be infinitely long.
Stream.Cons<T>	Deprecated will be removed from the public API
Stream.Empty<T>	Deprecated will be removed from the public API
Tree<T>	A general Tree interface.
Tree.Empty<T>	Deprecated will be removed from the public API
Tree.Node<T>	Deprecated will be removed from the public API
TreeMap<K,V>	SortedMap implementation, backed by a Red/Black Tree.
TreeMultimap<K,V>	Deprecated marked for removal from vavr core lib, might be moved to an extended collections module
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.

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	linear	linear	linear
CharSeq	const	linear	const	linear	linear	linear
Iterator	const	const	—	—	—	—
List	const	const	linear	linear	const	linear
Queue	const	const^a	linear	linear	const	const
PriorityQueue	log	log	—	—	log	log
Stream	const	const	linear	linear	const^lazy	const^lazy
Vector	const^eff	const^eff	const^eff	const^eff	const^eff	const^eff

Time Complexity of Map/Set Operations
	contains/Key	add/put	remove	min
HashMap	const^eff	const^eff	const^eff	linear
HashSet	const^eff	const^eff	const^eff	linear
LinkedHashMap	const^eff	linear	linear	linear
LinkedHashSet	const^eff	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