ring-seq/io.github.scala_tessella.ring_seq/SymmetryOps

SymmetryOps

trait SymmetryOps extends TransformingOps

Provides symmetry operations for a Seq considered circular.

class Object
trait Matchable
class Any
object RingSeq.type

Type members

Inherited types

type Index = Int

For improved readability, the index of a Seq.

For improved readability, the index of a Seq.

Inherited from:
IndexingOps
type IndexO = Int

For improved readability, the index of a circular Seq.

For improved readability, the index of a circular Seq.

Note:

any value is a valid index, provided that Seq is not empty

Inherited from:
IndexingOps

Extensions

Extensions

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

Computes the order of rotational symmetry possessed by this circular sequence.

Computes the order of rotational symmetry possessed by this circular sequence.

Returns:

the number >= 1 of rotations in which this circular sequence looks exactly the same.

Example:
Seq(0, 1, 2, 0, 1, 2).rotationalSymmetry // 2
def symmetry: Int

Computes the order of reflectional (mirror) symmetry possessed by this circular sequence.

Computes the order of reflectional (mirror) symmetry possessed by this circular sequence.

Returns:

the number >= 0 of reflections in which this circular sequence looks exactly the same.

Example:
Seq(2, 1, 2, 2, 1, 2, 2, 1, 2, 2, 1, 2).symmetry // 4
def symmetryIndices: List[Index]

Finds the indices of each element of this circular sequence close to an axis of reflectional symmetry.

Finds the indices of each element of this circular sequence close to an axis of reflectional symmetry.

Returns:

the indices of each element of this circular sequence close to an axis of reflectional symmetry, that is a line of symmetry that splits the sequence in two identical halves.

Example:
Seq(2, 1, 2, 2, 1, 2, 2, 1, 2, 2, 1, 2).symmetryIndices // List(1, 4, 7, 10)

Inherited extensions

extension [A, CC <: (SeqOps)](ring: CC[A])
def applyO(i: IndexO): A

Gets the element at some circular index.

Gets the element at some circular index.

Value parameters:
i

IndexO

Throws:
java.lang.ArithmeticException

if Seq is empty

Example:
Seq(0, 1, 2).applyO(3) // 0
Inherited from:
IndexingOps
def indexFrom(i: IndexO): Index

Normalize a given index of a circular Seq

Normalize a given index of a circular Seq

Value parameters:
i

IndexO

Inherited from:
IndexingOps
extension [A, CC <: (SeqOps)](ring: CC[A])
def reflectAt(i: IndexO): CC[A]

Reflects the sequence to start at some circular index.

Reflects the sequence to start at some circular index.

Value parameters:
i

IndexO

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
def rotateLeft(step: Int): CC[A]

Rotates the sequence to the left by some steps.

Rotates the sequence to the left by some steps.

Value parameters:
step

the circular distance between each old and new position

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
def rotateRight(step: Int): CC[A]

Rotate the sequence to the right by some steps.

Rotate the sequence to the right by some steps.

Value parameters:
step

the circular distance between each new and old position

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
def startAt(i: IndexO): CC[A]

Rotates the sequence to start at some circular index.

Rotates the sequence to start at some circular index.

Value parameters:
i

IndexO

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