Struct RingVector 

pub struct RingVector { /* private fields */ }

Vector of ring elements over Z_m.

Implementations

impl RingVector

pub fn new(elements: Vec<RingElement>) -> Self

Create a new vector from a slice of ring elements.

Panics

Panics if the vector is empty or elements have different moduli.

pub fn try_new(elements: Vec<RingElement>) -> Result<Self, RingError>

Try to create a new vector from ring elements.

Errors

Returns RingError::DimensionMismatch if the vector is empty and RingError::ModulusMismatch if the elements do not share the same modulus.

pub fn zero(len: usize, modulus: u64) -> Self

Create a zero vector of given length.

Panics

Panics if len == 0.

pub fn from_values(values: &[u64], modulus: u64) -> Self

Create a vector from raw values.

pub const fn len(&self) -> usize

Get the length of the vector.

pub const fn is_empty(&self) -> bool

Check if vector is empty.

pub const fn modulus(&self) -> u64

Get the modulus.

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

Get element at index.

Panics

Panics if index is out of bounds.

pub fn set(&mut self, index: usize, value: RingElement)

Set element at index.

Panics

Panics if index is out of bounds or if value has a different modulus.

pub fn elements(&self) -> &[RingElement]

Return the underlying elements as a slice.

pub fn dot(&self, other: &Self) -> RingElement

Compute dot product with another vector.

Panics

Panics if vectors have different lengths or different moduli.

pub fn try_dot(&self, other: &Self) -> Result<RingElement, RingError>

Compute a checked dot product with another vector.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn scale(&self, scalar: RingElement) -> Self

Scalar multiplication.

Panics

Panics if scalar has a different modulus.

pub fn scale_by(&self, scalar: u64) -> Self

Scale by a raw value.

pub fn try_add(&self, other: &Self) -> Result<Self, RingError>

Compute a checked element-wise sum.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn try_sub(&self, other: &Self) -> Result<Self, RingError>

Compute a checked element-wise difference.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn iter(&self) -> impl Iterator<Item = &RingElement>

Get iterator over elements.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut RingElement>

Get mutable iterator over elements.

pub fn to_values(&self) -> Vec<u64>

Convert to Vec of raw values.

Trait Implementations

impl<'b> Add<&'b RingVector> for &RingVector

type Output = RingVector

The resulting type after applying the + operator.

fn add(self, other: &'b RingVector) -> RingVector

Performs the + operation.

impl Add for RingVector

type Output = RingVector

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for RingVector

fn clone(&self) -> RingVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingVector

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RingVector

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<usize> for RingVector

type Output = RingElement

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for RingVector

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Neg for RingVector

type Output = RingVector

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for RingVector

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'b> Sub<&'b RingVector> for &RingVector

type Output = RingVector

The resulting type after applying the - operator.

fn sub(self, other: &'b RingVector) -> RingVector

Performs the - operation.

impl Sub for RingVector

type Output = RingVector

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Eq for RingVector

impl StructuralPartialEq for RingVector