Struct dusk_jubjub::JubJubExtended

pub struct JubJubExtended { /* fields omitted */ }

This represents an extended point (X, Y, Z, T1, T2) with Z nonzero, corresponding to the affine point (X/Z, Y/Z). We always have T1 * T2 = XY/Z.

You can do the following things with a point in this form:

• Convert it into a point in the affine form.
• Add it to an JubJubExtended, AffineNielsPoint or ExtendedNielsPoint.
• Double it using double().
• Compare it with another extended point using PartialEq or ct_eq().

Implementations

impl JubJubExtended

pub fn get_x(&self) -> BlsScalar

Returns the x-coordinate of this point.

pub fn get_y(&self) -> BlsScalar

Returns the y-coordinate of this point.

pub fn get_z(&self) -> BlsScalar

Returns the z-coordinate of this point.

pub fn get_t1(&self) -> BlsScalar

Returns the t1-coordinate of this point.

pub fn get_t2(&self) -> BlsScalar

Returns the t2-coordinate of this point.

pub const fn identity() -> Self

Constructs an extended point from the neutral element (0, 1).

pub fn is_identity(&self) -> Choice

Determines if this point is the identity.

pub fn is_small_order(&self) -> Choice

Determines if this point is of small order.

pub fn is_torsion_free(&self) -> Choice

Determines if this point is torsion free and so is contained in the prime order subgroup.

pub fn is_prime_order(&self) -> Choice

Determines if this point is prime order, or in other words that the smallest scalar multiplied by this point that produces the identity is r. This is equivalent to checking that the point is both torsion free and not the identity.

pub fn mul_by_cofactor(&self) -> JubJubExtended

Multiplies this element by the cofactor 8.

pub fn to_niels(&self) -> ExtendedNielsPoint

Performs a pre-processing step that produces an ExtendedNielsPoint for use in multiple additions.

pub fn to_hash_inputs(&self) -> [BlsScalar; 2]

Returns two scalars suitable for hashing that represent the Extended Point.

pub fn double(&self) -> JubJubExtended

Computes the doubling of a point more efficiently than a point can be added to itself.

Trait Implementations

impl<'a, 'b> Add<&'b AffineNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b AffineNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b AffineNielsPoint) -> JubJubExtended

Performs the + operation.

impl<'a, 'b> Add<&'b ExtendedNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b ExtendedNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b ExtendedNielsPoint) -> JubJubExtended

Performs the + operation.

impl<'a, 'b> Add<&'b JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b JubJubAffine) -> JubJubExtended

Performs the + operation.

impl<'a, 'b> Add<&'b JubJubExtended> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b JubJubExtended) -> JubJubExtended

Performs the + operation.

impl<'a> Add<AffineNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: AffineNielsPoint) -> JubJubExtended

Performs the + operation.

impl Add<AffineNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: AffineNielsPoint) -> JubJubExtended

Performs the + operation.

impl<'a> Add<ExtendedNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: ExtendedNielsPoint) -> JubJubExtended

Performs the + operation.

impl Add<ExtendedNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: ExtendedNielsPoint) -> JubJubExtended

Performs the + operation.

impl<'a> Add<JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubJubAffine) -> JubJubExtended

Performs the + operation.

impl Add<JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubJubAffine) -> JubJubExtended

Performs the + operation.

impl<'a> Add<JubJubExtended> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubJubExtended) -> JubJubExtended

Performs the + operation.

impl Add<JubJubExtended> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubJubExtended) -> JubJubExtended

Performs the + operation.

impl<'b> AddAssign<&'b AffineNielsPoint> for JubJubExtended

fn add_assign(&mut self, rhs: &'b AffineNielsPoint)

Performs the += operation.

impl<'b> AddAssign<&'b ExtendedNielsPoint> for JubJubExtended

fn add_assign(&mut self, rhs: &'b ExtendedNielsPoint)

Performs the += operation.

impl<'b> AddAssign<&'b JubJubAffine> for JubJubExtended

fn add_assign(&mut self, rhs: &'b JubJubAffine)

Performs the += operation.

impl<'b> AddAssign<&'b JubJubExtended> for JubJubExtended

fn add_assign(&mut self, rhs: &'b JubJubExtended)

Performs the += operation.

impl AddAssign<AffineNielsPoint> for JubJubExtended

fn add_assign(&mut self, rhs: AffineNielsPoint)

Performs the += operation.

impl AddAssign<ExtendedNielsPoint> for JubJubExtended

fn add_assign(&mut self, rhs: ExtendedNielsPoint)

Performs the += operation.

impl AddAssign<JubJubAffine> for JubJubExtended

fn add_assign(&mut self, rhs: JubJubAffine)

Performs the += operation.

impl AddAssign<JubJubExtended> for JubJubExtended

fn add_assign(&mut self, rhs: JubJubExtended)

Performs the += operation.

impl Clone for JubJubExtended

fn clone(&self) -> JubJubExtended

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for JubJubExtended

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl ConstantTimeEq for JubJubExtended

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

impl Debug for JubJubExtended

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

Formats the value using the given formatter.

impl Default for JubJubExtended

fn default() -> JubJubExtended

Returns the identity.

impl<'a> From<&'a JubJubExtended> for JubJubAffine

fn from(extended: &'a JubJubExtended) -> JubJubAffine

Constructs an affine point from an extended point using the map (X, Y, Z, T1, T2) => (XZ, Y/Z) as Z is always nonzero. This requires a field inversion and so it is recommended to perform these in a batch using batch_normalize instead.

impl From<JubJubAffine> for JubJubExtended

fn from(affine: JubJubAffine) -> JubJubExtended

Constructs an extended point (with Z = 1) from an affine point using the map (x, y) => (x, y, 1, x, y).

impl From<JubJubExtended> for JubJubAffine

fn from(extended: JubJubExtended) -> JubJubAffine

Performs the conversion.

impl<'a, 'b> Mul<&'b Fr> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> JubJubExtended

Performs the * operation.

impl<'b> Mul<&'b Fr> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fr) -> JubJubExtended

Performs the * operation.

impl<'a> Mul<Fr> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> JubJubExtended

Performs the * operation.

impl Mul<Fr> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> JubJubExtended

Performs the * operation.

impl<'b> MulAssign<&'b Fr> for JubJubExtended

fn mul_assign(&mut self, rhs: &'b Fr)

Performs the *= operation.

impl MulAssign<Fr> for JubJubExtended

fn mul_assign(&mut self, rhs: Fr)

Performs the *= operation.

impl Neg for JubJubExtended

fn neg(self) -> JubJubExtended

Computes the negation of a point P = (X, Y, Z, T) as -P = (-X, Y, Z, -T1, T2). The choice of T1 is made without loss of generality.

type Output = JubJubExtended

The resulting type after applying the - operator.

impl PartialEq<JubJubExtended> for JubJubExtended

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> Sub<&'b AffineNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b AffineNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b AffineNielsPoint) -> JubJubExtended

Performs the - operation.

impl<'a, 'b> Sub<&'b ExtendedNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b ExtendedNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b ExtendedNielsPoint) -> JubJubExtended

Performs the - operation.

impl<'a, 'b> Sub<&'b JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b JubJubAffine) -> JubJubExtended

Performs the - operation.

impl<'a, 'b> Sub<&'b JubJubExtended> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b JubJubExtended) -> JubJubExtended

Performs the - operation.

impl<'a> Sub<AffineNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: AffineNielsPoint) -> JubJubExtended

Performs the - operation.

impl Sub<AffineNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: AffineNielsPoint) -> JubJubExtended

Performs the - operation.

impl<'a> Sub<ExtendedNielsPoint> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: ExtendedNielsPoint) -> JubJubExtended

Performs the - operation.

impl Sub<ExtendedNielsPoint> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: ExtendedNielsPoint) -> JubJubExtended

Performs the - operation.

impl<'a> Sub<JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubJubAffine) -> JubJubExtended

Performs the - operation.

impl Sub<JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubJubAffine) -> JubJubExtended

Performs the - operation.

impl<'a> Sub<JubJubExtended> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubJubExtended) -> JubJubExtended

Performs the - operation.

impl Sub<JubJubExtended> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubJubExtended) -> JubJubExtended

Performs the - operation.

impl<'b> SubAssign<&'b AffineNielsPoint> for JubJubExtended

fn sub_assign(&mut self, rhs: &'b AffineNielsPoint)

Performs the -= operation.

impl<'b> SubAssign<&'b ExtendedNielsPoint> for JubJubExtended

fn sub_assign(&mut self, rhs: &'b ExtendedNielsPoint)

Performs the -= operation.

impl<'b> SubAssign<&'b JubJubAffine> for JubJubExtended

fn sub_assign(&mut self, rhs: &'b JubJubAffine)

Performs the -= operation.

impl<'b> SubAssign<&'b JubJubExtended> for JubJubExtended

fn sub_assign(&mut self, rhs: &'b JubJubExtended)

Performs the -= operation.

impl SubAssign<AffineNielsPoint> for JubJubExtended

fn sub_assign(&mut self, rhs: AffineNielsPoint)

Performs the -= operation.

impl SubAssign<ExtendedNielsPoint> for JubJubExtended

fn sub_assign(&mut self, rhs: ExtendedNielsPoint)

Performs the -= operation.

impl SubAssign<JubJubAffine> for JubJubExtended

fn sub_assign(&mut self, rhs: JubJubAffine)

Performs the -= operation.

impl SubAssign<JubJubExtended> for JubJubExtended

fn sub_assign(&mut self, rhs: JubJubExtended)

Performs the -= operation.

impl Copy for JubJubExtended