From 1aa1f955244b2d1f138c6a6e52106fadb182d899 Mon Sep 17 00:00:00 2001
From: dudaodong <lanliddd.2007@163.com>
Date: Sat, 4 Jun 2022 18:49:24 +0800
Subject: [PATCH] docs: add doc for queue

---
 docs/datastructure/queue.md | 364 ++++++++++++++++++++++++++++++++++++
 1 file changed, 364 insertions(+)
 create mode 100644 docs/datastructure/queue.md

diff --git a/docs/datastructure/queue.md b/docs/datastructure/queue.md
new file mode 100644
index 0000000..76ddea7
--- /dev/null
+++ b/docs/datastructure/queue.md
@@ -0,0 +1,364 @@
+# Queue
+A queue is a kind of linear table. It only allows delete operations at the front of the table and insert operations at the rear of the table. This package includes ArrayQueue, LinkedQueue, CircularQueue, and PriorityQueue.
+
+<div STYLE="page-break-after: always;"></div>
+
+## Source
+
+- [https://github.com/duke-git/lancet/blob/main/datastructure/queue/arrayqueue.go](https://github.com/duke-git/lancet/blob/main/datastructure/queue/arrayqueue.go)
+- [https://github.com/duke-git/lancet/blob/main/datastructure/queue/linkedqueue.go](https://github.com/duke-git/lancet/blob/main/datastructure/queue/linkedqueue.go)
+- [https://github.com/duke-git/lancet/blob/main/datastructure/queue/circularqueue.go](https://github.com/duke-git/lancet/blob/main/datastructure/queue/circularqueue.go)
+- [https://github.com/duke-git/lancet/blob/main/datastructure/queue/priorityqueue.go](https://github.com/duke-git/lancet/blob/main/datastructure/queue/priorityqueue.go)
+
+<div STYLE="page-break-after: always;"></div>
+
+## Usage
+```go
+import (
+    stack "github.com/duke-git/lancet/v2/datastructure/stack"
+)
+```
+
+<div STYLE="page-break-after: always;"></div>
+
+## Index
+
+### 1. ArrayQueue
+- [NewArrayQueue](#NewArrayQueue)
+- [Enqueue](#ArrayQueue_Enqueue)
+- [Dequeue](#ArrayQueue_Dequeue)
+- [Front](#ArrayQueue_Front)
+- [Back](#ArrayQueue_Back)
+- [Front](#ArrayQueue_Size)
+- [IsEmpty](#ArrayQueue_IsEmpty)
+- [Clear](#ArrayQueue_Clear)
+- [Contain](#ArrayQueue_Contain)
+
+
+
+### 2. LinkedStack
+
+
+
+<div STYLE="page-break-after: always;"></div>
+
+## Documentation
+
+### 1. ArrayQueue
+Common queue implemented by slice.
+
+### <span id="NewArrayQueue">NewArrayQueue</span>
+<p>Return a ArrayQueue pointer with specific capacity </p>
+
+<b>Signature:</b>
+
+```go
+func NewArrayQueue[T any](capacity int) *ArrayQueue[T]
+
+type ArrayQueue[T any] struct {
+	items    []T
+	head     int
+	tail     int
+	capacity int
+	size     int
+}
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    fmt.Println(q.Data()) // []
+}
+```
+
+
+
+### <span id="ArrayQueue_Data">Data</span>
+<p>Get all queue data</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Data() []T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    fmt.Println(q.Data()) // []
+}
+```
+
+
+
+
+### <span id="ArrayQueue_Enqueue">Enqueue</span>
+<p>Put element into queue, if queue is full, return false</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Enqueue(item T) bool
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Data()) // 1,2,3
+}
+```
+
+
+
+
+### <span id="ArrayQueue_Dequeue">Dequeue</span>
+<p>Remove head element of queue and return it</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Dequeue() (T, bool)
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Dequeue()) // 1
+    fmt.Println(q.Data()) // 2,3
+}
+```
+
+
+
+
+### <span id="ArrayQueue_Front">Front</span>
+<p>Just get head element of queue</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Front() T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Front()) // 1
+    fmt.Println(q.Data()) // 1,2,3
+}
+```
+
+
+
+
+### <span id="ArrayQueue_Back">Back</span>
+<p>Just get tail element of queue</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Back() T
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Back()) // 3
+    fmt.Println(q.Data()) // 1,2,3
+}
+```
+
+
+
+### <span id="ArrayQueue_Size">Size</span>
+<p>Get the number of elements in queue</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Size() int
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Size()) // 3
+}
+```
+
+
+
+### <span id="ArrayQueue_IsEmpty">IsEmpty</span>
+<p>Check if queue is empty or not</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) IsEmpty() bool
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    fmt.Println(q.IsEmpty()) // true
+
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.IsEmpty()) // false
+}
+```
+
+
+
+
+### <span id="ArrayQueue_Clear">Clear</span>
+<p>Clean all data in queue</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Clear()
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+    q.Clear()
+
+    fmt.Println(q.IsEmpty()) // true
+}
+```
+
+
+
+### <span id="ArrayQueue_Contain">Contain</span>
+<p>checks if the value is in queue or not</p>
+
+<b>Signature:</b>
+
+```go
+func (q *ArrayQueue[T]) Contain(value T) bool
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    queue "github.com/duke-git/lancet/v2/datastructure/queue"
+)
+
+func main() {
+    q := queue.NewArrayQueue[int](5)
+    q.Enqueue(1)
+    q.Enqueue(2)
+    q.Enqueue(3)
+
+    fmt.Println(q.Contain(1)) // true
+    fmt.Println(q.Contain(4)) // false
+}
+```
+
+
+
+
+
+