saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-06 20:41:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify docs for the choice of sign for MontgomeryPoint.to_edwards().

Browse source
This commit is contained in:
Isis Lovecruft 2019-10-23 19:48:56 +00:00
parent 7c5ba69491
commit 019b81aa20
No known key found for this signature in database
GPG key ID: AB41313533E8E812
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/montgomery.rs
View file

@ -104,6 +104,11 @@ impl MontgomeryPoint {
/// Attempt to convert to an `EdwardsPoint`, using the supplied /// Attempt to convert to an `EdwardsPoint`, using the supplied
/// choice of sign for the `EdwardsPoint`. /// choice of sign for the `EdwardsPoint`.
/// ///
/// # Inputs
///
/// * `sign`: a `u8` donating the desired sign of the resulting
/// `EdwardsPoint`. `0` denotes positive and `1` negative.
///
/// # Return /// # Return
/// ///
/// * `Some(EdwardsPoint)` if `self` is the \\(u\\)-coordinate of a /// * `Some(EdwardsPoint)` if `self` is the \\(u\\)-coordinate of a