Skip to main content

SliceSignedDecompositionNonNativeIter

Struct SliceSignedDecompositionNonNativeIter 

Source
pub struct SliceSignedDecompositionNonNativeIter<T>
where T: UnsignedInteger,
{ /* private fields */ }
Expand description

An iterator-like object that yields the terms of the signed decomposition of a tensor of values.

§Note

On each call to SliceSignedDecompositionNonNativeIter::next_term, this structure yields a new DecompositionTermSlice, backed by a Vec owned by the structure. This vec is mutated at each call of the next_term method, and as such the term must be dropped before next_term is called again.

Such a pattern can not be implemented with iterators yet (without GATs), which is why this iterator must be explicitly called.

§Warning

This iterator yields the decomposition in reverse order. That means that the highest level will be yielded first.

Implementations§

Source§

impl<T> SliceSignedDecompositionNonNativeIter<T>
where T: UnsignedInteger,

Source

pub fn base_log(&self) -> DecompositionBaseLog

Returns the logarithm in base two of the base of this decomposition.

If the decomposition uses a base $B=2^b$, this returns $b$.

§Example
use tfhe::core_crypto::commons::math::decomposition::SignedDecomposerNonNative;
use tfhe::core_crypto::prelude::{
    CiphertextModulus, DecompositionBaseLog, DecompositionLevelCount,
};
let decomposer = SignedDecomposerNonNative::<u32>::new(
    DecompositionBaseLog(4),
    DecompositionLevelCount(3),
    CiphertextModulus::try_new((1 << 32) - (1 << 16) + 1).unwrap(),
);
let decomposable = vec![1_340_987_234_u32; 2];
let decomp = decomposer.decompose_slice(&decomposable);
assert_eq!(decomp.base_log(), DecompositionBaseLog(4));
Source

pub fn level_count(&self) -> DecompositionLevelCount

Returns the number of levels of this decomposition.

If the decomposition uses $l$ levels, this returns $l$.

§Example
use tfhe::core_crypto::commons::math::decomposition::SignedDecomposerNonNative;
use tfhe::core_crypto::prelude::{
    CiphertextModulus, DecompositionBaseLog, DecompositionLevelCount,
};
let decomposer = SignedDecomposerNonNative::<u32>::new(
    DecompositionBaseLog(4),
    DecompositionLevelCount(3),
    CiphertextModulus::try_new((1 << 32) - (1 << 16) + 1).unwrap(),
);
let decomposable = vec![1_340_987_234_u32; 2];
let decomp = decomposer.decompose_slice(&decomposable);
assert_eq!(decomp.level_count(), DecompositionLevelCount(3));
Source

pub fn next_term(&mut self) -> Option<DecompositionTermSliceNonNative<'_, T>>

Yield the next term of the decomposition, if any.

§Note

Because this function returns a borrowed tensor, owned by the iterator, the term must be dropped before next_term is called again.

§Example
use tfhe::core_crypto::commons::math::decomposition::{
    DecompositionLevel, SignedDecomposerNonNative,
};
use tfhe::core_crypto::prelude::{
    CiphertextModulus, DecompositionBaseLog, DecompositionLevelCount,
};
let decomposer = SignedDecomposerNonNative::<u32>::new(
    DecompositionBaseLog(4),
    DecompositionLevelCount(3),
    CiphertextModulus::try_new((1 << 32) - (1 << 16) + 1).unwrap(),
);
let decomposable = vec![1_340_987_234_u32; 2];
let mut decomp = decomposer.decompose_slice(&decomposable);
let term = decomp.next_term().unwrap();
assert_eq!(term.level(), DecompositionLevel(3));
assert_eq!(term.as_slice()[0], u32::MAX);

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Input, Output> CastInto<Output> for Input
where Output: CastFrom<Input>,

Source§

fn cast_into(self) -> Output

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more