Lancet-docs

# Linklist

Linklist a linked list, whose node has a value and a pointer points to next node of the link.

# Source

# Usage

import (
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

# Index

# 1. SinglyLink

# 2. DoublyLink

# Documentation

# 1. SinglyLink

SinglyLink a linked list, whose node has a value and a pointer points to next node of the link.

Return a singly link(SinglyLink) instance

Signature:

type LinkNode[T any] struct {
	Value T
	Next  *LinkNode[T]
}
type SinglyLink[T any] struct {
	Head   *datastructure.LinkNode[T]
	length int
}
func NewSinglyLink[T any]() *SinglyLink[T]

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()
    fmt.Println(lk)
}

# Values

Return a slice of all node value in singly linklist

Signature:

func (link *SinglyLink[T]) Values() []T

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# InsertAt

Insert value into singly linklist at index, index shoud be great or equal 0 and less or equal number of link nodes

Signature:

func (link *SinglyLink[T]) InsertAt(index int, value T) error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAt(0, 1)
    lk.InsertAt(1, 2)
    lk.InsertAt(2, 3)
    lk.InsertAt(2, 4)

    fmt.Println(lk.Values()) //[]int{1, 2, 4, 3}
}

# InsertAtHead

Insert value into singly linklist at head(first) index

Signature:

func (link *SinglyLink[T]) InsertAtHead(value T)

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtHead(1)
    lk.InsertAtHead(2)
    lk.InsertAtHead(3)

    fmt.Println(lk.Values()) //[]int{3, 2, 1}
}

# InsertAtTail

Insert value into singly linklist at tail(last) index

Signature:

func (link *SinglyLink[T]) InsertAtTail(value T)

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# DeleteAt

Delete value at specific index, index shoud be great or equal 0 and less or less than number of link nodes - 1

Signature:

func (link *SinglyLink[T]) DeleteAt(index int) error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    lk.InsertAtTail(4)

    err := lk.DeleteAt(3)

    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# DeleteAtHead

Delete value in singly linklist at first index

Signature:

func (link *SinglyLink[T]) DeleteAtHead() error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    lk.InsertAtTail(4)

    err := lk.DeleteAtHead()
    
    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{2, 3, 4}
}

# DeleteAtTail

Delete value in singly linklist at last index

Signature:

func (link *SinglyLink[T]) DeleteAtTail() error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    err := lk.DeleteAtTail()
    
    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{1, 2}
}

# DeleteValue

Delete all `value` in singly linklist

Signature:

func (link *SinglyLink[T]) DeleteValue(value T)

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    lk.DeleteValue(2)
    fmt.Println(lk.Values()) //[]int{1, 3}
}

# Reverse

Reverse all nodes order in linkist

Signature:

func (link *SinglyLink[T]) Reverse()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    lk.Reverse()
    fmt.Println(lk.Values()) //[]int{3, 2, 1}
}

# GetMiddleNode

Get the node at middle index of linkist

Signature:

func (link *SinglyLink[T]) GetMiddleNode() *datastructure.LinkNode[T]

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    midNode := lk.GetMiddleNode()
    fmt.Println(midNode.Value) //2
}

# Size

Get the number of nodes in linklist

Signature:

func (link *SinglyLink[T]) Size() int

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Size()) //3
}

# IsEmpty

Checks if linklist is empty or not

Signature:

func (link *SinglyLink[T]) IsEmpty() bool

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()
    fmt.Println(lk.IsEmpty()) //true

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.IsEmpty()) //false
}

# Clear

Clear all nodes in the linklist, make it empty

Signature:

func (link *SinglyLink[T]) Clear()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    lk.Clear()

    fmt.Println(lk.Values()) //
}

# Print

Print all nodes info of linklist

Signature:

func (link *SinglyLink[T]) Clear()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewSinglyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    
    lk.Print() //[ &{Value:1 Pre:<nil> Next:0xc0000a4048}, &{Value:2 Pre:<nil> Next:0xc0000a4060}, &{Value:3 Pre:<nil> Next:<nil>} ]
}

# 2. DoublyLink

DoublyLink is a linked list, whose node has a value, a next pointer points to next node and pre pointer points to previous node of the link.

Return a doubly link instance

Signature:

type LinkNode[T any] struct {
	Value T
    Pre   *LinkNode[T]
	Next  *LinkNode[T]
}
type DoublyLink[T any] struct {
	Head   *datastructure.LinkNode[T]
	length int
}
func NewDoublyLink[T any]() *DoublyLink[T]

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()
    fmt.Println(lk)
}

# Values

Return a slice of all node value in doubly linklist

Signature:

func (link *DoublyLink[T]) Values() []T

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# InsertAt

Insert value into doubly linklist at index, index shoud be great or equal 0 and less or equal number of link nodes

Signature:

func (link *DoublyLink[T]) InsertAt(index int, value T) error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAt(0, 1)
    lk.InsertAt(1, 2)
    lk.InsertAt(2, 3)
    lk.InsertAt(2, 4)

    fmt.Println(lk.Values()) //[]int{1, 2, 4, 3}
}

# InsertAtHead

Insert value into doubly linklist at head(first) index

Signature:

func (link *DoublyLink[T]) InsertAtHead(value T)

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtHead(1)
    lk.InsertAtHead(2)
    lk.InsertAtHead(3)

    fmt.Println(lk.Values()) //[]int{3, 2, 1}
}

# InsertAtTail

Insert value into doubly linklist at tail(last) index

Signature:

func (link *DoublyLink[T]) InsertAtTail(value T)

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# DeleteAt

Delete value at specific index, index shoud be great or equal 0 and less or less than number of link nodes - 1

Signature:

func (link *DoublyLink[T]) DeleteAt(index int) error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    lk.InsertAtTail(4)

    err := lk.DeleteAt(3)

    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{1, 2, 3}
}

# DeleteAtHead

Delete value in doubly linklist at first index

Signature:

func (link *DoublyLink[T]) DeleteAtHead() error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    lk.InsertAtTail(4)

    err := lk.DeleteAtHead()
    
    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{2, 3, 4}
}

# DeleteAtTail

Delete value in doubly linklist at last index

Signature:

func (link *DoublyLink[T]) DeleteAtTail() error

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    err := lk.DeleteAtTail()
    
    fmt.Println(err) //nil
    fmt.Println(lk.Values()) //[]int{1, 2}
}

# Reverse

Reverse all nodes order in linkist

Signature:

func (link *DoublyLink[T]) Reverse()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    lk.Reverse()
    fmt.Println(lk.Values()) //[]int{3, 2, 1}
}

# GetMiddleNode

Get the node at middle index of linkist

Signature:

func (link *DoublyLink[T]) GetMiddleNode() *datastructure.LinkNode[T]

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    midNode := lk.GetMiddleNode()
    fmt.Println(midNode.Value) //2
}

# Size

Get the number of nodes in linklist

Signature:

func (link *DoublyLink[T]) Size() int

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.Size()) //3
}

# IsEmpty

Checks if linklist is empty or not

Signature:

func (link *DoublyLink[T]) IsEmpty() bool

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()
    fmt.Println(lk.IsEmpty()) //true

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    fmt.Println(lk.IsEmpty()) //false
}

# Clear

Clear all nodes in the linklist, make it empty

Signature:

func (link *DoublyLink[T]) Clear()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)

    lk.Clear()

    fmt.Println(lk.Values()) //
}

Print all nodes info of linklist

Signature:

func (link *DoublyLink[T]) Clear()

Example:

package main

import (
    "fmt"
    link "github.com/duke-git/lancet/v2/datastructure/link"
)

func main() {
    lk := link.NewDoublyLink[int]()

    lk.InsertAtTail(1)
    lk.InsertAtTail(2)
    lk.InsertAtTail(3)
    
    lk.Print() //
}
Last Updated: 10/22/2022, 11:35:23 AM