ds

type BackwardIterator interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// Next moves the iterator backward  by one position.
	Previous()

	// NextN moves the iterator backward by n positions.
	PreviousN(n int)
}

type BidirectionalIterator interface {
	// *********************    Inherited methods    ********************//
	ForwardIterator
	BackwardIterator

	// Next moves the iterator forward/backward by n positions.
	MoveBy(n int)
}

type CollectionIterator[TIndex any] interface {
	// *********************    Inherited methods    ********************//
	SizedIterator

	// Index returns the index of the iterator's position in the collection.
	Index() TIndex
}

type ComparableIterator interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// IsEqualTo checks if the iterator's position is said to be equal to other's position.
	IsEqual(other ComparableIterator) bool
}

type Container interface {
	IsEmpty() bool
	Size() int
	Clear()
	ToString() string
}

type ForwardIterator interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// Next moves the iterator forward by one position.
	Next()

	// NextN moves the iterator forward by n positions.
	NextN(i int)
}

type Iterator interface {
	// IsBegin checks if the iterator is pointing to one element before it's first element, unless Next() is called, the iterator is in an invalid state.
	IsBegin() bool
	// IsEnd checks if the iterator is pointing to one element past it's last element, unless Previous() is called, the iterator is in an invalid state.
	IsEnd() bool

	// IsFirst checks if the iterator is pointing to it's first element, when Next() is called, the iterator is in an invalid state.
	IsFirst() bool
	// IsBegin checks if the iterator is pointing to it's last element, when Previous() is called, the iterator is in an invalid state.
	IsLast() bool

	// IsValid checks if the iterator is in a valid position and not e.g. out of bounds.
	IsValid() bool
}

type JSONDeserializer interface {
	// FromJSON populates containers's elements from the input JSON representation.
	FromJSON([]byte) error
	// UnmarshalJSON @implements json.Unmarshaler
	UnmarshalJSON([]byte) error
}

type JSONSerializer interface {
	// ToJSON outputs the JSON representation of containers's elements.
	ToJSON() ([]byte, error)
	// MarshalJSON @implements json.Marshaler
	MarshalJSON() ([]byte, error)
}

type OrderedIterator interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// IsBefore checks if the iterator's position is said to come before other's position.
	IsBefore(other OrderedIterator) bool
	// IsBefore checks if the iterator's position is said to come after other's position.
	IsAfter(other OrderedIterator) bool

	// DistanceTo returns the signed distance of the iterator's position to other's position.
	DistanceTo(other OrderedIterator) int
}

type RWOrdCompBidRandCollIterator[T any, TIndex any] interface {
	OrderedIterator
	ComparableIterator

	BidirectionalIterator

	RandomAccessReadableIterator[TIndex, T]
	RandomAccessWriteableIterator[TIndex, T]
}

type RWOrdCompBidRevRandCollIterator[T any, TIndex any] interface {
	OrderedIterator
	ComparableIterator

	ReversedIterator
	BackwardIterator

	RandomAccessReadableIterator[TIndex, T]
	RandomAccessWriteableIterator[TIndex, T]
}

type RandomAccessIterator[TIndex any] interface {
	// *********************    Inherited methods    ********************//
	BidirectionalIterator
	CollectionIterator[TIndex]

	// MoveTo moves the iterator to the given index.
	MoveTo(i TIndex)
}

type RandomAccessReadableIterator[T any, V any] interface {
	// *********************    Inherited methods    ********************//
	RandomAccessIterator[T]
	ReadableIterator[V]

	// GetAt returns the value at the given index of the iterator.
	GetAt(i T) (value V, found bool)
}

type RandomAccessWriteableIterator[T any, V any] interface {
	// *********************    Inherited methods    ********************//
	RandomAccessIterator[T]
	WritableIterator[V]

	// GetAt sets the value at the given index of the iterator.
	SetAt(i T, value V) bool
}

type ReadableIterator[T any] interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// Get returns the value at the iterator's position.
	// found will be false if the iterator is in an invalid state or the collection is empty.
	Get() (value T, found bool)
}

type ReversedIterator interface {
	// *********************    Inherited methods    ********************//
	ForwardIterator
}

type SizedIterator interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// Size returns the number of elements in the iterator.
	Size() int
}

type UnorderedBackwardIterator interface {
	// *********************    Inherited methods    ********************//
	BackwardIterator

	// PreviousOrdered moves the iterator backward by one position according to the indexes lexographical ordering instead of the underlying data structure's ordering.
	PreviousOrdered()

	// PreviousOrdered moves the iterator backward by n positions according to the indexes lexographical ordering instead of the underlying data structure's ordering.
	PreviousOrderedN(n int)
}

type UnorderedForwardIterator interface {
	// *********************    Inherited methods    ********************//
	ForwardIterator

	// NextOrdered moves the iterator forward by one position according to the indexes lexographical ordering instead of the underlying data structure's ordering.
	NextOrdered()

	// NextOrdered moves the iterator forward by n positions according to the indexes lexographical ordering instead of the underlying data structure's ordering.
	NextOrderedN(n int)
}

type WritableIterator[T any] interface {
	// *********************    Inherited methods    ********************//
	Iterator

	// Set sets the value at the iterator's position.
	Set(value T) bool
}