ring

Documentation

Overview

Package ring implements operations on circular lists.

Index

• type Ring
  • func New[T any](n int, initValue func() T) *Ring[T]
  • func (r *Ring[T]) Do(f func(T))
  • func (r *Ring[T]) Len() int
  • func (r *Ring[T]) Link(s *Ring[T]) *Ring[T]
  • func (r *Ring[T]) Move(n int) *Ring[T]
  • func (r *Ring[T]) Next() *Ring[T]
  • func (r *Ring[T]) Prev() *Ring[T]
  • func (r *Ring[T]) Unlink(n int) *Ring[T]
• type SysRing
  • func NewRing[T any](n int, initValue func() T) *SysRing[T]
  • func (r *SysRing[T]) Next() *SysRing[T]
  • func (r *SysRing[T]) Value() T

Types

type Ring

type Ring[T any] struct {
	Value T // for use by client; untouched by this library
	// contains filtered or unexported fields
}

A Ring is an element of a circular list, or ring. Rings do not have a beginning or end; a pointer to any ring element serves as reference to the entire ring. Empty rings are represented as nil Ring pointers. The zero value for a Ring is a one-element ring with a nil Value.

func New

func New[T any](n int, initValue func() T) *Ring[T]

New creates a ring of n elements.

func (*Ring[T]) Do

func (r *Ring[T]) Do(f func(T))

Do calls function f on each element of the ring, in forward order. The behavior of Do is undefined if f changes *r.

func (*Ring[T]) Len

func (r *Ring[T]) Len() int

Len computes the number of elements in ring r. It executes in time proportional to the number of elements.

func (*Ring[T]) Link

func (r *Ring[T]) Link(s *Ring[T]) *Ring[T]

Link connects ring r with ring s such that r.Next() becomes s and returns the original value for r.Next(). r must not be empty.

If r and s point to the same ring, linking them removes the elements between r and s from the ring. The removed elements form a subring and the result is a reference to that subring (if no elements were removed, the result is still the original value for r.Next(), and not nil).

If r and s point to different rings, linking them creates a single ring with the elements of s inserted after r. The result points to the element following the last element of s after insertion.

func (*Ring[T]) Move

func (r *Ring[T]) Move(n int) *Ring[T]

Move moves n % r.Len() elements backward (n < 0) or forward (n >= 0) in the ring and returns that ring element. r must not be empty.

func (*Ring[T]) Next

func (r *Ring[T]) Next() *Ring[T]

Next returns the next ring element. r must not be empty.

func (*Ring[T]) Prev

func (r *Ring[T]) Prev() *Ring[T]

Prev returns the previous ring element. r must not be empty.

func (*Ring[T]) Unlink

func (r *Ring[T]) Unlink(n int) *Ring[T]

Unlink removes n % r.Len() elements from the ring r, starting at r.Next(). If n % r.Len() == 0, r remains unchanged. The result is the removed subring. r must not be empty.

type SysRing

type SysRing[T any] struct {
	// contains filtered or unexported fields
}

func NewRing

func NewRing[T any](n int, initValue func() T) *SysRing[T]

func (*SysRing[T]) Next

func (r *SysRing[T]) Next() *SysRing[T]

func (*SysRing[T]) Value

func (r *SysRing[T]) Value() T