Struct concrete_core::crypto::lwe::LweMask

pub struct LweMask<Cont> { /* fields omitted */ }

The mask of an LWE encrypted ciphertext.

Implementations

impl<Cont> LweMask<Cont>

pub fn from_container(cont: Cont) -> LweMask<Cont>

Creates a mask from a scalar container.

Example

use concrete_core::crypto::lwe::*;
use concrete_core::crypto::LweDimension;
let masks = LweMask::from_container(vec![0 as u8; 10]);
assert_eq!(masks.mask_size(), LweDimension(10));

pub fn mask_element_iter(
    &self
) -> impl Iterator<Item = &<Self as AsRefTensor>::Element> where
    Self: AsRefTensor, 

Returns an iterator over the mask elements.

Example

use concrete_core::crypto::lwe::*;
let mut ciphertext = LweCiphertext::from_container(vec![0 as u8; 10]);
let masks = ciphertext.get_mask();
for mask in masks.mask_element_iter(){
    assert_eq!(mask, &0);
}
assert_eq!(masks.mask_element_iter().count(), 9);

pub fn mask_element_iter_mut(
    &mut self
) -> impl Iterator<Item = &mut <Self as AsMutTensor>::Element> where
    Self: AsMutTensor, 

Returns an iterator over mutable mask elements.

Example

use concrete_core::crypto::lwe::*;
let mut ciphertext = LweCiphertext::from_container(vec![0 as u8; 10]);
let mut masks = ciphertext.get_mut_mask();
for mask in masks.mask_element_iter_mut(){
    *mask = 9;
}
for mask in masks.mask_element_iter(){
    assert_eq!(mask, &9);
}
assert_eq!(masks.mask_element_iter_mut().count(), 9);

pub fn mask_size(&self) -> LweDimension where
    Self: AsRefTensor, 

Returns the number of masks.

Example

use concrete_core::crypto::lwe::*;
use concrete_core::crypto::LweDimension;
let mut ciphertext = LweCiphertext::from_container(vec![0 as u8; 10]);
assert_eq!(ciphertext.get_mask().mask_size(), LweDimension(9));

pub fn compute_binary_multisum<Scalar, KeyCont>(
    &self,
    key: &LweSecretKey<KeyCont>
) -> Scalar where
    Self: AsRefTensor<Element = Scalar>,
    LweSecretKey<KeyCont>: AsRefTensor<Element = bool>,
    Scalar: UnsignedTorus, 

Computes sum of the mask elements wighted by the key bits.

Example

use concrete_core::crypto::lwe::LweCiphertext;
use concrete_core::crypto::secret::LweSecretKey;
let ciphertext = LweCiphertext::from_container(vec![1u32,2,3,4,5]);
let mask = ciphertext.get_mask();
let key = LweSecretKey::from_container(vec![true, true, false, true]);
let multisum = mask.compute_binary_multisum(&key);
assert_eq!(multisum, 7);

Trait Implementations

impl<Element> AsMutTensor for LweMask<Vec<Element>>

type Element = Element

The element type.

type Container = Vec<Element>

The container used by the tensor.

fn as_mut_tensor(&mut self) -> &mut Tensor<<Self as AsMutTensor>::Container>

Returns a mutable reference to the enclosed tensor.

impl<Element> AsMutTensor for LweMask<[Element; 1]>

type Element = Element

The element type.

type Container = [Element; 1]

The container used by the tensor.

fn as_mut_tensor(&mut self) -> &mut Tensor<<Self as AsMutTensor>::Container>

Returns a mutable reference to the enclosed tensor.

impl<Element> AsMutTensor for LweMask<AlignedVec<Element>>

type Element = Element

The element type.

type Container = AlignedVec<Element>

The container used by the tensor.

fn as_mut_tensor(&mut self) -> &mut Tensor<<Self as AsMutTensor>::Container>

Returns a mutable reference to the enclosed tensor.

impl<'a, Element> AsMutTensor for LweMask<&'a mut [Element]>

type Element = Element

The element type.

type Container = &'a mut [Element]

The container used by the tensor.

fn as_mut_tensor(&mut self) -> &mut Tensor<<Self as AsMutTensor>::Container>

Returns a mutable reference to the enclosed tensor.

impl<Element> AsRefTensor for LweMask<Vec<Element>>

type Element = Element

The element type.

type Container = Vec<Element>

The container used by the tensor.

fn as_tensor(&self) -> &Tensor<Self::Container>

Returns a reference to the enclosed tensor.

impl<Element> AsRefTensor for LweMask<AlignedVec<Element>>

type Element = Element

The element type.

type Container = AlignedVec<Element>

The container used by the tensor.

fn as_tensor(&self) -> &Tensor<Self::Container>

Returns a reference to the enclosed tensor.

impl<Element> AsRefTensor for LweMask<[Element; 1]>

type Element = Element

The element type.

type Container = [Element; 1]

The container used by the tensor.

fn as_tensor(&self) -> &Tensor<Self::Container>

Returns a reference to the enclosed tensor.

impl<'a, Element> AsRefTensor for LweMask<&'a [Element]>

type Element = Element

The element type.

type Container = &'a [Element]

The container used by the tensor.

fn as_tensor(&self) -> &Tensor<Self::Container>

Returns a reference to the enclosed tensor.

impl<'a, Element> AsRefTensor for LweMask<&'a mut [Element]>

type Element = Element

The element type.

type Container = &'a mut [Element]

The container used by the tensor.

fn as_tensor(&self) -> &Tensor<Self::Container>

Returns a reference to the enclosed tensor.

impl<Cont: Debug> Debug for LweMask<Cont>

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

Formats the value using the given formatter.

impl<Element> IntoTensor for LweMask<Vec<Element>>

type Element = Element

The element type of the collection container.

type Container = Vec<Element>

The type of the collection container.

fn into_tensor(self) -> Tensor<Self::Container>

Consumes self and returns an owned tensor.

impl<Element> IntoTensor for LweMask<AlignedVec<Element>>

type Element = Element

The element type of the collection container.

type Container = AlignedVec<Element>

The type of the collection container.

fn into_tensor(self) -> Tensor<Self::Container>

Consumes self and returns an owned tensor.

impl<Element> IntoTensor for LweMask<[Element; 1]>

type Element = Element

The element type of the collection container.

type Container = [Element; 1]

The type of the collection container.

fn into_tensor(self) -> Tensor<Self::Container>

Consumes self and returns an owned tensor.

impl<'a, Element> IntoTensor for LweMask<&'a [Element]>

type Element = Element

The element type of the collection container.

type Container = &'a [Element]

The type of the collection container.

fn into_tensor(self) -> Tensor<Self::Container>

Consumes self and returns an owned tensor.

impl<'a, Element> IntoTensor for LweMask<&'a mut [Element]>

type Element = Element

The element type of the collection container.

type Container = &'a mut [Element]

The type of the collection container.

fn into_tensor(self) -> Tensor<Self::Container>

Consumes self and returns an owned tensor.

impl<Cont: PartialEq> PartialEq<LweMask<Cont>> for LweMask<Cont>

fn eq(&self, other: &LweMask<Cont>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LweMask<Cont>) -> bool

This method tests for !=.

impl<Cont: Eq> Eq for LweMask<Cont>

impl<Cont> StructuralEq for LweMask<Cont>

impl<Cont> StructuralPartialEq for LweMask<Cont>