Struct FqVector 

pub struct FqVector<F: Field> {
    fq: F,
    len: usize,
    limbs: Vec<u64>,
}

A vector over a finite field.

Interally, it packs entries of the vectors into limbs. However, this is an abstraction that must not leave the fp library.

Fields

fq: F

len: usize

limbs: Vec<u64>

Implementations

impl<F: Field> FqVector<F>

pub fn from_raw_parts(fq: F, len: usize, limbs: Vec<u64>) -> Self

pub fn fq(&self) -> F

pub const fn len(&self) -> usize

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

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

pub(super) fn vec_mut(&mut self) -> &mut Vec<u64>

pub(super) fn len_mut(&mut self) -> &mut usize

impl<F: Field> FqVector<F>

pub(super) fn scale_helper(&mut self, c: F::ElementContainer)

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

pub(super) fn set_entry_helper( &mut self, index: usize, value: F::ElementContainer, )

pub(super) fn add_helper(&mut self, other: &Self, c: F::ElementContainer)

pub(super) fn add_offset_helper( &mut self, other: &Self, c: F::ElementContainer, offset: usize, )

pub(super) fn add_basis_element_helper( &mut self, index: usize, value: F::ElementContainer, )

pub(super) fn copy_from_slice_helper(&mut self, other: &[F::ElementContainer])

pub(super) fn add_truncate_helper( &mut self, other: &Self, c: F::ElementContainer, ) -> Option<()>

pub(super) fn add_carry_helper<T>( &mut self, other: &Self, c: F::ElementContainer, rest: &mut [T], ) -> bool

where for<'a> &'a mut T: TryInto<&'a mut Self>,

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

impl<F: Field> FqVector<F>

pub fn new(fq: F, len: usize) -> Self

pub fn new_with_capacity(fq: F, len: usize, capacity: usize) -> Self

pub fn from_slice(fq: F, slice: &[FieldElement<F>]) -> Self

pub fn from_bytes(fq: F, len: usize, data: &mut impl Read) -> Result<Self>

pub fn update_from_bytes(&mut self, data: &mut impl Read) -> Result<()>

pub fn to_bytes(&self, buffer: &mut impl Write) -> Result<()>

pub const fn is_empty(&self) -> bool

pub fn prime(&self) -> ValidPrime

pub fn slice(&self, start: usize, end: usize) -> FqSlice<'_, F>

pub fn slice_mut(&mut self, start: usize, end: usize) -> FqSliceMut<'_, F>

pub fn as_slice(&self) -> FqSlice<'_, F>

pub fn as_slice_mut(&mut self) -> FqSliceMut<'_, F>

pub fn add_basis_element(&mut self, index: usize, value: FieldElement<F>)

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

pub fn set_entry(&mut self, index: usize, value: FieldElement<F>)

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

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

pub fn set_to_zero(&mut self)

pub fn scale(&mut self, c: FieldElement<F>)

pub fn add_offset(&mut self, other: &Self, c: FieldElement<F>, offset: usize)

Add other to self on the assumption that the first offset entries of other are empty.

pub fn add(&mut self, other: &Self, c: FieldElement<F>)

pub fn assign(&mut self, other: &Self)

pub fn assign_partial(&mut self, other: &Self)

A version of FqVector::assign that allows other to be shorter than self.

pub fn is_zero(&self) -> bool

pub fn extend_len(&mut self, len: usize)

This function ensures the length of the vector is at least len. See also set_scratch_vector_size.

pub fn set_scratch_vector_size(&mut self, len: usize)

This clears the vector and sets the length to len. This is useful for reusing allocations of temporary vectors.

pub fn copy_from_slice(&mut self, slice: &[FieldElement<F>])

This replaces the contents of the vector with the contents of the slice. The two must have the same length.

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

pub fn add_truncate(&mut self, other: &Self, c: FieldElement<F>) -> Option<()>

fn add_carry_limb<T>( &mut self, idx: usize, source: u64, c: FieldElement<F>, rest: &mut [T], ) -> bool

where for<'a> &'a mut T: TryInto<&'a mut Self>,

pub fn add_carry<T>( &mut self, other: &Self, c: FieldElement<F>, rest: &mut [T], ) -> bool

where for<'a> &'a mut T: TryInto<&'a mut Self>,

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

Find the index and value of the first non-zero entry of the vector. None if the vector is zero.

pub fn density(&self) -> f32

Trait Implementations

impl<F: Field> Arbitrary for FqVector<F>

type Parameters = FqVectorArbParams<F>

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<FqVector<F>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<F: Clone + Field> Clone for FqVector<F>

fn clone(&self) -> FqVector<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field> Debug for FqVector<F>

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

Formats the value using the given formatter.

impl<'de, F: Field + Deserialize<'de>> Deserialize<'de> for FqVector<F>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Field> Display for FqVector<F>

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

Formats the value using the given formatter.

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<F: Field> From<&FqVector<F>> for Vec<FieldElement<F>>

fn from(vec: &FqVector<F>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T: AsRef<[FieldElement<F>]>, F: Field> From<(F, T)> for FqVector<F>

fn from(data: (F, T)) -> Self

Converts to this type from the input type.

impl<'a> From<FqVector<Fp<P2>>> for FpVector

fn from(x: FqVector<Fp<P2>>) -> Self

Converts to this type from the input type.

impl<'a> From<FqVector<Fp<P3>>> for FpVector

fn from(x: FqVector<Fp<P3>>) -> Self

Converts to this type from the input type.

impl<'a> From<FqVector<Fp<P5>>> for FpVector

fn from(x: FqVector<Fp<P5>>) -> Self

Converts to this type from the input type.

impl<'a> From<FqVector<Fp<P7>>> for FpVector

fn from(x: FqVector<Fp<P7>>) -> Self

Converts to this type from the input type.

impl<'a> From<FqVector<Fp<ValidPrime>>> for FpVector

fn from(x: FqVector<Fp<ValidPrime>>) -> Self

Converts to this type from the input type.

impl<F: Hash + Field> Hash for FqVector<F>

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<F: PartialEq + Field> PartialEq for FqVector<F>

fn eq(&self, other: &FqVector<F>) -> 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> Serialize for FqVector<F>

where F: Serialize + Field,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryInto<&'a mut FqVector<Fp<P2>>> for &'a mut FpVector

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a mut FqVector<Fp<P2>>, Self::Error>

Performs the conversion.

impl<'a> TryInto<&'a mut FqVector<Fp<P3>>> for &'a mut FpVector

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a mut FqVector<Fp<P3>>, Self::Error>

Performs the conversion.

impl<'a> TryInto<&'a mut FqVector<Fp<P5>>> for &'a mut FpVector

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a mut FqVector<Fp<P5>>, Self::Error>

Performs the conversion.

impl<'a> TryInto<&'a mut FqVector<Fp<P7>>> for &'a mut FpVector

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a mut FqVector<Fp<P7>>, Self::Error>

Performs the conversion.

impl<'a> TryInto<&'a mut FqVector<Fp<ValidPrime>>> for &'a mut FpVector

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a mut FqVector<Fp<ValidPrime>>, Self::Error>

Performs the conversion.

impl<F: Eq + Field> Eq for FqVector<F>

impl<F: Field> StructuralPartialEq for FqVector<F>