Enum AxisLocation 

pub enum AxisLocation {
    Vertex(usize),
    Edge(usize, usize),
}

A location on a circular sequence where a reflectional-symmetry axis passes.

Variants

• Vertex — the axis passes through the element at the given index.
• Edge — the axis passes between two consecutive elements.

Variants

Vertex(usize)

The axis passes through the element at this index.

Edge(usize, usize)

The axis passes between the elements at these two consecutive indices. The invariant j == (i + 1) % n is maintained by AxisLocation::edge.

Implementations

impl AxisLocation

pub fn edge(i: usize, n: usize) -> Self

Constructs an Edge between consecutive elements of a ring of size n, starting at index i.

The second index is computed as (i + 1) % n.

Panics

Panics if n is zero.

Examples

use ring_seq::AxisLocation;

assert_eq!(AxisLocation::edge(2, 3), AxisLocation::Edge(2, 0));
assert_eq!(AxisLocation::edge(0, 4), AxisLocation::Edge(0, 1));

Trait Implementations

impl Clone for AxisLocation

fn clone(&self) -> AxisLocation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AxisLocation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for AxisLocation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AxisLocation

fn eq(&self, other: &AxisLocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AxisLocation

impl Eq for AxisLocation

impl StructuralPartialEq for AxisLocation