Struct Coset 

pub struct Coset {
    pub initial_index: CirclePointIndex,
    pub initial: CirclePoint<M31>,
    pub step_size: CirclePointIndex,
    pub step: CirclePoint<M31>,
    pub log_size: u32,
}

Represents the coset initial + <step>.

Fields

initial_index: CirclePointIndex

initial: CirclePoint<M31>

step_size: CirclePointIndex

step: CirclePoint<M31>

log_size: u32

Implementations

impl Coset

pub fn new(initial_index: CirclePointIndex, log_size: u32) -> Self

pub fn subgroup(log_size: u32) -> Self

Creates a coset of the form <G_n>. For example, for n=8, we get the point indices [0,1,2,3,4,5,6,7].

pub fn odds(log_size: u32) -> Self

Creates a coset of the form G_2n + <G_n>.

For example, let n = 8 and denote G_16 = x, <G_8> = <2x>. The point indices are [x, 3x, 5x, 7x, 9x, 11x, 13x, 15x].

pub fn half_odds(log_size: u32) -> Self

Creates a coset of the form G_4n + <G_n>. It’s conjugate is 3 * G_4n + <G_n>.

For example, let n = 8 and denote G_32 = x, <G_8> = <4x>. The point indices are [x, 5x, 9x, 13x, 17x, 21x, 25x, 29x]. Conjugate coset indices are [3x, 7x, 11x, 15x, 19x, 23x, 27x, 31x].

Note: This coset union with its conjugate coset is the odds(log_size + 1) coset.

pub const fn size(&self) -> usize

Returns the size of the coset.

pub const fn log_size(&self) -> u32

Returns the log size of the coset.

pub const fn iter(&self) -> CosetIterator<CirclePoint<M31>>

pub const fn iter_indices(&self) -> CosetIterator<CirclePointIndex>

pub fn double(&self) -> Self

Returns a new coset comprising of all points in current coset doubled.

pub fn repeated_double(&self, n_doubles: u32) -> Self

pub fn is_doubling_of(&self, other: Self) -> bool

Note that this function panics when self.log_size == 0.

pub const fn initial(&self) -> CirclePoint<M31>

pub fn index_at(&self, index: usize) -> CirclePointIndex

pub fn at(&self, index: usize) -> CirclePoint<M31>

pub fn shift(&self, shift_size: CirclePointIndex) -> Self

pub fn conjugate(&self) -> Self

Creates the conjugate coset: -initial -<step>.

Trait Implementations

impl Clone for Coset

fn clone(&self) -> Coset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Coset

impl Debug for Coset

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

Formats the value using the given formatter.

impl Eq for Coset

impl IntoIterator for Coset

fn into_iter(self) -> Self::IntoIter

Iterates over the points in the coset.

type Item = CirclePoint<M31>

The type of the elements being iterated over.

type IntoIter = CosetIterator<CirclePoint<M31>>

Which kind of iterator are we turning this into?

impl PartialEq for Coset

fn eq(&self, other: &Coset) -> 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 StructuralPartialEq for Coset