Struct BinarySubspace

pub struct BinarySubspace<F, Data: Deref<Target = [F]> = Vec<F>> { /* private fields */ }

An $F_2$-linear subspace of a binary field.

The subspace is defined by a basis of elements from a binary field. The basis elements are ordered, which implies an ordering on the subspace elements.

Implementations

impl<F: BinaryField, Data: Deref<Target = [F]>> BinarySubspace<F, Data>

pub const fn new_unchecked(basis: Data) -> Self

Creates a new subspace from a vector of ordered basis elements.

This constructor does not check that the basis elements are linearly independent.

pub fn isomorphic<FIso>(&self) -> BinarySubspace<FIso>

where FIso: BinaryField + From<F>,

Creates a new subspace isomorphic to the given one.

pub fn dim(&self) -> usize

Returns the dimension of the subspace.

pub fn basis(&self) -> &[F]

Returns the slice of ordered basis elements.

pub fn get(&self, index: usize) -> F

pub fn get_checked(&self, index: usize) -> Result<F, Error>

pub fn iter(&self) -> BinarySubspaceIterator<'_, F>

Returns an iterator over all elements of the subspace in order.

This has a limitation that the iterator only yields the first 2^usize::BITS elements.

impl<F: BinaryField> BinarySubspace<F>

pub fn with_dim(dim: usize) -> Result<Self, Error>

Creates a new subspace of this binary subspace with the given dimension.

This creates a new sub-subspace using a prefix of the default $\mathbb{F}_2$ basis elements of the field.

Throws

• Error::DomainSizeTooLarge if dim is greater than this subspace’s dimension.

pub fn reduce_dim(&self, dim: usize) -> Result<Self, Error>

Creates a new subspace of this binary subspace with reduced dimension.

This creates a new sub-subspace using a prefix of the ordered basis elements.

Throws

• Error::DomainSizeTooLarge if dim is greater than this subspace’s dimension.

Trait Implementations

impl<F: Clone, Data: Clone + Deref<Target = [F]>> Clone for BinarySubspace<F, Data>

fn clone(&self) -> BinarySubspace<F, Data>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug, Data: Debug + Deref<Target = [F]>> Debug for BinarySubspace<F, Data>

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

Formats the value using the given formatter.

impl<F: BinaryField> Default for BinarySubspace<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: PartialEq, Data: PartialEq + Deref<Target = [F]>> PartialEq for BinarySubspace<F, Data>

fn eq(&self, other: &BinarySubspace<F, Data>) -> 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<F: Eq, Data: Eq + Deref<Target = [F]>> Eq for BinarySubspace<F, Data>

impl<F, Data: Deref<Target = [F]>> StructuralPartialEq for BinarySubspace<F, Data>