1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
// Copyright (C) 2019-2021 Aleo Systems Inc. // This file is part of the snarkVM library. // The snarkVM library is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // The snarkVM library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with the snarkVM library. If not, see <https://www.gnu.org/licenses/>. use crate::{Field, FieldParameters}; use snarkvm_utilities::biginteger::BigInteger; use std::str::FromStr; /// The interface for a prime field. #[allow(clippy::wrong_self_convention)] pub trait PrimeField: Field + FromStr { type Parameters: FieldParameters<BigInteger = Self::BigInteger>; type BigInteger: BigInteger; /// Returns a prime field element from its underlying representation. fn from_repr(repr: Self::BigInteger) -> Option<Self>; /// Returns the underlying representation of the prime field element. fn into_repr(&self) -> Self::BigInteger; /// Returns a prime field element from its underlying raw representation. fn from_repr_raw(repr: Self::BigInteger) -> Self; /// Returns the underlying raw representation of the prime field element. fn into_repr_raw(&self) -> Self::BigInteger; /// Returns the multiplicative generator of `char()` - 1 order. fn multiplicative_generator() -> Self; /// Returns the 2^s root of unity. fn root_of_unity() -> Self; /// Return the a QNR^T fn qnr_to_t() -> Self { Self::root_of_unity() } /// Returns the field size in bits. fn size_in_bits() -> usize { Self::Parameters::MODULUS_BITS as usize } /// Returns the trace. fn trace() -> Self::BigInteger { Self::Parameters::T } /// Returns the trace minus one divided by two. fn trace_minus_one_div_two() -> Self::BigInteger { Self::Parameters::T_MINUS_ONE_DIV_TWO } /// Returns the modulus minus one divided by two. fn modulus_minus_one_div_two() -> Self::BigInteger { Self::Parameters::MODULUS_MINUS_ONE_DIV_TWO } }