Struct libreda_db::prelude::RegularRepetition

pub struct RegularRepetition<T> where
    T: CoordinateType, {
    a: Vector<T>,
    b: Vector<T>,
    n: u32,
    m: u32,
}

Describe a equi-spaced n*m two-dimensional repetition as a lattice. The offsets are computed as (i*a, j*b) for i in 0..n and j in 0..m. a and b the distance vectors between two neighbouring points.

Fields

a: Vector<T>

First lattice vector.

b: Vector<T>

Second lattice vector.

n: u32

First dimension.

m: u32

Second dimension.

Implementations

impl<T> RegularRepetition<T> where
    T: CoordinateType, 

pub fn new(a: Vector<T>, b: Vector<T>, n: u32, m: u32) -> RegularRepetition<T>

Create a new lattice based repetition.

Parameters

• a, b: Lattice vectors.
• n, m: Number of repetitions in directions a and b.

pub fn new_rectilinear(
    spacing_x: T,
    spacing_y: T,
    num_x: u32,
    num_y: u32
) -> RegularRepetition<T>

Create a repetition along the x and y axis.

Example

use iron_shapes::prelude::RegularRepetition;

let rep = RegularRepetition::new_rectilinear(1, 1, 1, 2);
assert_eq!(rep.len(), 2);
let offsets: Vec<_> = rep.iter().collect();

assert_eq!(offsets, [(0, 0).into(), (0, 1).into()]);

pub fn iter(self) -> impl Iterator<Item = Vector<T>>

Iterate over each offsets of this repetition.

pub fn len(&self) -> usize

Return the number of offsets in this repetition.

pub fn is_empty(&self) -> bool

Check if number of repetitions is zero.

Trait Implementations

impl<T> Clone for RegularRepetition<T> where
    T: Clone + CoordinateType, 

fn clone(&self) -> RegularRepetition<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RegularRepetition<T> where
    T: Debug + CoordinateType, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for RegularRepetition<T> where
    T: CoordinateType + Deserialize<'de>, 

fn deserialize<__D>(
    __deserializer: __D
) -> Result<RegularRepetition<T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Hash for RegularRepetition<T> where
    T: Hash + CoordinateType, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq<RegularRepetition<T>> for RegularRepetition<T> where
    T: PartialEq<T> + CoordinateType, 

fn eq(&self, other: &RegularRepetition<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RegularRepetition<T>) -> bool

This method tests for !=.

impl<T> Serialize for RegularRepetition<T> where
    T: CoordinateType + Serialize, 

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> Copy for RegularRepetition<T> where
    T: Copy + CoordinateType, 

impl<T> Eq for RegularRepetition<T> where
    T: Eq + CoordinateType, 

impl<T> StructuralEq for RegularRepetition<T> where
    T: CoordinateType, 

impl<T> StructuralPartialEq for RegularRepetition<T> where
    T: CoordinateType,