feat: more examples

Author: joetifa2003

allocator/example_test.go

@@ -6,9 +6,12 @@ import (
 
 	"github.com/joetifa2003/mm-go"
 	"github.com/joetifa2003/mm-go/allocator"
+	"github.com/joetifa2003/mm-go/linkedlist"
+	"github.com/joetifa2003/mm-go/mmstring"
+	"github.com/joetifa2003/mm-go/vector"
 )
 
-func ExampleNewC() {
+func Example() {
 	alloc := allocator.NewC()
 	defer alloc.Destroy()
 
@@ -21,6 +24,49 @@ func ExampleNewC() {
 	// Output: 15
 }
 
+type MyStruct struct {
+	a int
+	b float32
+}
+
+func Example_datastructures() {
+	alloc := allocator.NewC()
+	defer alloc.Destroy() // all the memory allocated bellow will be freed, no need to free it manually.
+
+	p := allocator.Alloc[MyStruct](alloc)
+	defer allocator.Free(alloc, p)
+
+	p.a = 100
+	p.b = 200
+
+	fmt.Println(*p)
+
+	v := vector.New[int](alloc)
+	defer v.Free()
+	v.Push(15)
+	v.Push(70)
+
+	for _, i := range v.Iter() {
+		fmt.Println(i)
+	}
+
+	l := linkedlist.New[*mmstring.MMString](alloc)
+	defer l.Free()
+	l.PushBack(mmstring.From(alloc, "hello"))
+	l.PushBack(mmstring.From(alloc, "world"))
+
+	for _, i := range l.Iter() {
+		fmt.Println(i.GetGoString())
+	}
+
+	// Output:
+	// {100 200}
+	// 15
+	// 70
+	// hello
+	// world
+}
+
 func ExampleAlloc() {
 	alloc := allocator.NewC()
 	defer alloc.Destroy()
@@ -99,7 +145,7 @@ func ExampleNewAllocator() {
 	)
 
 	// Check how C allocator is implemented
-	// or batchallocator soruce for a reference
+	// or batchallocator source for a reference
 
 	_ = alloc
 }

batchallocator/example_test.go

@@ -1,9 +1,14 @@
 package batchallocator_test
 
 import (
+	"fmt"
+
 	"github.com/joetifa2003/mm-go"
 	"github.com/joetifa2003/mm-go/allocator"
 	"github.com/joetifa2003/mm-go/batchallocator"
+	"github.com/joetifa2003/mm-go/linkedlist"
+	"github.com/joetifa2003/mm-go/mmstring"
+	"github.com/joetifa2003/mm-go/vector"
 )
 
 func Example() {
@@ -15,6 +20,33 @@ func Example() {
 	defer allocator.Free(alloc, ptr) // this can removed and the memory will be freed.
 }
 
+func Example_arena() {
+	alloc := batchallocator.New(allocator.NewC())
+	defer alloc.Destroy() // all the memory allocated bellow will be freed, no need to free it manually.
+
+	v := vector.New[int](alloc)
+	v.Push(15)
+	v.Push(70)
+
+	for _, i := range v.Iter() {
+		fmt.Println(i)
+	}
+
+	l := linkedlist.New[*mmstring.MMString](alloc)
+	l.PushBack(mmstring.From(alloc, "hello"))
+	l.PushBack(mmstring.From(alloc, "world"))
+
+	for _, i := range l.Iter() {
+		fmt.Println(i.GetGoString())
+	}
+
+	// Output:
+	// 15
+	// 70
+	// hello
+	// world
+}
+
 func ExampleWithBucketSize() {
 	alloc := batchallocator.New(
 		allocator.NewC(),

mm.go

@@ -7,3 +7,9 @@ func SizeOf[T any]() int {
 	var zeroV T
 	return int(unsafe.Sizeof(zeroV))
 }
+
+// Zero returns a zero value of T
+func Zero[T any]() T {
+	var zeroV T
+	return zeroV
+}

mmstring/example_test.go

@@ -0,0 +1,48 @@
+package mmstring_test
+
+import (
+	"fmt"
+
+	"github.com/joetifa2003/mm-go/allocator"
+	"github.com/joetifa2003/mm-go/batchallocator"
+	"github.com/joetifa2003/mm-go/hashmap"
+	"github.com/joetifa2003/mm-go/mmstring"
+)
+
+func Example() {
+	alloc := allocator.NewC()
+	defer alloc.Destroy()
+
+	s := mmstring.New(alloc)
+	defer s.Free()
+
+	s.AppendGoString("Hello ")
+	s.AppendGoString("World")
+
+	s2 := mmstring.From(alloc, "Foo Bar")
+	defer s2.Free()
+
+	fmt.Println(s.GetGoString())
+	fmt.Println(s2.GetGoString())
+
+	// Output:
+	// Hello World
+	// Foo Bar
+}
+
+func Example_complex() {
+	alloc := batchallocator.New(allocator.NewC())
+	defer alloc.Destroy() // all the memory allocated bellow will be freed, no need to free it manually.
+
+	m := hashmap.New[*mmstring.MMString, *mmstring.MMString](alloc)
+	m.Insert(mmstring.From(alloc, "hello"), mmstring.From(alloc, "world"))
+	m.Insert(mmstring.From(alloc, "foo"), mmstring.From(alloc, "bar"))
+
+	for k, v := range m.Iter() {
+		fmt.Println(k.GetGoString(), v.GetGoString())
+	}
+
+	// Output:
+	// hello world
+	// foo bar
+}

vector/example_test.go

@@ -0,0 +1,34 @@
+package vector_test
+
+import (
+	"fmt"
+
+	"github.com/joetifa2003/mm-go/allocator"
+	"github.com/joetifa2003/mm-go/vector"
+)
+
+func Example() {
+	alloc := allocator.NewC()
+	v := vector.New[int](alloc)
+	v.Push(1)
+	v.Push(2)
+	v.Push(3)
+
+	fmt.Println("Length:", v.Len())
+	for i := 0; i < v.Len(); i++ {
+		fmt.Println(v.At(i))
+	}
+
+	for _, k := range v.Iter() {
+		fmt.Println(k)
+	}
+
+	// Output:
+	// Length: 3
+	// 1
+	// 2
+	// 3
+	// 1
+	// 2
+	// 3
+}