libff::bls12_381_G1 Class Reference

#include <bls12_381_g1.hpp>

Collaboration diagram for libff::bls12_381_G1:

Public Types
typedef bls12_381_Fq	base_field
typedef bls12_381_Fr	scalar_field

Public Member Functions
	bls12_381_G1 ()
	bls12_381_G1 (const bls12_381_Fq &X, const bls12_381_Fq &Y, const bls12_381_Fq &Z)
void	print () const
void	print_coordinates () const
void	to_affine_coordinates ()
void	to_special ()
bool	is_special () const
bool	is_zero () const
bool	operator== (const bls12_381_G1 &other) const
bool	operator!= (const bls12_381_G1 &other) const
bls12_381_G1	operator+ (const bls12_381_G1 &other) const
bls12_381_G1	operator- () const
bls12_381_G1	operator- (const bls12_381_G1 &other) const
bls12_381_G1	add (const bls12_381_G1 &other) const
bls12_381_G1	mixed_add (const bls12_381_G1 &other) const
bls12_381_G1	dbl () const
bls12_381_G1	mul_by_cofactor () const
bool	is_well_formed () const
bool	is_in_safe_subgroup () const
void	write_uncompressed (std::ostream &) const
void	write_compressed (std::ostream &) const

Static Public Member Functions
static const bls12_381_G1 &	zero ()
static const bls12_381_G1 &	one ()
static bls12_381_G1	random_element ()
static std::size_t	size_in_bits ()
static bigint< base_field::num_limbs >	base_field_char ()
static bigint< scalar_field::num_limbs >	order ()
static void	read_uncompressed (std::istream &, bls12_381_G1 &)
static void	read_compressed (std::istream &, bls12_381_G1 &)
static void	batch_to_special_all_non_zeros (std::vector< bls12_381_G1 > &vec)

Public Attributes
bls12_381_Fq	X
bls12_381_Fq	Y
bls12_381_Fq	Z

Static Public Attributes
static std::vector< std::size_t >	wnaf_window_table
static std::vector< std::size_t >	fixed_base_exp_window_table
static bls12_381_G1	G1_zero
static bls12_381_G1	G1_one
static bls12_381_Fq	coeff_a
static bls12_381_Fq	coeff_b
static const mp_size_t	h_bitcount = 126
static const mp_size_t	h_limbs
static bigint< h_limbs >	h

Detailed Description

Definition at line 21 of file bls12_381_g1.hpp.

Member Typedef Documentation

base_field

typedef bls12_381_Fq libff::bls12_381_G1::base_field

Definition at line 35 of file bls12_381_g1.hpp.

scalar_field

typedef bls12_381_Fr libff::bls12_381_G1::scalar_field

Definition at line 36 of file bls12_381_g1.hpp.

Constructor & Destructor Documentation

bls12_381_G1() [1/2]

libff::bls12_381_G1::bls12_381_G1

(

)

Definition at line 19 of file bls12_381_g1.cpp.

{
    this->X = G1_zero.X;
    this->Y = G1_zero.Y;
    this->Z = G1_zero.Z;
}

Here is the caller graph for this function:

bls12_381_G1() [2/2]

libff::bls12_381_G1::bls12_381_G1 ( const bls12_381_Fq &  X, const bls12_381_Fq &  Y, const bls12_381_Fq &  Z  )

inline

Definition at line 48 of file bls12_381_g1.hpp.

        : X(X), Y(Y), Z(Z){};

Member Function Documentation

add()

bls12_381_G1 libff::bls12_381_G1::add

(

const bls12_381_G1 &

other

)

const

Definition at line 189 of file bls12_381_g1.cpp.

{
    return (*this) + other;
}

base_field_char()

static bigint<base_field::num_limbs> libff::bls12_381_G1::base_field_char ( )

inlinestatic

Definition at line 81 of file bls12_381_g1.hpp.

    {
        return base_field::field_char();
    }

Here is the call graph for this function:

batch_to_special_all_non_zeros()

void libff::bls12_381_G1::batch_to_special_all_non_zeros ( std::vector< bls12_381_G1 > &  vec )

static

Definition at line 441 of file bls12_381_g1.cpp.

{
    std::vector<bls12_381_Fq> Z_vec;
    Z_vec.reserve(vec.size());
 
    for (auto &el : vec) {
        Z_vec.emplace_back(el.Z);
    }
    batch_invert<bls12_381_Fq>(Z_vec);
 
    const bls12_381_Fq one = bls12_381_Fq::one();
 
    for (size_t i = 0; i < vec.size(); ++i) {
        bls12_381_Fq Z2 = Z_vec[i].squared();
        bls12_381_Fq Z3 = Z_vec[i] * Z2;
 
        vec[i].X = vec[i].X * Z2;
        vec[i].Y = vec[i].Y * Z3;
        vec[i].Z = one;
    }
}

Here is the call graph for this function:

dbl()

bls12_381_G1 libff::bls12_381_G1::dbl

(

)

const

Definition at line 265 of file bls12_381_g1.cpp.

{
#ifdef PROFILE_OP_COUNTS
    this->dbl_cnt++;
#endif
    // handle point at infinity
    if (this->is_zero()) {
        return (*this);
    }
 
    // no need to handle points of order 2,4
    // (they cannot exist in a prime-order subgroup)
 
    // NOTE: does not handle O and pts of order 2,4
    // http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian-0.html#doubling-dbl-2009-l
 
    // A = X1^2
    bls12_381_Fq A = (this->X).squared();
    // B = Y1^2
    bls12_381_Fq B = (this->Y).squared();
    // C = B^2
    bls12_381_Fq C = B.squared();
    bls12_381_Fq D = (this->X + B).squared() - A - C;
    // D = 2 * ((X1 + B)^2 - A - C)
    D = D + D;
    // E = 3 * A
    bls12_381_Fq E = A + A + A;
    // F = E^2
    bls12_381_Fq F = E.squared();
    // X3 = F - 2 D
    bls12_381_Fq X3 = F - (D + D);
    bls12_381_Fq eightC = C + C;
    eightC = eightC + eightC;
    eightC = eightC + eightC;
    // Y3 = E * (D - X3) - 8 * C
    bls12_381_Fq Y3 = E * (D - X3) - eightC;
    bls12_381_Fq Y1Z1 = (this->Y) * (this->Z);
    // Z3 = 2 * Y1 * Z1
    bls12_381_Fq Z3 = Y1Z1 + Y1Z1;
 
    return bls12_381_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_in_safe_subgroup()

bool libff::bls12_381_G1::is_in_safe_subgroup

(

)

const

Definition at line 335 of file bls12_381_g1.cpp.

{
    return zero() == scalar_field::mod * (*this);
}

Here is the call graph for this function:

is_special()

bool libff::bls12_381_G1::is_special

(

)

const

Definition at line 76 of file bls12_381_g1.cpp.

{
    return (this->is_zero() || this->Z == bls12_381_Fq::one());
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_well_formed()

bool libff::bls12_381_G1::is_well_formed

(

)

const

Definition at line 313 of file bls12_381_g1.cpp.

{
    if (this->is_zero()) {
        return true;
    }
 
    // The curve equation is
    // E': y^2 = x^3 + ax + b, where a=0
    // We are using Jacobian coordinates. As such, the equation becomes:
    // y^2/z^6 = x^3/z^6 + b
    // = y^2 = x^3  + b z^6
    bls12_381_Fq X2 = this->X.squared();
    bls12_381_Fq Y2 = this->Y.squared();
    bls12_381_Fq Z2 = this->Z.squared();
 
    bls12_381_Fq X3 = this->X * X2;
    bls12_381_Fq Z3 = this->Z * Z2;
    bls12_381_Fq Z6 = Z3.squared();
 
    return (Y2 == X3 + bls12_381_coeff_b * Z6);
}

Here is the call graph for this function:

is_zero()

bool libff::bls12_381_G1::is_zero

(

)

const

Definition at line 81 of file bls12_381_g1.cpp.

{ return (this->Z.is_zero()); }

Here is the call graph for this function:

Here is the caller graph for this function:

mixed_add()

bls12_381_G1 libff::bls12_381_G1::mixed_add

(

const bls12_381_G1 &

other

)

const

Definition at line 194 of file bls12_381_g1.cpp.

{
#ifdef DEBUG
    assert(other.is_special());
#endif
 
    // handle special cases having to do with O
    if (this->is_zero()) {
        return other;
    }
 
    if (other.is_zero()) {
        return *this;
    }
 
    // no need to handle points of order 2,4
    // (they cannot exist in a prime-order subgroup)
 
    // check for doubling case
 
    // using Jacobian coordinates so:
    // (X1:Y1:Z1) = (X2:Y2:Z2)
    // iff
    // X1/Z1^2 == X2/Z2^2 and Y1/Z1^3 == Y2/Z2^3
    // iff
    // X1 * Z2^2 == X2 * Z1^2 and Y1 * Z2^3 == Y2 * Z1^3
 
    // we know that Z2 = 1
 
    const bls12_381_Fq Z1Z1 = (this->Z).squared();
    // U2 = X2*Z1Z1
    const bls12_381_Fq U2 = other.X * Z1Z1;
    // S2 = Y2 * Z1 * Z1Z1
    const bls12_381_Fq S2 = (other.Y) * ((this->Z) * Z1Z1);
 
    if (this->X == U2 && this->Y == S2) {
        // dbl case; nothing of above can be reused
        return this->dbl();
    }
 
#ifdef PROFILE_OP_COUNTS
    this->add_cnt++;
#endif
 
    // NOTE: does not handle O and pts of order 2,4
    // http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian-0.html#addition-madd-2007-bl
    // H = U2-X1
    bls12_381_Fq H = U2 - (this->X);
    // HH = H^2
    bls12_381_Fq HH = H.squared();
    // I = 4*HH
    bls12_381_Fq I = HH + HH;
    I = I + I;
    // J = H*I
    bls12_381_Fq J = H * I;
    // r = 2*(S2-Y1)
    bls12_381_Fq r = S2 - (this->Y);
    r = r + r;
    // V = X1*I
    bls12_381_Fq V = (this->X) * I;
    // X3 = r^2-J-2*V
    bls12_381_Fq X3 = r.squared() - J - V - V;
    // Y3 = r*(V-X3)-2*Y1*J
    bls12_381_Fq Y3 = (this->Y) * J;
    Y3 = r * (V - X3) - Y3 - Y3;
    // Z3 = (Z1+H)^2-Z1Z1-HH
    bls12_381_Fq Z3 = ((this->Z) + H).squared() - Z1Z1 - HH;
 
    return bls12_381_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

mul_by_cofactor()

bls12_381_G1 libff::bls12_381_G1::mul_by_cofactor

(

)

const

Definition at line 308 of file bls12_381_g1.cpp.

{
    return bls12_381_G1::h * (*this);
}

one()

const bls12_381_G1 & libff::bls12_381_G1::one ( )

static

Definition at line 342 of file bls12_381_g1.cpp.

{ return G1_one; }

Here is the caller graph for this function:

operator!=()

bool libff::bls12_381_G1::operator!=

(

const bls12_381_G1 &

other

)

const

Definition at line 111 of file bls12_381_g1.cpp.

{
    return !(operator==(other));
}

Here is the call graph for this function:

operator+()

bls12_381_G1 libff::bls12_381_G1::operator+

(

const bls12_381_G1 &

other

)

const

Definition at line 116 of file bls12_381_g1.cpp.

{
    // handle special cases having to do with O
    if (this->is_zero()) {
        return other;
    }
 
    if (other.is_zero()) {
        return *this;
    }
 
    // http://www.hyperelliptic.org/EFD/g1p/auto-shortw-jacobian-0.html#addition-add-2007-bl
    // no need to handle points of order 2,4
    // (they cannot exist in a prime-order subgroup)
 
    // check for doubling case
 
    // using Jacobian coordinates so:
    // (X1:Y1:Z1) = (X2:Y2:Z2)
    // iff
    // X1/Z1^2 == X2/Z2^2 and Y1/Z1^3 == Y2/Z2^3
    // iff
    // X1 * Z2^2 == X2 * Z1^2 and Y1 * Z2^3 == Y2 * Z1^3
 
    bls12_381_Fq Z1Z1 = (this->Z).squared();
    bls12_381_Fq Z2Z2 = (other.Z).squared();
 
    bls12_381_Fq U1 = this->X * Z2Z2;
    bls12_381_Fq U2 = other.X * Z1Z1;
 
    // S1 = Y1 * Z2 * Z2Z2
    bls12_381_Fq S1 = (this->Y) * ((other.Z) * Z2Z2);
    // S2 = Y2 * Z1 * Z1Z1
    bls12_381_Fq S2 = (other.Y) * ((this->Z) * Z1Z1);
 
    if (U1 == U2 && S1 == S2) {
        // dbl case; nothing of above can be reused
        return this->dbl();
    }
 
    // rest of add case
    // H = U2-U1
    bls12_381_Fq H = U2 - U1;
    // I = (2 * H)^2
    bls12_381_Fq I = (H + H).squared();
    // J = H * I
    bls12_381_Fq J = H * I;
    // r = 2 * (S2-S1)
    bls12_381_Fq S2_minus_S1 = S2 - S1;
    bls12_381_Fq r = S2_minus_S1 + S2_minus_S1;
    // V = U1 * I
    bls12_381_Fq V = U1 * I;
    // X3 = r^2 - J - 2 * V
    bls12_381_Fq X3 = r.squared() - J - (V + V);
    bls12_381_Fq S1_J = S1 * J;
    // Y3 = r * (V-X3)-2 S1 J
    bls12_381_Fq Y3 = r * (V - X3) - (S1_J + S1_J);
    // Z3 = ((Z1+Z2)^2-Z1Z1-Z2Z2) * H
    bls12_381_Fq Z3 = ((this->Z + other.Z).squared() - Z1Z1 - Z2Z2) * H;
 
    return bls12_381_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

operator-() [1/2]

bls12_381_G1 libff::bls12_381_G1::operator-

(

)

const

Definition at line 179 of file bls12_381_g1.cpp.

{
    return bls12_381_G1(this->X, -(this->Y), this->Z);
}

Here is the call graph for this function:

operator-() [2/2]

bls12_381_G1 libff::bls12_381_G1::operator-

(

const bls12_381_G1 &

other

)

const

Definition at line 184 of file bls12_381_g1.cpp.

{
    return (*this) + (-other);
}

operator==()

bool libff::bls12_381_G1::operator==

(

const bls12_381_G1 &

other

)

const

Definition at line 83 of file bls12_381_g1.cpp.

{
    if (this->is_zero()) {
        return other.is_zero();
    }
 
    if (other.is_zero()) {
        return false;
    }
 
    /* now neither is O */
 
    // Using Jacobian coordinates so:
    //   (X1:Y1:Z1) = (X2:Y2:Z2) <=>
    //   X1/Z1^2 == X2/Z2^2 AND Y1/Z1^3 == Y2/Z2^3 <=>
    //   X1 * Z2^2 == X2 * Z1^2 and Y1 * Z2^3 == Y2 * Z1^3
    bls12_381_Fq Z1_squared = (this->Z).squared();
    bls12_381_Fq Z2_squared = (other.Z).squared();
    bls12_381_Fq Z1_cubed = (this->Z) * Z1_squared;
    bls12_381_Fq Z2_cubed = (other.Z) * Z2_squared;
    if (((this->X * Z2_squared) != (other.X * Z1_squared)) ||
        ((this->Y * Z2_cubed) != (other.Y * Z1_cubed))) {
        return false;
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

order()

static bigint<scalar_field::num_limbs> libff::bls12_381_G1::order ( )

inlinestatic

Definition at line 85 of file bls12_381_g1.hpp.

    {
        return scalar_field::field_char();
    }

Here is the call graph for this function:

print()

void libff::bls12_381_G1::print

(

)

const

Definition at line 26 of file bls12_381_g1.cpp.

{
    if (this->is_zero()) {
        printf("O\n");
    } else {
        bls12_381_G1 copy(*this);
        copy.to_affine_coordinates();
        gmp_printf(
            "(%Nd , %Nd)\n",
            copy.X.as_bigint().data,
            bls12_381_Fq::num_limbs,
            copy.Y.as_bigint().data,
            bls12_381_Fq::num_limbs);
    }
}

Here is the call graph for this function:

print_coordinates()

void libff::bls12_381_G1::print_coordinates

(

)

const

Definition at line 42 of file bls12_381_g1.cpp.

{
    if (this->is_zero()) {
        printf("O\n");
    } else {
        gmp_printf(
            "(%Nd : %Nd : %Nd)\n",
            this->X.as_bigint().data,
            bls12_381_Fq::num_limbs,
            this->Y.as_bigint().data,
            bls12_381_Fq::num_limbs,
            this->Z.as_bigint().data,
            bls12_381_Fq::num_limbs);
    }
}

Here is the call graph for this function:

random_element()

bls12_381_G1 libff::bls12_381_G1::random_element ( )

static

Definition at line 344 of file bls12_381_g1.cpp.

{
    return (scalar_field::random_element().as_bigint()) * G1_one;
}

Here is the call graph for this function:

read_compressed()

void libff::bls12_381_G1::read_compressed ( std::istream &  in, bls12_381_G1 &  g  )

static

Definition at line 384 of file bls12_381_g1.cpp.

{
    char is_zero;
    bls12_381_Fq tX, tY;
 
    // this reads is_zero;
    in.read((char *)&is_zero, 1);
    is_zero -= '0';
    consume_OUTPUT_SEPARATOR(in);
 
    unsigned char Y_lsb;
    in >> tX;
    consume_OUTPUT_SEPARATOR(in);
    in.read((char *)&Y_lsb, 1);
    Y_lsb -= '0';
 
    // y = +/- sqrt(x^3 + b)
    if (!is_zero) {
        bls12_381_Fq tX2 = tX.squared();
        bls12_381_Fq tY2 = tX2 * tX + bls12_381_coeff_b;
        tY = tY2.sqrt();
 
        if ((tY.as_bigint().data[0] & 1) != Y_lsb) {
            tY = -tY;
        }
    }
 
    // using Jacobian coordinates
    if (!is_zero) {
        g.X = tX;
        g.Y = tY;
        g.Z = bls12_381_Fq::one();
    } else {
        g = bls12_381_G1::zero();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

read_uncompressed()

void libff::bls12_381_G1::read_uncompressed ( std::istream &  in, bls12_381_G1 &  g  )

static

Definition at line 366 of file bls12_381_g1.cpp.

{
    char is_zero;
    bls12_381_Fq tX, tY;
 
    in >> is_zero >> tX >> tY;
    is_zero -= '0';
 
    // using Jacobian coordinates
    if (!is_zero) {
        g.X = tX;
        g.Y = tY;
        g.Z = bls12_381_Fq::one();
    } else {
        g = bls12_381_G1::zero();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

size_in_bits()

static std::size_t libff::bls12_381_G1::size_in_bits ( )

inlinestatic

Definition at line 80 of file bls12_381_g1.hpp.

{ return base_field::size_in_bits() + 1; }

Here is the call graph for this function:

to_affine_coordinates()

void libff::bls12_381_G1::to_affine_coordinates

(

)

Definition at line 58 of file bls12_381_g1.cpp.

{
    if (this->is_zero()) {
        this->X = bls12_381_Fq::zero();
        this->Y = bls12_381_Fq::one();
        this->Z = bls12_381_Fq::zero();
    } else {
        bls12_381_Fq Z_inv = Z.inverse();
        bls12_381_Fq Z2_inv = Z_inv.squared();
        bls12_381_Fq Z3_inv = Z2_inv * Z_inv;
        this->X = this->X * Z2_inv;
        this->Y = this->Y * Z3_inv;
        this->Z = bls12_381_Fq::one();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

to_special()

void libff::bls12_381_G1::to_special

(

)

Definition at line 74 of file bls12_381_g1.cpp.

{ this->to_affine_coordinates(); }

Here is the call graph for this function:

write_compressed()

void libff::bls12_381_G1::write_compressed

(

std::ostream &

out

)

const

Definition at line 357 of file bls12_381_g1.cpp.

{
    bls12_381_G1 copy(*this);
    copy.to_affine_coordinates();
    out << (copy.is_zero() ? 1 : 0) << OUTPUT_SEPARATOR;
    /* storing LSB of Y */
    out << copy.X << OUTPUT_SEPARATOR << (copy.Y.as_bigint().data[0] & 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_uncompressed()

void libff::bls12_381_G1::write_uncompressed

(

std::ostream &

out

)

const

Definition at line 349 of file bls12_381_g1.cpp.

{
    bls12_381_G1 copy(*this);
    copy.to_affine_coordinates();
    out << (copy.is_zero() ? 1 : 0) << OUTPUT_SEPARATOR;
    out << copy.X << OUTPUT_SEPARATOR << copy.Y;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zero()

const bls12_381_G1 & libff::bls12_381_G1::zero ( )

static

Definition at line 340 of file bls12_381_g1.cpp.

{ return G1_zero; }

Here is the caller graph for this function:

Member Data Documentation

coeff_a

bls12_381_Fq libff::bls12_381_G1::coeff_a

static

Definition at line 32 of file bls12_381_g1.hpp.

coeff_b

bls12_381_Fq libff::bls12_381_G1::coeff_b

static

Definition at line 33 of file bls12_381_g1.hpp.

fixed_base_exp_window_table

std::vector< size_t > libff::bls12_381_G1::fixed_base_exp_window_table

static

Definition at line 29 of file bls12_381_g1.hpp.

G1_one

bls12_381_G1 libff::bls12_381_G1::G1_one

static

Definition at line 31 of file bls12_381_g1.hpp.

G1_zero

bls12_381_G1 libff::bls12_381_G1::G1_zero

static

Definition at line 30 of file bls12_381_g1.hpp.

h

bigint< bls12_381_G1::h_limbs > libff::bls12_381_G1::h

static

Definition at line 42 of file bls12_381_g1.hpp.

h_bitcount

const mp_size_t libff::bls12_381_G1::h_bitcount = 126

static

Definition at line 39 of file bls12_381_g1.hpp.

h_limbs

const mp_size_t libff::bls12_381_G1::h_limbs

static

Initial value:

=
        (h_bitcount + GMP_NUMB_BITS - 1) / GMP_NUMB_BITS

Definition at line 40 of file bls12_381_g1.hpp.

wnaf_window_table

std::vector< size_t > libff::bls12_381_G1::wnaf_window_table

static

Definition at line 28 of file bls12_381_g1.hpp.

X

bls12_381_Fq libff::bls12_381_G1::X

Definition at line 44 of file bls12_381_g1.hpp.

Y

bls12_381_Fq libff::bls12_381_G1::Y

Definition at line 44 of file bls12_381_g1.hpp.

Z

bls12_381_Fq libff::bls12_381_G1::Z

Definition at line 44 of file bls12_381_g1.hpp.

---

The documentation for this class was generated from the following files:

• /home/runner/work/libff/libff/libff/algebra/curves/bls12_381/bls12_381_g1.hpp
• /home/runner/work/libff/libff/libff/algebra/curves/bls12_381/bls12_381_g1.cpp