root/io.github.scala_tessella.ring_seq/ComparingOps

ComparingOps

io.github.scala_tessella.ring_seq.ComparingOps

trait ComparingOps extends IteratingOps

Provides comparison operations for a Seq considered circular.

Attributes

Graph
Supertypes: trait IteratingOps

trait SlicingOps

trait TransformingOps

trait IndexingOps

class Object

trait Matchable

class Any
Show all
Known subtypes: object RingSeq

Members list

Type members

Inherited types

For improved readability, the index of a Seq.

Attributes

Inherited from:: IndexingOps

For improved readability, the index of a circular Seq.

Attributes

Note: any value is a valid index, provided that Seq is not empty
Inherited from:: IndexingOps

Extensions

extension [A, CC <: (SeqOps)](ring: CC[A])

Tests whether this circular sequence is a reflection of a given sequence.

Value parameters

that: the sequence to test

Attributes

Returns

true if this circular sequence is a reflection of ''that'', otherwise false.

Example

Seq(0, 1, 2).isReflectionOf(Seq(0, 2, 1)) // true

Tests whether this circular sequence is a reversion of a given sequence.

Value parameters

that: the sequence to test

Attributes

Returns

true if this circular sequence is a reversion of ''that'', otherwise false.

Example

Seq(0, 1, 2).isReversionOf(Seq(2, 1, 0)) // true

Tests whether this circular sequence is a rotation of a given sequence.

Value parameters

that: the sequence to test

Attributes

Returns

true if this circular sequence is a rotation of ''that'', otherwise false.

Example

Seq(0, 1, 2).isRotationOf(Seq(1, 2, 0)) // true

Tests whether this circular sequence is a rotation or a reflection of a given sequence.

Value parameters

that: the sequence to test

Attributes

Returns

true if this circular sequence is a rotation or a reflection of ''that'', otherwise false.

Example

Seq(0, 1, 2).isRotationOrReflectionOf(Seq(2, 0, 1)) // true

Inherited extensions

extension [A, CC <: (SeqOps)](ring: CC[A])

Tests whether this circular sequence contains a given sequence as a slice.

Value parameters

that: the sequence to test

Attributes

Returns

true if this circular sequence contains a slice with the same elements as ''that'', otherwise false.

Example

Seq(0, 1, 2).containsSliceO(Seq(2, 0, 1, 2, 0)) // true

Inherited from:

SlicingOps

Finds first index after or at a start index where this circular sequence contains a given sequence as a slice.

Value parameters

from: IndexO
that: the sequence to test

Attributes

Returns

the first index >= ''from'' such that the elements of this circular sequence starting at this index match the elements of sequence ''that'', or -1 if no such subsequence exists.

Example

Seq(0, 1, 2).indexOfSliceO(Seq(2, 0, 1, 2, 0)) // 2

Inherited from:

SlicingOps

Finds last index before or at a given end index where this circular sequence contains a given sequence as a slice.

Value parameters

end: IndexO
that: the sequence to test

Attributes

Returns

the last index <= ''end'' such that the elements of this circular sequence starting at this index match the elements of sequence ''that'', or -1 if no such subsequence exists.

Example

Seq(0, 1, 2, 0, 1, 2).lastIndexOfSliceO(Seq(2, 0)) // 5

Inherited from:

SlicingOps

Computes the length of the longest segment that starts from some circular index and whose elements all satisfy some predicate.

Value parameters

from: IndexO
p: the predicate used to test elements

Attributes

Returns

the length of the longest segment of this sequence starting from circular index ''from'' such that every element of the segment satisfies the predicate ''p''

Example

Seq(0, 1, 2).segmentLengthO(_ % 2 == 0, 2) // 2

Inherited from:

SlicingOps

Selects an interval of elements.

Value parameters

from: IndexO
until: IndexO

Attributes

Returns

a sequence containing the elements greater than or equal to circular index ''from'' extending up to (but not including) circular index ''until'' of this sequence.

Note

a slice of a circular sequence can be bigger than the size of the elements in the sequence.

Example

Seq(0, 1, 2).sliceO(-1, 4) // Seq(2, 0, 1, 2, 0)

Inherited from:

SlicingOps

extension [A, CC <: (SeqOps)](ring: CC[A])

Reflects the sequence to start at some circular index.

Value parameters

i: IndexO

Attributes

Returns

a sequence consisting of all elements reversed and rotated to start at circular index ''i''.

Example

Seq(0, 1, 2).reflectAt() // Seq(0, 2, 1)

Inherited from:

TransformingOps

Rotates the sequence to the left by some steps.

Value parameters

step: the circular distance between each old and new position

Attributes

Returns

a sequence consisting of all elements rotated to the left by ''step'' places. If ''step'' is negative the rotation happens to the right.

Example

Seq(0, 1, 2).rotateLeft(1) // Seq(1, 2, 0)

Inherited from:

TransformingOps

Rotate the sequence to the right by some steps.

Value parameters

step: the circular distance between each new and old position

Attributes

Returns

a sequence consisting of all elements rotated to the right by ''step'' places. If ''step'' is negative the rotation happens to the left.

Example

Seq(0, 1, 2).rotateRight(1) // Seq(2, 0, 1)

Inherited from:

TransformingOps

Rotates the sequence to start at some circular index.

Value parameters

i: IndexO

Attributes

Returns

a sequence consisting of all elements rotated to start at circular index ''i''. It is equivalent to rotateLeft.

Example

Seq(0, 1, 2).startAt(1) // Seq(1, 2, 0)

Inherited from:

TransformingOps

extension [A, CC <: (SeqOps)](ring: CC[A])

Computes all the reflections of this circular sequence

Attributes

Returns

An iterator producing the 2 sequences obtained by reflecting this circular sequence, starting from itself, or just itself if empty.

Example

Seq(0, 1, 2).reflections // Iterator(Seq(0, 1, 2), Seq(0, 2, 1))

Inherited from:

IteratingOps

Computes all the reversions of this circular sequence

Attributes

Returns

An iterator producing the 2 sequences obtained by reversing this circular sequence, starting from itself, or just itself if empty.

Example

Seq(0, 1, 2).reversions // Iterator(Seq(0, 1, 2), Seq(2, 1, 0))

Inherited from:

IteratingOps

Computes all the rotations of this circular sequence

Attributes

Returns

An iterator producing all the sequences obtained by rotating this circular sequence, starting from itself and moving one rotation step to the right, or just itself if empty.

Example

Seq(0, 1, 2).rotations // Iterator(Seq(0, 1, 2), Seq(1, 2, 0), Seq(2, 0, 1))

Inherited from:

IteratingOps

Computes all the rotations and reflections of this circular sequence

Attributes

Returns

An iterator producing all the sequences obtained by rotating and reflecting this circular sequence, starting from itself and moving one rotation step to the right, then reflecting and doing the same, or just itself if empty.

Example

Seq(0, 1, 2).rotationsAndReflections // Iterator(Seq(0, 1, 2), Seq(1, 2, 0), Seq(2, 0, 1), Seq(0, 2, 1), Seq(2, 1, 0), Seq(1, 0, 2))

Inherited from:

IteratingOps

Groups elements in fixed size blocks by passing a "sliding window" over them

Value parameters

size: the number of elements per group
step: the distance between the first elements of successive groups

Attributes

Returns

An iterator producing sequences of size ''size''.

Example

Seq(0, 1, 2).slidingO(2) // Iterator(Seq(0, 1), Seq(1, 2), Seq(2, 0))

Inherited from:

IteratingOps

extension [A, CC <: (SeqOps)](ring: CC[A])

Gets the element at some circular index.

Value parameters

i: IndexO

Attributes

Throws

java.lang.ArithmeticException

if Seq is empty

Example

Seq(0, 1, 2).applyO(3) // 0

Inherited from:

IndexingOps

Normalize a given index of a circular Seq

Value parameters

i: IndexO

Attributes

Inherited from:: IndexingOps

In this article

Generated with