mirror of https://github.com/emirpasic/gods
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
2.5 KiB
Go
92 lines
2.5 KiB
Go
// Copyright (c) 2015, Emir Pasic. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// 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
|
|
package arraystack
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/emirpasic/gods/v2/lists/arraylist"
|
|
"github.com/emirpasic/gods/v2/stacks"
|
|
)
|
|
|
|
// Assert Stack implementation
|
|
var _ stacks.Stack[int] = (*Stack[int])(nil)
|
|
|
|
// Stack holds elements in an array-list
|
|
type Stack[T comparable] struct {
|
|
list *arraylist.List[T]
|
|
}
|
|
|
|
// New instantiates a new empty stack
|
|
func New[T comparable]() *Stack[T] {
|
|
return &Stack[T]{list: arraylist.New[T]()}
|
|
}
|
|
|
|
// Push adds a value onto the top of the stack
|
|
func (stack *Stack[T]) Push(value T) {
|
|
stack.list.Add(value)
|
|
}
|
|
|
|
// 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 *Stack[T]) Pop() (value T, ok bool) {
|
|
value, ok = stack.list.Get(stack.list.Size() - 1)
|
|
stack.list.Remove(stack.list.Size() - 1)
|
|
return
|
|
}
|
|
|
|
// 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 *Stack[T]) Peek() (value T, ok bool) {
|
|
return stack.list.Get(stack.list.Size() - 1)
|
|
}
|
|
|
|
// Empty returns true if stack does not contain any elements.
|
|
func (stack *Stack[T]) Empty() bool {
|
|
return stack.list.Empty()
|
|
}
|
|
|
|
// Size returns number of elements within the stack.
|
|
func (stack *Stack[T]) Size() int {
|
|
return stack.list.Size()
|
|
}
|
|
|
|
// Clear removes all elements from the stack.
|
|
func (stack *Stack[T]) Clear() {
|
|
stack.list.Clear()
|
|
}
|
|
|
|
// Values returns all elements in the stack (LIFO order).
|
|
func (stack *Stack[T]) Values() []T {
|
|
size := stack.list.Size()
|
|
elements := make([]T, size, size)
|
|
for i := 1; i <= size; i++ {
|
|
elements[size-i], _ = stack.list.Get(i - 1) // in reverse (LIFO)
|
|
}
|
|
return elements
|
|
}
|
|
|
|
// String returns a string representation of container
|
|
func (stack *Stack[T]) String() string {
|
|
str := "ArrayStack\n"
|
|
values := []string{}
|
|
for _, value := range stack.list.Values() {
|
|
values = append(values, fmt.Sprintf("%v", value))
|
|
}
|
|
str += strings.Join(values, ", ")
|
|
return str
|
|
}
|
|
|
|
// Check that the index is within bounds of the list
|
|
func (stack *Stack[T]) withinRange(index int) bool {
|
|
return index >= 0 && index < stack.list.Size()
|
|
}
|