generic_ec_curves/
__docs.rs

1//! Documentation-only module
2
3/// Curves performance
4///
5/// Below you can find benchmark results for all curves provided in `generic-ec`.
6///
7/// Capital letter stand for a point, and small letter stand for a scalar. E.g.
8/// `A+B` is point addition, `a+b` is scalar addition, and `[k]P` is multiplication
9/// of scalar at point.
10///
11#[doc = include_str!("../perf/curves/table.md")]
12///
13/// ## Reproducibility
14/// Benchmarks were carried out on c5.2xlarge EC2 instance.
15///
16/// In order to reproduce the experiments, you need [`cargo-criterion`](https://crates.io/crates/cargo-criterion)
17/// to be installed. Then you can run benchmarks via:
18///
19/// ```text
20/// cargo criterion --message-format json --bench curves > ./perf/curves/results.json
21/// ```
22///
23/// Then you can rebuild the table above:
24/// ```text
25/// cargo run --bin analyze -- curves < perf/curves/results.json > perf/curves/table.md
26/// ```
27pub mod curves_perf {}