ring

Documentation

Overview

ring implements RingBuffer

Index

• type Numeric
• type RingBuffer
  • func NewRingBuffer[T Numeric](size int) *RingBuffer[T]
  • func (rb *RingBuffer[T]) Add(value T)
  • func (rb *RingBuffer[T]) AverageNonZero() T
  • func (rb *RingBuffer[T]) GetAll() []T
  • func (rb *RingBuffer[T]) GetLast() T
  • func (rb *RingBuffer[T]) GetSecondLast() T

Types

type Numeric

type Numeric interface {
	~int | ~int64 | ~float64
}

Numeric is a constraint that allows only numeric types (int, int64, float64, etc.)

type RingBuffer

type RingBuffer[T Numeric] struct {
	// contains filtered or unexported fields
}

RingBuffer is a generic fixed-size circular buffer for numeric types.

func NewRingBuffer

func NewRingBuffer[T Numeric](size int) *RingBuffer[T]

NewRingBuffer creates a new RingBuffer of the given size.

func (*RingBuffer[T]) Add

func (rb *RingBuffer[T]) Add(value T)

Add adds a new element to the buffer.

func (*RingBuffer[T]) AverageNonZero

func (rb *RingBuffer[T]) AverageNonZero() T

AverageNonZero calculates the average of non-zero elements in the buffer.

func (*RingBuffer[T]) GetAll

func (rb *RingBuffer[T]) GetAll() []T

GetAll retrieves all elements from the buffer in order.

func (*RingBuffer[T]) GetLast

func (rb *RingBuffer[T]) GetLast() T

GetLast retrieves the last element from the buffer. If the buffer is empty, it returns the zero value of the type.

func (*RingBuffer[T]) GetSecondLast

func (rb *RingBuffer[T]) GetSecondLast() T

GetSecondLast retrieves the second-to-last element from the buffer. If the buffer has fewer than two elements, it returns the zero value of the type.