Merge pull request #3 from hayageek/new_apis

New APIs are added to Array,Slice,Map,Stack & Queue

Author: hayageek

README.md

@@ -24,6 +24,12 @@ A thread-safe array with a fixed size.
 - `NewArray(size int) *Array[T]` - Creates a new thread-safe array with the given size.
 - `(*Array[T]) Get(index int) (T, bool)` - Retrieves the value at the given index.
 - `(*Array[T]) Set(index int, value T) bool` - Sets the value at the given index.
+- `(*Array[T]) Append(value T)` - Appends a value to the array.
+- `(*Array[T]) Remove(index int) bool` - Removes the element at the given index.
+- `(*Array[T]) Contains(value T) bool` - Checks if the array contains the specified value.
+- `(*Array[T]) Clear()` - Clears all elements from the array.
+- `(*Array[T]) Insert(index int, value T) bool` - Inserts a value at the specified index.
+- `(*Array[T]) Copy() *Array[T]` - Returns a copy of the array.
 - `(*Array[T]) Length() int` - Returns the length of the array.
 
 #### Example
@@ -63,6 +69,12 @@ A dynamically-sized, thread-safe slice.
 - `(*Slice[T]) Append(value T)` - Appends a value to the slice.
 - `(*Slice[T]) Get(index int) (T, bool)` - Retrieves the value at the given index.
 - `(*Slice[T]) Set(index int, value T) bool` - Sets the value at the given index.
+- `(*Slice[T]) Remove(index int) bool` - Removes the element at the given index.
+- `(*Slice[T]) Contains(value T) bool` - Checks if the slice contains the specified value.
+- `(*Slice[T]) Clear()` - Clears all elements from the slice.
+- `(*Slice[T]) Insert(index int, value T) bool` - Inserts a value at the specified index.
+- `(*Slice[T]) Copy() *Slice[T]` - Returns a copy of the slice.
+- `(*Slice[T]) Values() []T` - Returns a slice of all values present in the slice.
 - `(*Slice[T]) Length() int` - Returns the length of the slice.
 
 #### Example
@@ -113,6 +125,9 @@ A thread-safe map for storing key-value pairs.
 - `(*Map[K, V]) Get(key K) (V, bool)` - Retrieves the value associated with the key.
 - `(*Map[K, V]) Set(key K, value V)` - Sets the value for the given key.
 - `(*Map[K, V]) Delete(key K)` - Deletes the value associated with the key.
+- `(*Map[K, V]) Contains(key K) bool` - Checks if the map contains the specified key.
+- `(*Map[K, V]) Clear()` - Clears all key-value pairs from the map.
+- `(*Map[K, V]) Copy() *Map[K, V]` - Returns a copy of the map.
 - `(*Map[K, V]) Length() int` - Returns the number of key-value pairs in the map.
 - `(*Map[K, V]) Keys() []K` - Returns a slice of all keys present in the map.
 - `(*Map[K, V]) Values() []V` - Returns a slice of all values present in the map.
@@ -171,14 +186,18 @@ func main() {
 
 A thread-safe stack for safely adding and removing items.
 
-### Methods
+#### APIs
 
-- `NewStack() *Stack`: Creates a new thread-safe stack.
-- `Push(value interface{})`: Adds an element to the stack.
-- `Pop() (interface{}, bool)`: Removes and returns an element from the stack. Returns `false` if the stack is empty.
-- `Len() int`: Returns the number of elements in the stack.
+- `NewStack() *Stack` - Creates a new thread-safe stack.
+- `(*Stack) Push(value interface{})` - Adds an element to the stack.
+- `(*Stack) Pop() (interface{}, bool)` - Removes and returns an element from the stack. Returns `false` if the stack is empty.
+- `(*Stack) Peek() (interface{}, bool)` - Returns the element at the top of the stack without removing it.
+- `(*Stack) IsEmpty() bool` - Checks if the stack is empty.
+- `(*Stack) Clear()` - Clears all elements from the stack.
+- `(*Stack) Values() []interface{}` - Returns a slice of all elements in the stack.
+- `(*Stack) Len() int` - Returns the number of elements in the stack.
 
-### Example
+#### Example
 
 ```go
 package main
@@ -213,12 +232,16 @@ func main() {
 
 A thread-safe queue for safely adding and removing items.
 
-#### Methods
+#### APIs
 
-- `NewQueue() *Queue`: Creates a new thread-safe queue.
-- `Enqueue(value interface{})`: Adds an element to the queue.
-- `Dequeue() (interface{}, bool)`: Removes and returns an element from the queue. Returns `false` if the queue is empty.
-- `Len() int`: Returns the number of elements in the queue.
+- `NewQueue() *Queue` - Creates a new thread-safe queue.
+- `(*Queue) Enqueue(value interface{})` - Adds an element to the queue.
+- `(*Queue) Dequeue() (interface{}, bool)` - Removes and returns an element from the queue. Returns `false` if the queue is empty.
+- `(*Queue) Peek() (interface{}, bool)` - Returns the element at the front of the queue without removing it.
+- `(*Queue) IsEmpty() bool` - Checks if the queue is empty.
+- `(*Queue) Clear()` - Clears all elements from the queue.
+- `(*Queue) Values() []interface{}` - Returns a slice of all elements in the queue.
+- `(*Queue) Len() int` - Returns the number of elements in the queue.
 
 #### Queue Example
 

array.go

@@ -1,6 +1,7 @@
 package threadsafe
 
 import (
+	"reflect"
 	"sync"
 )
 
@@ -13,15 +14,17 @@ type Array[T any] struct {
 
 // NewArray creates a new thread-safe array with a given size.
 // Example:
-// 	arr := threadsafe.NewArray 
+//
+//	arr := threadsafe.NewArray
 func NewArray[T any](size int) *Array[T] {
 	return &Array[T]{data: make([]T, size)}
 }
 
 // Get retrieves the value at the given index.
 // It returns the value and a boolean indicating whether the index was valid.
 // Example:
-// 	value, ok := arr.Get(2)
+//
+//	value, ok := arr.Get(2)
 func (a *Array[T]) Get(index int) (T, bool) {
 	a.mu.RLock()
 	defer a.mu.RUnlock()
@@ -35,7 +38,8 @@ func (a *Array[T]) Get(index int) (T, bool) {
 // Set sets the value at the given index.
 // It returns a boolean indicating whether the operation was successful.
 // Example:
-// 	ok := arr.Set(2, 100)
+//
+//	ok := arr.Set(2, 100)
 func (a *Array[T]) Set(index int, value T) bool {
 	a.mu.Lock()
 	defer a.mu.Unlock()
@@ -48,9 +52,87 @@ func (a *Array[T]) Set(index int, value T) bool {
 
 // Length returns the length of the array.
 // Example:
-// 	length := arr.Length()
+//
+//	length := arr.Length()
 func (a *Array[T]) Length() int {
 	a.mu.RLock()
 	defer a.mu.RUnlock()
 	return len(a.data)
 }
+
+// Append appends a value to the array.
+// Example:
+//
+//	arr.Append(10)
+func (a *Array[T]) Append(value T) {
+	a.mu.Lock()
+	defer a.mu.Unlock()
+	a.data = append(a.data, value)
+}
+
+// Remove removes the element at the given index.
+// It returns a boolean indicating whether the operation was successful.
+// Example:
+//
+//	ok := arr.Remove(2)
+func (a *Array[T]) Remove(index int) bool {
+	a.mu.Lock()
+	defer a.mu.Unlock()
+	if index < 0 || index >= len(a.data) {
+		return false
+	}
+	a.data = append(a.data[:index], a.data[index+1:]...)
+	return true
+}
+
+// Contains checks if the array contains the specified value.
+// Example:
+//
+//	contains := arr.Contains(10)
+func (a *Array[T]) Contains(value T) bool {
+	a.mu.RLock()
+	defer a.mu.RUnlock()
+	for _, v := range a.data {
+		if reflect.DeepEqual(v, value) {
+			return true
+		}
+	}
+	return false
+}
+
+// Clear removes all elements from the array.
+// Example:
+//
+//	arr.Clear()
+func (a *Array[T]) Clear() {
+	a.mu.Lock()
+	defer a.mu.Unlock()
+	a.data = []T{}
+}
+
+// Insert inserts a value at the specified index.
+// It returns a boolean indicating whether the operation was successful.
+// Example:
+//
+//	ok := arr.Insert(2, 10)
+func (a *Array[T]) Insert(index int, value T) bool {
+	a.mu.Lock()
+	defer a.mu.Unlock()
+	if index < 0 || index > len(a.data) {
+		return false
+	}
+	a.data = append(a.data[:index], append([]T{value}, a.data[index:]...)...)
+	return true
+}
+
+// Copy returns a new thread-safe array that is a copy of the current array.
+// Example:
+//
+//	copyArray := arr.Copy()
+func (a *Array[T]) Copy() *Array[T] {
+	a.mu.RLock()
+	defer a.mu.RUnlock()
+	dataCopy := make([]T, len(a.data))
+	copy(dataCopy, a.data)
+	return &Array[T]{data: dataCopy}
+}

array_test.go

@@ -2,35 +2,112 @@ package threadsafe
 
 import (
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
-func TestArray(t *testing.T) {
-	// Create a new thread-safe array with size 5
+func TestNewArray(t *testing.T) {
 	arr := NewArray[int](5)
+	assert.Equal(t, 5, arr.Length())
+}
 
-	// Test setting values
-	for i := 0; i < arr.Length(); i++ {
-		if !arr.Set(i, i*10) {
-			t.Errorf("Failed to set value at index %d", i)
-		}
-	}
+func TestArrayGetSet(t *testing.T) {
+	arr := NewArray[int](3)
+	ok := arr.Set(2, 42)
+	assert.True(t, ok)
+	value, ok := arr.Get(2)
+	assert.True(t, ok)
+	assert.Equal(t, 42, value)
+}
 
-	// Test getting values
-	for i := 0; i < arr.Length(); i++ {
-		value, ok := arr.Get(i)
-		if !ok || value != i*10 {
-			t.Errorf("Expected %d, got %d at index %d", i*10, value, i)
-		}
-	}
+func TestArrayGetInvalidIndex(t *testing.T) {
+	arr := NewArray[int](1)
+	value, ok := arr.Get(10)
+	assert.False(t, ok)
+	assert.Equal(t, 0, value)
+}
 
-	// Test getting value out of range
-	_, ok := arr.Get(10)
-	if ok {
-		t.Error("Expected false for out-of-range index, got true")
-	}
+func TestArraySetInvalidIndex(t *testing.T) {
+	arr := NewArray[int](1)
+	ok := arr.Set(10, 42)
+	assert.False(t, ok)
+}
 
-	// Test setting value out of range
-	if arr.Set(10, 100) {
-		t.Error("Expected false for out-of-range index, got true")
+func TestArrayAppend(t *testing.T) {
+	arr := NewArray[int](0)
+	arr.Append(42)
+	assert.Equal(t, 1, arr.Length())
+	value, ok := arr.Get(0)
+	assert.True(t, ok)
+	assert.Equal(t, 42, value)
+}
+
+func TestArrayRemove(t *testing.T) {
+	arr := NewArray[int](3)
+	arr.Set(0, 1)
+	arr.Set(1, 2)
+	arr.Set(2, 3)
+	ok := arr.Remove(1)
+	assert.True(t, ok)
+	assert.Equal(t, 2, arr.Length())
+	value, ok := arr.Get(1)
+	assert.True(t, ok)
+	assert.Equal(t, 3, value)
+}
+
+func TestArrayRemoveInvalidIndex(t *testing.T) {
+	arr := NewArray[int](1)
+	ok := arr.Remove(10)
+	assert.False(t, ok)
+}
+
+func TestArrayContains(t *testing.T) {
+	arr := NewArray[int](3)
+	arr.Set(0, 1)
+	arr.Set(1, 2)
+	arr.Set(2, 3)
+	assert.True(t, arr.Contains(2))
+	assert.False(t, arr.Contains(42))
+}
+
+func TestArrayClear(t *testing.T) {
+	arr := NewArray[int](3)
+	arr.Set(0, 1)
+	arr.Set(1, 2)
+	arr.Set(2, 3)
+	arr.Clear()
+	assert.Equal(t, 0, arr.Length())
+}
+
+func TestArrayInsert(t *testing.T) {
+	arr := NewArray[int](3)
+	arr.Set(0, 1)
+	arr.Set(1, 2)
+	arr.Set(2, 3)
+	ok := arr.Insert(1, 42)
+	assert.True(t, ok)
+	assert.Equal(t, 4, arr.Length())
+	value, ok := arr.Get(1)
+	assert.True(t, ok)
+	assert.Equal(t, 42, value)
+}
+
+func TestArrayInsertInvalidIndex(t *testing.T) {
+	arr := NewArray[int](1)
+	ok := arr.Insert(10, 42)
+	assert.False(t, ok)
+}
+
+func TestArrayCopy(t *testing.T) {
+	arr := NewArray[int](3)
+	arr.Set(0, 1)
+	arr.Set(1, 2)
+	arr.Set(2, 3)
+	copyArr := arr.Copy()
+	assert.Equal(t, arr.Length(), copyArr.Length())
+	for i := 0; i < arr.Length(); i++ {
+		origValue, _ := arr.Get(i)
+		copyValue, _ := copyArr.Get(i)
+		assert.Equal(t, origValue, copyValue)
 	}
 }

go.mod

@@ -2,4 +2,11 @@ module github.com/hayageek/threadsafe
 
 go 1.18
 
-require github.com/golang-collections/collections v0.0.0-20130729185459-604e922904d3 // indirect
+require github.com/stretchr/testify v1.9.0
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/golang-collections/collections v0.0.0-20130729185459-604e922904d3 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -1,2 +1,11 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang-collections/collections v0.0.0-20130729185459-604e922904d3 h1:zN2lZNZRflqFyxVaTIU61KNKQ9C0055u9CAfpmqUvo4=
 github.com/golang-collections/collections v0.0.0-20130729185459-604e922904d3/go.mod h1:nPpo7qLxd6XL3hWJG/O60sR8ZKfMCiIoNap5GvD12KU=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=