libff::mnt4_G1 Class Reference

#include <mnt4_g1.hpp>

Collaboration diagram for libff::mnt4_G1:

Public Types
typedef mnt4_Fq	base_field
typedef mnt4_Fr	scalar_field

Public Member Functions
	mnt4_G1 ()
	mnt4_G1 (const mnt4_Fq &X, const mnt4_Fq &Y)
	mnt4_G1 (const mnt4_Fq &X, const mnt4_Fq &Y, const mnt4_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 mnt4_G1 &other) const
bool	operator!= (const mnt4_G1 &other) const
mnt4_G1	operator+ (const mnt4_G1 &other) const
mnt4_G1	operator- () const
mnt4_G1	operator- (const mnt4_G1 &other) const
mnt4_G1	add (const mnt4_G1 &other) const
mnt4_G1	mixed_add (const mnt4_G1 &other) const
mnt4_G1	dbl () const
bool	is_well_formed () const

Static Public Member Functions
static mnt4_G1	zero ()
static mnt4_G1	one ()
static mnt4_G1	random_element ()
static size_t	size_in_bits ()
static bigint< mnt4_Fq::num_limbs >	base_field_char ()
static bigint< mnt4_Fr::num_limbs >	order ()
static void	batch_to_special_all_non_zeros (std::vector< mnt4_G1 > &vec)

Public Attributes
mnt4_Fq	X
mnt4_Fq	Y
mnt4_Fq	Z

Static Public Attributes
static std::vector< size_t >	wnaf_window_table
static std::vector< size_t >	fixed_base_exp_window_table
static mnt4_G1	G1_zero = {}
static mnt4_G1	G1_one = {}
static bool	initialized = false
static mnt4_Fq	coeff_a
static mnt4_Fq	coeff_b

Friends
std::ostream &	operator<< (std::ostream &out, const mnt4_G1 &g)
std::istream &	operator>> (std::istream &in, mnt4_G1 &g)

Detailed Description

Definition at line 26 of file mnt4_g1.hpp.

Member Typedef Documentation

base_field

mnt4_Fq libff::mnt4_G1::base_field

Definition at line 40 of file mnt4_g1.hpp.

scalar_field

mnt4_Fr libff::mnt4_G1::scalar_field

Definition at line 41 of file mnt4_g1.hpp.

Constructor & Destructor Documentation

mnt4_G1() [1/3]

libff::mnt4_G1::mnt4_G1

(

)

Definition at line 31 of file mnt4_g1.cpp.

{
    if (mnt4_G1::initialized)
    {
        this->X = G1_zero.X;
        this->Y = G1_zero.Y;
        this->Z = G1_zero.Z;
    }
}

Here is the caller graph for this function:

mnt4_G1() [2/3]

libff::mnt4_G1::mnt4_G1 ( const mnt4_Fq & X, const mnt4_Fq & Y )

inline

Definition at line 47 of file mnt4_g1.hpp.

: X(X), Y(Y), Z(base_field::one()) {}

mnt4_G1() [3/3]

libff::mnt4_G1::mnt4_G1 ( const mnt4_Fq & X, const mnt4_Fq & Y, const mnt4_Fq & Z )

inline

Definition at line 48 of file mnt4_g1.hpp.

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

Member Function Documentation

add()

mnt4_G1 libff::mnt4_G1::add

(

const mnt4_G1 &

other

)

const

Definition at line 224 of file mnt4_g1.cpp.

{
    // 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)
 
    // handle double case
    if (this->operator==(other))
    {
        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-projective.html#addition-add-1998-cmo-2
 
    const mnt4_Fq Y1Z2 = (this->Y) * (other.Z);        // Y1Z2 = Y1*Z2
    const mnt4_Fq X1Z2 = (this->X) * (other.Z);        // X1Z2 = X1*Z2
    const mnt4_Fq Z1Z2 = (this->Z) * (other.Z);        // Z1Z2 = Z1*Z2
    const mnt4_Fq u    = (other.Y) * (this->Z) - Y1Z2; // u    = Y2*Z1-Y1Z2
    const mnt4_Fq uu   = u.squared();                    // uu   = u^2
    const mnt4_Fq v    = (other.X) * (this->Z) - X1Z2; // v    = X2*Z1-X1Z2
    const mnt4_Fq vv   = v.squared();                    // vv   = v^2
    const mnt4_Fq vvv  = v * vv;                         // vvv  = v*vv
    const mnt4_Fq R    = vv * X1Z2;                      // R    = vv*X1Z2
    const mnt4_Fq A    = uu * Z1Z2 - (vvv + R + R);      // A    = uu*Z1Z2 - vvv - 2*R
    const mnt4_Fq X3   = v * A;                          // X3   = v*A
    const mnt4_Fq Y3   = u * (R-A) - vvv * Y1Z2;         // Y3   = u*(R-A) - vvv*Y1Z2
    const mnt4_Fq Z3   = vvv * Z1Z2;                     // Z3   = vvv*Z1Z2
 
    return mnt4_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

base_field_char()

static bigint< mnt4_Fq::num_limbs > libff::mnt4_G1::base_field_char ( )

inlinestatic

Definition at line 77 of file mnt4_g1.hpp.

{ return mnt4_Fq::field_char(); }

Here is the call graph for this function:

batch_to_special_all_non_zeros()

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

static

Definition at line 489 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

dbl()

mnt4_G1 libff::mnt4_G1::dbl

(

)

const

Definition at line 319 of file mnt4_g1.cpp.

{
#ifdef PROFILE_OP_COUNTS
    this->dbl_cnt++;
#endif
    if (this->is_zero())
    {
        return (*this);
    }
    else
    {
        // NOTE: does not handle O and pts of order 2,4
        // http://www.hyperelliptic.org/EFD/g1p/auto-shortw-projective.html#doubling-dbl-2007-bl
 
        const mnt4_Fq XX   = (this->X).squared();                   // XX  = X1^2
        const mnt4_Fq ZZ   = (this->Z).squared();                   // ZZ  = Z1^2
        const mnt4_Fq w    = mnt4_G1::coeff_a * ZZ + (XX + XX + XX); // w   = a*ZZ + 3*XX
        const mnt4_Fq Y1Z1 = (this->Y) * (this->Z);
        const mnt4_Fq s    = Y1Z1 + Y1Z1;                            // s   = 2*Y1*Z1
        const mnt4_Fq ss   = s.squared();                            // ss  = s^2
        const mnt4_Fq sss  = s * ss;                                 // sss = s*ss
        const mnt4_Fq R    = (this->Y) * s;                         // R   = Y1*s
        const mnt4_Fq RR   = R.squared();                            // RR  = R^2
        const mnt4_Fq B    = ((this->X)+R).squared()-XX-RR;         // B   = (X1+R)^2 - XX - RR
        const mnt4_Fq h    = w.squared() - (B+B);                    // h   = w^2 - 2*B
        const mnt4_Fq X3   = h * s;                                  // X3  = h*s
        const mnt4_Fq Y3   = w * (B-h)-(RR+RR);                      // Y3  = w*(B-h) - 2*RR
        const mnt4_Fq Z3   = sss;                                    // Z3  = sss
 
        return mnt4_G1(X3, Y3, Z3);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_special()

bool libff::mnt4_G1::is_special

(

)

const

Definition at line 94 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

is_well_formed()

bool libff::mnt4_G1::is_well_formed

(

)

const

Definition at line 352 of file mnt4_g1.cpp.

{
    if (this->is_zero())
    {
        return true;
    }
    else
    {
        /*
          y^2 = x^3 + ax + b
 
          We are using projective, so equation we need to check is actually
 
          (y/z)^2 = (x/z)^3 + a (x/z) + b
          z y^2 = x^3  + a z^2 x + b z^3
 
          z (y^2 - b z^2) = x ( x^2 + a z^2)
        */
        const mnt4_Fq X2 = this->X.squared();
        const mnt4_Fq Y2 = this->Y.squared();
        const mnt4_Fq Z2 = this->Z.squared();
 
        return (this->Z * (Y2 - mnt4_G1::coeff_b * Z2) == this->X * (X2 + mnt4_G1::coeff_a * Z2));
    }
}

Here is the call graph for this function:

is_zero()

bool libff::mnt4_G1::is_zero

(

)

const

Definition at line 99 of file mnt4_g1.cpp.

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

Here is the caller graph for this function:

mixed_add()

mnt4_G1 libff::mnt4_G1::mixed_add

(

const mnt4_G1 &

other

)

const

Definition at line 269 of file mnt4_g1.cpp.

{
#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-projective.html#addition-add-1998-cmo-2
    //assert(other.Z == mnt4_Fq::one());
 
    if (this->is_zero())
    {
        return other;
    }
 
    if (other.is_zero())
    {
        return (*this);
    }
 
#ifdef DEBUG
    assert(other.is_special());
#endif
 
    const mnt4_Fq &X1Z2 = (this->X);                    // X1Z2 = X1*Z2 (but other is special and not zero)
    const mnt4_Fq X2Z1 = (this->Z) * (other.X);        // X2Z1 = X2*Z1
 
    // (used both in add and double checks)
 
    const mnt4_Fq &Y1Z2 = (this->Y);                    // Y1Z2 = Y1*Z2 (but other is special and not zero)
    const mnt4_Fq Y2Z1 = (this->Z) * (other.Y);        // Y2Z1 = Y2*Z1
 
    if (X1Z2 == X2Z1 && Y1Z2 == Y2Z1)
    {
        return this->dbl();
    }
 
    const mnt4_Fq u = Y2Z1 - this->Y;              // u = Y2*Z1-Y1
    const mnt4_Fq uu = u.squared();                 // uu = u2
    const mnt4_Fq v = X2Z1 - this->X;              // v = X2*Z1-X1
    const mnt4_Fq vv = v.squared();                 // vv = v2
    const mnt4_Fq vvv = v*vv;                       // vvv = v*vv
    const mnt4_Fq R = vv * this->X;                // R = vv*X1
    const mnt4_Fq A = uu * this->Z - vvv - R - R;  // A = uu*Z1-vvv-2*R
    const mnt4_Fq X3 = v * A;                       // X3 = v*A
    const mnt4_Fq Y3 = u*(R-A) - vvv * this->Y;    // Y3 = u*(R-A)-vvv*Y1
    const mnt4_Fq Z3 = vvv * this->Z;              // Z3 = vvv*Z1
 
    return mnt4_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

one()

mnt4_G1 libff::mnt4_G1::one ( )

static

Definition at line 383 of file mnt4_g1.cpp.

{
    return G1_one;
}

Here is the caller graph for this function:

operator!=()

bool libff::mnt4_G1::operator!=

(

const mnt4_G1 &

other

)

const

Definition at line 133 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

operator+()

mnt4_G1 libff::mnt4_G1::operator+

(

const mnt4_G1 &

other

)

const

Definition at line 138 of file mnt4_g1.cpp.

{
    // 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)
 
    // handle double case, and then all the rest
    /*
      The code below is equivalent to (but faster than) the snippet below:
 
      if (this->operator==(other))
      {
      return this->dbl();
      }
      else
      {
      return this->add(other);
      }
    */
 
    const mnt4_Fq X1Z2 = (this->X) * (other.Z);        // X1Z2 = X1*Z2
    const mnt4_Fq X2Z1 = (this->Z) * (other.X);        // X2Z1 = X2*Z1
 
    // (used both in add and double checks)
 
    const mnt4_Fq Y1Z2 = (this->Y) * (other.Z);        // Y1Z2 = Y1*Z2
    const mnt4_Fq Y2Z1 = (this->Z) * (other.Y);        // Y2Z1 = Y2*Z1
 
    if (X1Z2 == X2Z1 && Y1Z2 == Y2Z1)
    {
        // perform dbl case
        const mnt4_Fq XX   = (this->X).squared();                   // XX  = X1^2
        const mnt4_Fq ZZ   = (this->Z).squared();                   // ZZ  = Z1^2
        const mnt4_Fq w    = mnt4_G1::coeff_a * ZZ + (XX + XX + XX); // w   = a*ZZ + 3*XX
        const mnt4_Fq Y1Z1 = (this->Y) * (this->Z);
        const mnt4_Fq s    = Y1Z1 + Y1Z1;                            // s   = 2*Y1*Z1
        const mnt4_Fq ss   = s.squared();                            // ss  = s^2
        const mnt4_Fq sss  = s * ss;                                 // sss = s*ss
        const mnt4_Fq R    = (this->Y) * s;                         // R   = Y1*s
        const mnt4_Fq RR   = R.squared();                            // RR  = R^2
        const mnt4_Fq B    = ((this->X)+R).squared()-XX-RR;         // B   = (X1+R)^2 - XX - RR
        const mnt4_Fq h    = w.squared() - (B+B);                    // h   = w^2 - 2*B
        const mnt4_Fq X3   = h * s;                                  // X3  = h*s
        const mnt4_Fq Y3   = w * (B-h)-(RR+RR);                      // Y3  = w*(B-h) - 2*RR
        const mnt4_Fq Z3   = sss;                                    // Z3  = sss
 
        return mnt4_G1(X3, Y3, Z3);
    }
 
    // if we have arrived here we are in the add case
    const mnt4_Fq Z1Z2 = (this->Z) * (other.Z);        // Z1Z2 = Z1*Z2
    const mnt4_Fq u    = Y2Z1 - Y1Z2; // u    = Y2*Z1-Y1Z2
    const mnt4_Fq uu   = u.squared();                  // uu   = u^2
    const mnt4_Fq v    = X2Z1 - X1Z2; // v    = X2*Z1-X1Z2
    const mnt4_Fq vv   = v.squared();                  // vv   = v^2
    const mnt4_Fq vvv  = v * vv;                       // vvv  = v*vv
    const mnt4_Fq R    = vv * X1Z2;                    // R    = vv*X1Z2
    const mnt4_Fq A    = uu * Z1Z2 - (vvv + R + R);    // A    = uu*Z1Z2 - vvv - 2*R
    const mnt4_Fq X3   = v * A;                        // X3   = v*A
    const mnt4_Fq Y3   = u * (R-A) - vvv * Y1Z2;       // Y3   = u*(R-A) - vvv*Y1Z2
    const mnt4_Fq Z3   = vvv * Z1Z2;                   // Z3   = vvv*Z1Z2
 
    return mnt4_G1(X3, Y3, Z3);
}

Here is the call graph for this function:

operator-() [1/2]

mnt4_G1 libff::mnt4_G1::operator-

(

)

const

Definition at line 213 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

operator-() [2/2]

mnt4_G1 libff::mnt4_G1::operator-

(

const mnt4_G1 &

other

)

const

Definition at line 219 of file mnt4_g1.cpp.

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

operator==()

bool libff::mnt4_G1::operator==

(

const mnt4_G1 &

other

)

const

Definition at line 104 of file mnt4_g1.cpp.

{
    if (this->is_zero())
    {
        return other.is_zero();
    }
 
    if (other.is_zero())
    {
        return false;
    }
 
    /* now neither is O */
 
    // X1/Z1 = X2/Z2 <=> X1*Z2 = X2*Z1
    if ((this->X * other.Z) != (other.X * this->Z))
    {
        return false;
    }
 
    // Y1/Z1 = Y2/Z2 <=> Y1*Z2 = Y2*Z1
    if ((this->Y * other.Z) != (other.Y * this->Z))
    {
        return false;
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

order()

static bigint< mnt4_Fr::num_limbs > libff::mnt4_G1::order ( )

inlinestatic

Definition at line 78 of file mnt4_g1.hpp.

{ return mnt4_Fr::field_char(); }

Here is the call graph for this function:

print()

void libff::mnt4_G1::print

(

)

const

Definition at line 41 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

print_coordinates()

void libff::mnt4_G1::print_coordinates

(

)

const

Definition at line 57 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

random_element()

mnt4_G1 libff::mnt4_G1::random_element ( )

static

Definition at line 388 of file mnt4_g1.cpp.

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

Here is the call graph for this function:

size_in_bits()

static size_t libff::mnt4_G1::size_in_bits ( )

inlinestatic

Definition at line 76 of file mnt4_g1.hpp.

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

Here is the call graph for this function:

to_affine_coordinates()

void libff::mnt4_G1::to_affine_coordinates

(

)

Definition at line 72 of file mnt4_g1.cpp.

{
    if (this->is_zero())
    {
        this->X = mnt4_Fq::zero();
        this->Y = mnt4_Fq::one();
        this->Z = mnt4_Fq::zero();
    }
    else
    {
        const mnt4_Fq Z_inv = Z.inverse();
        this->X = this->X * Z_inv;
        this->Y = this->Y * Z_inv;
        this->Z = mnt4_Fq::one();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

to_special()

void libff::mnt4_G1::to_special

(

)

Definition at line 89 of file mnt4_g1.cpp.

{
    this->to_affine_coordinates();
}

Here is the call graph for this function:

zero()

mnt4_G1 libff::mnt4_G1::zero ( )

static

Definition at line 378 of file mnt4_g1.cpp.

{
    return G1_zero;
}

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const mnt4_G1 & g )

friend

Definition at line 393 of file mnt4_g1.cpp.

{
    mnt4_G1 copy(g);
    copy.to_affine_coordinates();
 
    out << (copy.is_zero() ? 1 : 0) << OUTPUT_SEPARATOR;
#ifdef NO_PT_COMPRESSION
    out << copy.X << OUTPUT_SEPARATOR << copy.Y;
#else
    /* storing LSB of Y */
    out << copy.X << OUTPUT_SEPARATOR << (copy.Y.as_bigint().data[0] & 1);
#endif
 
    return out;
}

operator>>

std::istream & operator>> ( std::istream & in, mnt4_G1 & g )

friend

Definition at line 409 of file mnt4_g1.cpp.

{
    char is_zero;
    mnt4_Fq tX, tY;
 
#ifdef NO_PT_COMPRESSION
    in >> is_zero >> tX >> tY;
    is_zero -= '0';
#else
    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 + a*x + b)
    if (!is_zero)
    {
        mnt4_Fq tX2 = tX.squared();
        mnt4_Fq tY2 = (tX2 + mnt4_G1::coeff_a) * tX + mnt4_G1::coeff_b;
        tY = tY2.sqrt();
 
        if ((tY.as_bigint().data[0] & 1) != Y_lsb)
        {
            tY = -tY;
        }
    }
#endif
    // using projective coordinates
    if (!is_zero)
    {
        g.X = tX;
        g.Y = tY;
        g.Z = mnt4_Fq::one();
    }
    else
    {
        g = mnt4_G1::zero();
    }
 
    return in;
}

Member Data Documentation

coeff_a

mnt4_Fq libff::mnt4_G1::coeff_a

static

Definition at line 37 of file mnt4_g1.hpp.

coeff_b

mnt4_Fq libff::mnt4_G1::coeff_b

static

Definition at line 38 of file mnt4_g1.hpp.

fixed_base_exp_window_table

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

static

Definition at line 33 of file mnt4_g1.hpp.

G1_one

mnt4_G1 libff::mnt4_G1::G1_one = {}

static

Definition at line 35 of file mnt4_g1.hpp.

G1_zero

mnt4_G1 libff::mnt4_G1::G1_zero = {}

static

Definition at line 34 of file mnt4_g1.hpp.

initialized

bool libff::mnt4_G1::initialized = false

static

Definition at line 36 of file mnt4_g1.hpp.

wnaf_window_table

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

static

Definition at line 32 of file mnt4_g1.hpp.

X

mnt4_Fq libff::mnt4_G1::X

Definition at line 43 of file mnt4_g1.hpp.

Y

mnt4_Fq libff::mnt4_G1::Y

Definition at line 43 of file mnt4_g1.hpp.

Z

mnt4_Fq libff::mnt4_G1::Z

Definition at line 43 of file mnt4_g1.hpp.

---

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

• libraries/fc/libraries/ff/libff/algebra/curves/mnt/mnt4/mnt4_g1.hpp
• libraries/fc/libraries/ff/libff/algebra/curves/mnt/mnt4/mnt4_g1.cpp