mirror of
https://github.com/Qortal/pirate-librustzcash.git
synced 2025-01-31 07:42:15 +00:00
Auto merge of #31 - plutomonkey:fix-doc, r=ebfull
Fix some minor typos in docs.
This commit is contained in:
commit
990401395c
@ -12,7 +12,7 @@ repository = "https://github.com/ebfull/pairing"
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
rand = "0.3"
|
rand = "0.3"
|
||||||
byteorder = "1.1.0"
|
byteorder = "1.1.0"
|
||||||
clippy = { version = "0.0.148", optional = true }
|
clippy = { version = "0.0.151", optional = true }
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
unstable-wnaf = []
|
unstable-wnaf = []
|
||||||
|
@ -713,7 +713,7 @@ impl Fq {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Subtracts the modulus from this element if this element is not in the
|
/// Subtracts the modulus from this element if this element is not in the
|
||||||
/// field. Only used interally.
|
/// field. Only used internally.
|
||||||
#[inline(always)]
|
#[inline(always)]
|
||||||
fn reduce(&mut self) {
|
fn reduce(&mut self) {
|
||||||
if !self.is_valid() {
|
if !self.is_valid() {
|
||||||
|
@ -3,7 +3,7 @@ use ::{Field};
|
|||||||
use super::fq2::Fq2;
|
use super::fq2::Fq2;
|
||||||
use super::fq::{FROBENIUS_COEFF_FQ6_C1, FROBENIUS_COEFF_FQ6_C2};
|
use super::fq::{FROBENIUS_COEFF_FQ6_C1, FROBENIUS_COEFF_FQ6_C2};
|
||||||
|
|
||||||
/// An element of Fq6, represented by c0 + c1 * v + c2 * v^2.
|
/// An element of Fq6, represented by c0 + c1 * v + c2 * v^(2).
|
||||||
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
|
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
|
||||||
pub struct Fq6 {
|
pub struct Fq6 {
|
||||||
pub c0: Fq2,
|
pub c0: Fq2,
|
||||||
|
@ -488,7 +488,7 @@ impl Fr {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Subtracts the modulus from this element if this element is not in the
|
/// Subtracts the modulus from this element if this element is not in the
|
||||||
/// field. Only used interally.
|
/// field. Only used internally.
|
||||||
#[inline(always)]
|
#[inline(always)]
|
||||||
fn reduce(&mut self) {
|
fn reduce(&mut self) {
|
||||||
if !self.is_valid() {
|
if !self.is_valid() {
|
||||||
|
@ -349,7 +349,7 @@ pub trait PrimeFieldRepr: Sized +
|
|||||||
AsMut<[u64]> +
|
AsMut<[u64]> +
|
||||||
From<u64>
|
From<u64>
|
||||||
{
|
{
|
||||||
/// Subtract another reprensetation from this one, returning the borrow bit.
|
/// Subtract another represetation from this one, returning the borrow bit.
|
||||||
fn sub_noborrow(&mut self, other: &Self) -> bool;
|
fn sub_noborrow(&mut self, other: &Self) -> bool;
|
||||||
|
|
||||||
/// Add another representation to this one, returning the carry bit.
|
/// Add another representation to this one, returning the carry bit.
|
||||||
@ -442,7 +442,7 @@ pub enum GroupDecodingError {
|
|||||||
NotInSubgroup,
|
NotInSubgroup,
|
||||||
/// One of the coordinates could not be decoded
|
/// One of the coordinates could not be decoded
|
||||||
CoordinateDecodingError(&'static str, PrimeFieldDecodingError),
|
CoordinateDecodingError(&'static str, PrimeFieldDecodingError),
|
||||||
/// The compression mode of the encoded elemnet was not as expected
|
/// The compression mode of the encoded element was not as expected
|
||||||
UnexpectedCompressionMode,
|
UnexpectedCompressionMode,
|
||||||
/// The encoding contained bits that should not have been set
|
/// The encoding contained bits that should not have been set
|
||||||
UnexpectedInformation
|
UnexpectedInformation
|
||||||
@ -523,7 +523,7 @@ pub trait PrimeField: Field
|
|||||||
/// Convert this prime field element into a biginteger representation.
|
/// Convert this prime field element into a biginteger representation.
|
||||||
fn from_repr(Self::Repr) -> Result<Self, PrimeFieldDecodingError>;
|
fn from_repr(Self::Repr) -> Result<Self, PrimeFieldDecodingError>;
|
||||||
|
|
||||||
/// Convert a biginteger reprensentation into a prime field element, if
|
/// Convert a biginteger representation into a prime field element, if
|
||||||
/// the number is an element of the field.
|
/// the number is an element of the field.
|
||||||
fn into_repr(&self) -> Self::Repr;
|
fn into_repr(&self) -> Self::Repr;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user