Struct group::Wnaf

source ·
pub struct Wnaf<W, B, S> { /* private fields */ }
Expand description

A “w-ary non-adjacent form” scalar multiplication (also known as exponentiation) context.

§Examples

This struct can be used to implement several patterns:

§One base, one scalar

For this pattern, you can use a transient Wnaf context:

use group::Wnaf;

let result = Wnaf::new().scalar(&scalar).base(base);

§Many bases, one scalar

For this pattern, you create a Wnaf context, load the scalar into it, and then process each base in turn:

use group::Wnaf;

let mut wnaf = Wnaf::new();
let mut wnaf_scalar = wnaf.scalar(&scalar);
let results: Vec<_> = bases
    .into_iter()
    .map(|base| wnaf_scalar.base(base))
    .collect();

§One base, many scalars

For this pattern, you create a Wnaf context, load the base into it, and then process each scalar in turn:

use group::Wnaf;

let mut wnaf = Wnaf::new();
let mut wnaf_base = wnaf.base(base, scalars.len());
let results: Vec<_> = scalars
    .iter()
    .map(|scalar| wnaf_base.scalar(scalar))
    .collect();

§Many bases, many scalars

Say you have n bases and m scalars, and want to produce n * m results. For this pattern, you need to cache the w-NAF tables for the bases and then compute the w-NAF form of the scalars on the fly for every base, or vice versa:

use group::Wnaf;

let mut wnaf_contexts: Vec<_> = (0..bases.len()).map(|_| Wnaf::new()).collect();
let mut wnaf_bases: Vec<_> = wnaf_contexts
    .iter_mut()
    .zip(bases)
    .map(|(wnaf, base)| wnaf.base(base, scalars.len()))
    .collect();
let results: Vec<_> = wnaf_bases
    .iter()
    .flat_map(|wnaf_base| scalars.iter().map(|scalar| wnaf_base.scalar(scalar)))
    .collect();

Alternatively, use the WnafBase and WnafScalar types, which enable the various tables and w-NAF forms to be cached individually per base and scalar. These types can then be directly multiplied without any additional runtime work, at the cost of fixing a specific window size (rather than choosing the window size dynamically).

Implementations§

source§

impl<G: Group> Wnaf<(), Vec<G>, Vec<i64>>

source

pub fn new() -> Self

Construct a new wNAF context without allocating.

source§

impl<G: WnafGroup> Wnaf<(), Vec<G>, Vec<i64>>

source

pub fn base( &mut self, base: G, num_scalars: usize, ) -> Wnaf<usize, &[G], &mut Vec<i64>>

Given a base and a number of scalars, compute a window table and return a Wnaf object that can perform exponentiations with .scalar(..).

source

pub fn scalar( &mut self, scalar: &<G as Group>::Scalar, ) -> Wnaf<usize, &mut Vec<G>, &[i64]>

Given a scalar, compute its wNAF representation and return a Wnaf object that can perform exponentiations with .base(..).

source§

impl<'a, G: Group> Wnaf<usize, &'a [G], &'a mut Vec<i64>>

source

pub fn shared(&self) -> Wnaf<usize, &'a [G], Vec<i64>>

Constructs new space for the scalar representation while borrowing the computed window table, for sending the window table across threads.

source§

impl<'a, G: Group> Wnaf<usize, &'a mut Vec<G>, &'a [i64]>

source

pub fn shared(&self) -> Wnaf<usize, Vec<G>, &'a [i64]>

Constructs new space for the window table while borrowing the computed scalar representation, for sending the scalar representation across threads.

source§

impl<B, S: AsRef<[i64]>> Wnaf<usize, B, S>

source

pub fn base<G: Group>(&mut self, base: G) -> G
where B: AsMut<Vec<G>>,

Performs exponentiation given a base.

source§

impl<B, S: AsMut<Vec<i64>>> Wnaf<usize, B, S>

source

pub fn scalar<G: Group>(&mut self, scalar: &<G as Group>::Scalar) -> G
where B: AsRef<[G]>,

Performs exponentiation given a scalar.

Trait Implementations§

source§

impl<W: Debug, B: Debug, S: Debug> Debug for Wnaf<W, B, S>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<W, B, S> Freeze for Wnaf<W, B, S>
where B: Freeze, S: Freeze, W: Freeze,

§

impl<W, B, S> RefUnwindSafe for Wnaf<W, B, S>

§

impl<W, B, S> Send for Wnaf<W, B, S>
where B: Send, S: Send, W: Send,

§

impl<W, B, S> Sync for Wnaf<W, B, S>
where B: Sync, S: Sync, W: Sync,

§

impl<W, B, S> Unpin for Wnaf<W, B, S>
where B: Unpin, S: Unpin, W: Unpin,

§

impl<W, B, S> UnwindSafe for Wnaf<W, B, S>
where B: UnwindSafe, S: UnwindSafe, W: UnwindSafe,

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<T> Conv for T

source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> FmtForward for T

source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pipe for T
where T: ?Sized,

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

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>,

§

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