Documentation
¶
Overview ¶
Package arraystack implements a stack backed by array list.
Structure is not thread safe.
Reference: https://en.wikipedia.org/wiki/Stack_%28abstract_data_type%29#Array
Index ¶
- type Iterator
- func (iterator *Iterator[T]) Begin()
- func (iterator *Iterator[T]) End()
- func (iterator *Iterator[T]) First() bool
- func (iterator *Iterator[T]) Index() int
- func (iterator *Iterator[T]) Last() bool
- func (iterator *Iterator[T]) Next() bool
- func (iterator *Iterator[T]) NextTo(f func(index int, value T) bool) bool
- func (iterator *Iterator[T]) Prev() bool
- func (iterator *Iterator[T]) PrevTo(f func(index int, value T) bool) bool
- func (iterator *Iterator[T]) Value() T
- type Stack
- func (stack *Stack[T]) Clear()
- func (stack *Stack[T]) Empty() bool
- func (stack *Stack[T]) FromJSON(data []byte) error
- func (stack *Stack[T]) Iterator() Iterator[T]
- func (stack *Stack[T]) MarshalJSON() ([]byte, error)
- func (stack *Stack[T]) Peek() (value T, ok bool)
- func (stack *Stack[T]) Pop() (value T, ok bool)
- func (stack *Stack[T]) Push(value T)
- func (stack *Stack[T]) Size() int
- func (stack *Stack[T]) String() string
- func (stack *Stack[T]) ToJSON() ([]byte, error)
- func (stack *Stack[T]) UnmarshalJSON(bytes []byte) error
- func (stack *Stack[T]) Values() []T
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Iterator ¶
type Iterator[T constraints.Ordered] struct { // contains filtered or unexported fields }
Iterator returns a stateful iterator whose values can be fetched by an index.
func (*Iterator[T]) Begin ¶
func (iterator *Iterator[T]) Begin()
Begin resets the iterator to its initial state (one-before-first) Call Next() to fetch the first element if any.
func (*Iterator[T]) End ¶
func (iterator *Iterator[T]) End()
End moves the iterator past the last element (one-past-the-end). Call Prev() to fetch the last element if any.
func (*Iterator[T]) First ¶
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.
func (*Iterator[T]) Index ¶
Index returns the current element's index. Does not modify the state of the iterator.
func (*Iterator[T]) Last ¶
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.
func (*Iterator[T]) Next ¶
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.
func (*Iterator[T]) NextTo ¶
NextTo moves the iterator to the next element from current position that satisfies the condition given by the passed function, and returns true if there was a next element in the container. If NextTo() returns true, then next element's index and value can be retrieved by Index() and Value(). Modifies the state of the iterator.
func (*Iterator[T]) Prev ¶
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.
func (*Iterator[T]) PrevTo ¶
PrevTo moves the iterator to the previous element from current position that satisfies the condition given by the passed function, and returns true if there was a next element in the container. If PrevTo() returns true, then next element's index and value can be retrieved by Index() and Value(). Modifies the state of the iterator.
type Stack ¶
type Stack[T constraints.Ordered] struct { // contains filtered or unexported fields }
Stack holds elements in an array-list
func (*Stack[T]) Iterator ¶
Iterator returns a stateful iterator whose values can be fetched by an index.
func (*Stack[T]) MarshalJSON ¶
MarshalJSON @implements json.Marshaler
func (*Stack[T]) Peek ¶
Peek returns top element on the stack without removing it, or nil if stack is empty. Second return parameter is true, unless the stack was empty and there was nothing to peek.
func (*Stack[T]) Pop ¶
Pop removes top element on stack and returns it, or nil if stack is empty. Second return parameter is true, unless the stack was empty and there was nothing to pop.
func (*Stack[T]) Push ¶
func (stack *Stack[T]) Push(value T)
Push adds a value onto the top of the stack
func (*Stack[T]) UnmarshalJSON ¶
UnmarshalJSON @implements json.Unmarshaler
Source Files