Skip to content
This repository has been archived by the owner on Nov 9, 2023. It is now read-only.

Last doc updates & benches for bumping to v0.2.0 #72

Merged
merged 6 commits into from
Jul 25, 2019
Merged

Last doc updates & benches for bumping to v0.2.0 #72

merged 6 commits into from
Jul 25, 2019

Conversation

CPerezz
Copy link
Contributor

@CPerezz CPerezz commented Jul 25, 2019

This PR has two main purposes:

Doc comments update & creation:

  • Updated field.rs & scalar.rs docs with examples for new implemented features.
  • Created docs for Twisted Edwards Point operations.

New features / Improvements

Once #71 gets merged, will commit with the new version on Cargo.toml and ship it to crates.io.

This closes: #70 & #58

@CPerezz
Add doc examples for edwards.rs mod
d8e2bcf 
Added doc comments with some examples of the ops that
the module supports.
@CPerezz
Add doc examples for field.rs mod
b97e64c 
Updated doc comments with some examples of the ops that
the module supports.
@CPerezz
Add last doc notes and examples.
db34548 
Updated edwards docs with `CompressedEdwardsY`
examples.
@CPerezz
Speed up evenness checks for FieldElement
39a66a4 
Compare the last bit of the first limb to check evenness.
0b0 -> true
0b1 -> false

This is done in constant time since the op performed
is a logical AND operator with the first limb and
then a comparaison.

This closes #58.
This almost closes #70.
@CPerezz
Fix comment issues.
448a56b 
Some doc comments were not compiling.

This solves it.
@CPerezz
Benchmark point Compression/Decompression
131d73b 
Benchmarked both processes, and they
spend almost the same time as the mod_sqrt
does (which is the expected).
@CPerezz CPerezz added review needed This PR, MR or Issue status needs to be reviewed. documentation Improvements or additions to documentation end_user_utility This feature provides value for the end-user speed_improvement New implementation or changes that speed up existing processes. labels Jul 25, 2019
@CPerezz CPerezz self-assigned this Jul 25, 2019
LukePearson1
LukePearson1 reviewed Jul 25, 2019
View reviewed changes
Copy link
Contributor

@LukePearson1 LukePearson1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left comments in the documents, only one regarding the code and the rest for the descriptions. It is still to be merged but the comments must have follow up actions.
Additionally, this merge request plus the one I gave marks a need for a new road, so we must have a planning session for the future works of Zerocaf.

@LukePearson1 LukePearson1 merged commit 53a3c6b into master Jul 25, 2019
@CPerezz CPerezz mentioned this pull request Jul 25, 2019
Closed
LukePearson1 added a commit that referenced this pull request Jul 26, 2019
@LukePearson1
Fix documents merge request #72
2f92488 
 Please enter the commit message for your changes. Lines starting
@CPerezz CPerezz deleted the docs branch October 1, 2019 14:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@LukePearson1 LukePearson1 LukePearson1 left review comments

Assignees

@CPerezz CPerezz

Labels
documentation Improvements or additions to documentation end_user_utility This feature provides value for the end-user review needed This PR, MR or Issue status needs to be reviewed. speed_improvement New implementation or changes that speed up existing processes.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add docs and examples & release version 0.2 Implement CT evenness checking using subtle's Choice.
2 participants
@CPerezz @LukePearson1