mirror of
https://github.com/saymrwulf/risc0-curve25519-dalek-source.git
synced 2026-09-04 20:03:40 +00:00
Clarify docs for the choice of sign for MontgomeryPoint.to_edwards().
This commit is contained in:
parent
7c5ba69491
commit
019b81aa20
1 changed files with 5 additions and 0 deletions
|
|
@ -104,6 +104,11 @@ impl MontgomeryPoint {
|
|||
/// Attempt to convert to an `EdwardsPoint`, using the supplied
|
||||
/// 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
|
||||
///
|
||||
/// * `Some(EdwardsPoint)` if `self` is the \\(u\\)-coordinate of a
|
||||
|
|
|
|||
Loading…
Reference in a new issue