Struct FqSlice 

pub struct FqSlice<'a, F: Field> {
    fq: F,
    limbs: &'a [u64],
    start: usize,
    end: usize,
}

A slice of an FqVector.

This immutably borrows the vector and implements Copy.

Fields

fq: F

limbs: &'a [u64]

start: usize

end: usize

Implementations

impl<'a, F: Field> FqSlice<'a, F>

pub(super) fn new(fq: F, limbs: &'a [u64], start: usize, end: usize) -> Self

pub fn fq(&self) -> F

pub(super) fn into_limbs(self) -> &'a [u64]

pub(super) const fn start(&self) -> usize

pub(super) const fn end(&self) -> usize

pub(super) fn limbs(&self) -> &[u64]

impl<F: Field> FqSlice<'_, F>

pub(super) fn entry_helper(&self, index: usize) -> F::ElementContainer

pub(super) fn first_nonzero_helper( &self, ) -> Option<(usize, F::ElementContainer)>

impl<'a, F: Field> FqSlice<'a, F>

pub fn prime(&self) -> ValidPrime

pub fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub fn entry(&self, index: usize) -> FieldElement<F>

pub fn iter(self) -> FqVectorIterator<'a, F>

TODO: implement prime 2 version

pub fn iter_nonzero(self) -> FqVectorNonZeroIterator<'a, F>

pub fn first_nonzero(&self) -> Option<(usize, FieldElement<F>)>

pub fn is_zero(&self) -> bool

pub fn restrict(self, start: usize, end: usize) -> Self

pub fn to_owned(self) -> FqVector<F>

Converts a slice to an owned FqVector. This is vastly more efficient if the start of the vector is aligned.

impl<F: Field> FqSlice<'_, F>

pub(super) fn offset(&self) -> usize

pub(super) fn limb_range(&self) -> Range<usize>

pub(super) fn limb_range_inner(&self) -> Range<usize>

This function underflows if self.end() == 0, which happens if and only if we are taking a slice of width 0 at the start of an FpVector. This should be a very rare edge case. Dealing with the underflow properly would probably require using saturating_sub or something of that nature, and that has a nontrivial (10%) performance hit.

pub(super) fn min_limb_mask(&self) -> u64

pub(super) fn max_limb_mask(&self) -> u64

pub(super) fn limb_masks(&self) -> (u64, u64)

Trait Implementations

impl<'a, F: Clone + Field> Clone for FqSlice<'a, F>

fn clone(&self) -> FqSlice<'a, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, F: Debug + Field> Debug for FqSlice<'a, F>

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

Formats the value using the given formatter.

impl<F: Field> Display for FqSlice<'_, F>

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

Example

let fq = SmallFq::new(P2, 3);
let v = FqVector::from_slice(fq, &[fq.zero(), fq.one(), fq.a(), fq.a() * fq.a()]);
assert_eq!(&format!("{v}"), "[0, 1, a, a^2]");

// This only looks reasonable over prime fields of order less than 10
assert_eq!(&format!("{v:#}"), "01aa^2");

impl<'a, F: Field> From<&'a FqVector<F>> for FqSlice<'a, F>

fn from(v: &'a FqVector<F>) -> Self

Converts to this type from the input type.

impl<'a, F: Copy + Field> Copy for FqSlice<'a, F>