mirror of
https://github.com/emirpasic/gods
synced 2024-11-06 15:20:25 +00:00
337 lines
9.9 KiB
Go
337 lines
9.9 KiB
Go
/*
|
|
Copyright (c) 2015, Emir Pasic
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation
|
|
and/or other materials provided with the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
// Package arraylist implements the array list.
|
|
//
|
|
// Structure is not thread safe.
|
|
//
|
|
// Reference: https://en.wikipedia.org/wiki/List_%28abstract_data_type%29
|
|
package arraylist
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/emirpasic/gods/containers"
|
|
"github.com/emirpasic/gods/lists"
|
|
"github.com/emirpasic/gods/utils"
|
|
"strings"
|
|
)
|
|
|
|
func assertInterfaceImplementation() {
|
|
var _ lists.List = (*List)(nil)
|
|
var _ containers.EnumerableWithIndex = (*List)(nil)
|
|
var _ containers.ReverseIteratorWithIndex = (*Iterator)(nil)
|
|
}
|
|
|
|
// List holds the elements in a slice
|
|
type List struct {
|
|
elements []interface{}
|
|
size int
|
|
}
|
|
|
|
const (
|
|
growthFactor = float32(2.0) // growth by 100%
|
|
shrinkFactor = float32(0.25) // shrink when size is 25% of capacity (0 means never shrink)
|
|
)
|
|
|
|
// New instantiates a new empty list
|
|
func New() *List {
|
|
return &List{}
|
|
}
|
|
|
|
// Add appends a value at the end of the list
|
|
func (list *List) Add(values ...interface{}) {
|
|
list.growBy(len(values))
|
|
for _, value := range values {
|
|
list.elements[list.size] = value
|
|
list.size++
|
|
}
|
|
}
|
|
|
|
// Get returns the element at index.
|
|
// Second return parameter is true if index is within bounds of the array and array is not empty, otherwise false.
|
|
func (list *List) Get(index int) (interface{}, bool) {
|
|
|
|
if !list.withinRange(index) {
|
|
return nil, false
|
|
}
|
|
|
|
return list.elements[index], true
|
|
}
|
|
|
|
// Remove removes one or more elements from the list with the supplied indices.
|
|
func (list *List) Remove(index int) {
|
|
|
|
if !list.withinRange(index) {
|
|
return
|
|
}
|
|
|
|
list.elements[index] = nil // cleanup reference
|
|
copy(list.elements[index:], list.elements[index+1:list.size]) // shift to the left by one (slow operation, need ways to optimize this)
|
|
list.size--
|
|
|
|
list.shrink()
|
|
}
|
|
|
|
// Contains checks if elements (one or more) are present in the set.
|
|
// All elements have to be present in the set for the method to return true.
|
|
// Performance time complexity of n^2.
|
|
// Returns true if no arguments are passed at all, i.e. set is always super-set of empty set.
|
|
func (list *List) Contains(values ...interface{}) bool {
|
|
|
|
for _, searchValue := range values {
|
|
found := false
|
|
for _, element := range list.elements {
|
|
if element == searchValue {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
if !found {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// Values returns all elements in the list.
|
|
func (list *List) Values() []interface{} {
|
|
newElements := make([]interface{}, list.size, list.size)
|
|
copy(newElements, list.elements[:list.size])
|
|
return newElements
|
|
}
|
|
|
|
// Empty returns true if list does not contain any elements.
|
|
func (list *List) Empty() bool {
|
|
return list.size == 0
|
|
}
|
|
|
|
// Size returns number of elements within the list.
|
|
func (list *List) Size() int {
|
|
return list.size
|
|
}
|
|
|
|
// Clear removes all elements from the list.
|
|
func (list *List) Clear() {
|
|
list.size = 0
|
|
list.elements = []interface{}{}
|
|
}
|
|
|
|
// Sort sorts values (in-place) using.
|
|
func (list *List) Sort(comparator utils.Comparator) {
|
|
if len(list.elements) < 2 {
|
|
return
|
|
}
|
|
utils.Sort(list.elements[:list.size], comparator)
|
|
}
|
|
|
|
// Swap swaps the two values at the specified positions.
|
|
func (list *List) Swap(i, j int) {
|
|
if list.withinRange(i) && list.withinRange(j) {
|
|
list.elements[i], list.elements[j] = list.elements[j], list.elements[i]
|
|
}
|
|
}
|
|
|
|
// Insert inserts values at specified index position shifting the value at that position (if any) and any subsequent elements to the right.
|
|
// Does not do anything if position is negative or bigger than list's size
|
|
// Note: position equal to list's size is valid, i.e. append.
|
|
func (list *List) Insert(index int, values ...interface{}) {
|
|
|
|
if !list.withinRange(index) {
|
|
// Append
|
|
if index == list.size {
|
|
list.Add(values...)
|
|
}
|
|
return
|
|
}
|
|
|
|
l := len(values)
|
|
list.growBy(l)
|
|
list.size += l
|
|
// Shift old to right
|
|
for i := list.size - 1; i >= index+l; i-- {
|
|
list.elements[i] = list.elements[i-l]
|
|
}
|
|
// Insert new
|
|
for i, value := range values {
|
|
list.elements[index+i] = value
|
|
}
|
|
}
|
|
|
|
// Iterator holding the iterator's state
|
|
type Iterator struct {
|
|
list *List
|
|
index int
|
|
}
|
|
|
|
// Iterator returns a stateful iterator whose values can be fetched by an index.
|
|
func (list *List) Iterator() Iterator {
|
|
return Iterator{list: list, index: -1}
|
|
}
|
|
|
|
// 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().
|
|
// Modifies the state of the iterator.
|
|
func (iterator *Iterator) Next() bool {
|
|
if iterator.index < iterator.list.size {
|
|
iterator.index++
|
|
}
|
|
return iterator.list.withinRange(iterator.index)
|
|
}
|
|
|
|
// 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 *Iterator) Prev() bool {
|
|
if iterator.index >= 0 {
|
|
iterator.index--
|
|
}
|
|
return iterator.list.withinRange(iterator.index)
|
|
}
|
|
|
|
// Value returns the current element's value.
|
|
// Does not modify the state of the iterator.
|
|
func (iterator *Iterator) Value() interface{} {
|
|
return iterator.list.elements[iterator.index]
|
|
}
|
|
|
|
// Index returns the current element's index.
|
|
// Does not modify the state of the iterator.
|
|
func (iterator *Iterator) Index() int {
|
|
return iterator.index
|
|
}
|
|
|
|
// Each calls the given function once for each element, passing that element's index and value.
|
|
func (list *List) Each(f func(index int, value interface{})) {
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
f(iterator.Index(), iterator.Value())
|
|
}
|
|
}
|
|
|
|
// Map invokes the given function once for each element and returns a
|
|
// container containing the values returned by the given function.
|
|
func (list *List) Map(f func(index int, value interface{}) interface{}) *List {
|
|
newList := &List{}
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
newList.Add(f(iterator.Index(), iterator.Value()))
|
|
}
|
|
return newList
|
|
}
|
|
|
|
// Select returns a new container containing all elements for which the given function returns a true value.
|
|
func (list *List) Select(f func(index int, value interface{}) bool) *List {
|
|
newList := &List{}
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
if f(iterator.Index(), iterator.Value()) {
|
|
newList.Add(iterator.Value())
|
|
}
|
|
}
|
|
return newList
|
|
}
|
|
|
|
// Any passes each element of the collection to the given function and
|
|
// returns true if the function ever returns true for any element.
|
|
func (list *List) Any(f func(index int, value interface{}) bool) bool {
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
if f(iterator.Index(), iterator.Value()) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// All passes each element of the collection to the given function and
|
|
// returns true if the function returns true for all elements.
|
|
func (list *List) All(f func(index int, value interface{}) bool) bool {
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
if !f(iterator.Index(), iterator.Value()) {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// 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.
|
|
func (list *List) Find(f func(index int, value interface{}) bool) (int, interface{}) {
|
|
iterator := list.Iterator()
|
|
for iterator.Next() {
|
|
if f(iterator.Index(), iterator.Value()) {
|
|
return iterator.Index(), iterator.Value()
|
|
}
|
|
}
|
|
return -1, nil
|
|
}
|
|
|
|
// String returns a string representation of container
|
|
func (list *List) String() string {
|
|
str := "ArrayList\n"
|
|
values := []string{}
|
|
for _, value := range list.elements[:list.size] {
|
|
values = append(values, fmt.Sprintf("%v", value))
|
|
}
|
|
str += strings.Join(values, ", ")
|
|
return str
|
|
}
|
|
|
|
// Check that the index is within bounds of the list
|
|
func (list *List) withinRange(index int) bool {
|
|
return index >= 0 && index < list.size
|
|
}
|
|
|
|
func (list *List) resize(cap int) {
|
|
newElements := make([]interface{}, cap, cap)
|
|
copy(newElements, list.elements)
|
|
list.elements = newElements
|
|
}
|
|
|
|
// Expand the array if necessary, i.e. capacity will be reached if we add n elements
|
|
func (list *List) growBy(n int) {
|
|
// When capacity is reached, grow by a factor of growthFactor and add number of elements
|
|
currentCapacity := cap(list.elements)
|
|
if list.size+n >= currentCapacity {
|
|
newCapacity := int(growthFactor * float32(currentCapacity+n))
|
|
list.resize(newCapacity)
|
|
}
|
|
}
|
|
|
|
// Shrink the array if necessary, i.e. when size is shrinkFactor percent of current capacity
|
|
func (list *List) shrink() {
|
|
if shrinkFactor == 0.0 {
|
|
return
|
|
}
|
|
// Shrink when size is at shrinkFactor * capacity
|
|
currentCapacity := cap(list.elements)
|
|
if list.size <= int(float32(currentCapacity)*shrinkFactor) {
|
|
list.resize(list.size)
|
|
}
|
|
}
|