package containers

Import Path
	github.com/emirpasic/gods/containers (on go.dev)

Dependency Relation
	imports one package, and imported by 4 packages

Involved Source Files

	   d➜ containers.go
		Package containers provides core interfaces and functions for data structures.

		Container is the base interface for all data structures to implement.

		Iterators provide stateful iterators.

		Enumerable provides Ruby inspired (each, select, map, find, any?, etc.) container functions.

		Serialization provides serializers (marshalers) and deserializers (unmarshalers).

	      enumerable.go
	      iterator.go
	      serialization.go
Package-Level Type Names (total 9, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Container (interface)
		Container is base interface that all data structures implement.

		Methods (total 4, all are exported)
			( T) Clear()
			( T) Empty() bool
			( T) Size() int
			( T) Values() []interface{}
		Implemented By (at least 4, all are exported)
			 github.com/emirpasic/gods/lists.List (interface)
			*github.com/emirpasic/gods/lists/arraylist.List
			 github.com/emirpasic/gods/trees.Tree (interface)
			*github.com/emirpasic/gods/trees/binaryheap.Heap
		Implements (at least one exported)
			 T : github.com/emirpasic/gods/trees.Tree
		As Inputs Of (at least one exported)
			func GetSortedValues(container Container, comparator utils.Comparator) []interface{}

	 type EnumerableWithIndex (interface)
		EnumerableWithIndex provides functions for ordered containers whose values can be fetched by an index.

		Methods (total 4, all are exported)
			( T) All(func(index int, value interface{}) bool) bool
				All passes each element of the container to the given function and
				returns true if the function returns true for all elements.

			( T) Any(func(index int, value interface{}) bool) bool
				Any passes each element of the container to the given function and
				returns true if the function ever returns true for any element.

			( T) Each(func(index int, value interface{}))
				Each calls the given function once for each element, passing that element's index and value.

			( T) Find(func(index int, value interface{}) bool) (int, interface{})
				Find passes each element of the container to the given function and returns
				the first (index,value) for which the function is true or -1,nil otherwise
				if no element matches the criteria.

		Implemented By (at least one exported)
			*github.com/emirpasic/gods/lists/arraylist.List

	 type EnumerableWithKey (interface)
		EnumerableWithKey provides functions for ordered containers whose values whose elements are key/value pairs.

		Methods (total 4, all are exported)
			( T) All(func(key interface{}, value interface{}) bool) bool
				All passes each element of the container to the given function and
				returns true if the function returns true for all elements.

			( T) Any(func(key interface{}, value interface{}) bool) bool
				Any passes each element of the container to the given function and
				returns true if the function ever returns true for any element.

			( T) Each(func(key interface{}, value interface{}))
				Each calls the given function once for each element, passing that element's key and value.

			( T) Find(func(key interface{}, value interface{}) bool) (interface{}, interface{})
				Find passes each element of the container to the given function and returns
				the first (key,value) for which the function is true or nil,nil otherwise if no element
				matches the criteria.


	 type IteratorWithIndex (interface)
		IteratorWithIndex is stateful iterator for ordered containers whose values can be fetched by an index.

		Methods (total 5, all are exported)
			( T) Begin()
				Begin resets the iterator to its initial state (one-before-first)
				Call Next() to fetch the first element if any.

			( T) First() bool
				First moves the iterator to the first element and returns true if there was a first element in the container.
				If First() returns true, then first element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			( T) Index() int
				Index returns the current element's index.
				Does not modify the state of the iterator.

			( T) Next() bool
				Next moves the iterator to the next element and returns true if there was a next element in the container.
				If Next() returns true, then next element's index and value can be retrieved by Index() and Value().
				If Next() was called for the first time, then it will point the iterator to the first element if it exists.
				Modifies the state of the iterator.

			( T) Value() interface{}
				Value returns the current element's value.
				Does not modify the state of the iterator.

		Implemented By (at least 3, all are exported)
			 ReverseIteratorWithIndex (interface)
			*github.com/emirpasic/gods/lists/arraylist.Iterator
			*github.com/emirpasic/gods/trees/binaryheap.Iterator

	 type IteratorWithKey (interface)
		IteratorWithKey is a stateful iterator for ordered containers whose elements are key value pairs.

		Methods (total 5, all are exported)
			( T) Begin()
				Begin resets the iterator to its initial state (one-before-first)
				Call Next() to fetch the first element if any.

			( T) First() bool
				First moves the iterator to the first element and returns true if there was a first element in the container.
				If First() returns true, then first element's key and value can be retrieved by Key() and Value().
				Modifies the state of the iterator.

			( T) Key() interface{}
				Key returns the current element's key.
				Does not modify the state of the iterator.

			( T) Next() bool
				Next moves the iterator to the next element and returns true if there was a next element in the container.
				If Next() returns true, then next element's key and value can be retrieved by Key() and Value().
				If Next() was called for the first time, then it will point the iterator to the first element if it exists.
				Modifies the state of the iterator.

			( T) Value() interface{}
				Value returns the current element's value.
				Does not modify the state of the iterator.

		Implemented By (at least one exported)
			 ReverseIteratorWithKey (interface)

	 type JSONDeserializer (interface)
		JSONDeserializer provides JSON deserialization

		Methods (only one, which is exported)
			( T) FromJSON([]byte) error
				FromJSON populates containers's elements from the input JSON representation.

		Implemented By (at least 2, both are exported)
			*github.com/emirpasic/gods/lists/arraylist.List
			*github.com/emirpasic/gods/trees/binaryheap.Heap

	 type JSONSerializer (interface)
		JSONSerializer provides JSON serialization

		Methods (only one, which is exported)
			( T) ToJSON() ([]byte, error)
				ToJSON outputs the JSON representation of containers's elements.

		Implemented By (at least 2, both are exported)
			*github.com/emirpasic/gods/lists/arraylist.List
			*github.com/emirpasic/gods/trees/binaryheap.Heap

	 type ReverseIteratorWithIndex (interface)
		ReverseIteratorWithIndex is stateful iterator for ordered containers whose values can be fetched by an index.

		Essentially it is the same as IteratorWithIndex, but provides additional:

		Prev() function to enable traversal in reverse

		Last() function to move the iterator to the last element.

		End() function to move the iterator past the last element (one-past-the-end).

		Methods (total 8, all are exported)
			( T) Begin()
				Begin resets the iterator to its initial state (one-before-first)
				Call Next() to fetch the first element if any.

			( T) End()
				End moves the iterator past the last element (one-past-the-end).
				Call Prev() to fetch the last element if any.

			( T) First() bool
				First moves the iterator to the first element and returns true if there was a first element in the container.
				If First() returns true, then first element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			( T) Index() int
				Index returns the current element's index.
				Does not modify the state of the iterator.

			( T) Last() bool
				Last moves the iterator to the last element and returns true if there was a last element in the container.
				If Last() returns true, then last element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			( T) Next() bool
				Next moves the iterator to the next element and returns true if there was a next element in the container.
				If Next() returns true, then next element's index and value can be retrieved by Index() and Value().
				If Next() was called for the first time, then it will point the iterator to the first element if it exists.
				Modifies the state of the iterator.

			( T) Prev() bool
				Prev moves the iterator to the previous element and returns true if there was a previous element in the container.
				If Prev() returns true, then previous element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			( T) Value() interface{}
				Value returns the current element's value.
				Does not modify the state of the iterator.

		Implemented By (at least 2, both are exported)
			*github.com/emirpasic/gods/lists/arraylist.Iterator
			*github.com/emirpasic/gods/trees/binaryheap.Iterator
		Implements (at least one exported)
			 T : IteratorWithIndex

	 type ReverseIteratorWithKey (interface)
		ReverseIteratorWithKey is a stateful iterator for ordered containers whose elements are key value pairs.

		Essentially it is the same as IteratorWithKey, but provides additional:

		Prev() function to enable traversal in reverse

		Last() function to move the iterator to the last element.

		Methods (total 8, all are exported)
			( T) Begin()
				Begin resets the iterator to its initial state (one-before-first)
				Call Next() to fetch the first element if any.

			( T) End()
				End moves the iterator past the last element (one-past-the-end).
				Call Prev() to fetch the last element if any.

			( T) First() bool
				First moves the iterator to the first element and returns true if there was a first element in the container.
				If First() returns true, then first element's key and value can be retrieved by Key() and Value().
				Modifies the state of the iterator.

			( T) Key() interface{}
				Key returns the current element's key.
				Does not modify the state of the iterator.

			( T) Last() bool
				Last moves the iterator to the last element and returns true if there was a last element in the container.
				If Last() returns true, then last element's key and value can be retrieved by Key() and Value().
				Modifies the state of the iterator.

			( T) Next() bool
				Next moves the iterator to the next element and returns true if there was a next element in the container.
				If Next() returns true, then next element's key and value can be retrieved by Key() and Value().
				If Next() was called for the first time, then it will point the iterator to the first element if it exists.
				Modifies the state of the iterator.

			( T) Prev() bool
				Prev moves the iterator to the previous element and returns true if there was a previous element in the container.
				If Prev() returns true, then previous element's key and value can be retrieved by Key() and Value().
				Modifies the state of the iterator.

			( T) Value() interface{}
				Value returns the current element's value.
				Does not modify the state of the iterator.

		Implements (at least one exported)
			 T : IteratorWithKey


Package-Level Functions (only one, which is exported)

	 func GetSortedValues(container Container, comparator utils.Comparator) []interface{}
		GetSortedValues returns sorted container's elements with respect to the passed comparator.
		Does not effect the ordering of elements within the container.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.