Skip to content

Commit

Permalink
Update doc links (#132)
Browse files Browse the repository at this point in the history 
## Content

This PR removes the links to the variables for the `varmap` in the
documentation.
It avoids the clippy warnings in the CI. 

## Pre-submit checklist

- Branch
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update documentation website (if relevant)

## Issue(s)
Closes #131
  • Loading branch information
@curiecrypt
curiecrypt authored Jan 21, 2025
1 parent b22e571 commit b5629b0
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions docs/rustdoc/varmap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@ Variable name mapping.
In the [paper](https://iohk.io/en/research/library/papers/approximate-lower-bound-arguments/), numerous variables are represented by various letters. To enhance the simplicity and readability of our code, we have opted for descriptive names. A mapping between the variable names used in the paper and those in the code is provided for reference.


| Paper | Code |
|--------------------|--------------------------------------------------------------------------------------------------|
| $\lambda_{sec}$ | [`soundness_param`][crate::centralized_telescope::params::Params::soundness_param] |
| $\lambda_{rel}$ | [`completeness_param`][crate::centralized_telescope::params::Params::completeness_param] |
| $S_p$ | `prover_set` |
| $n_p$ | [`set_size`][crate::centralized_telescope::params::Params::set_size] |
| $n_f$ | [`lower_bound`][crate::centralized_telescope::params::Params::lower_bound] |
| $u$ | [`proof_size`][crate::centralized_telescope::setup::Setup::proof_size] |
| $r$ | [`max_retries`][crate::centralized_telescope::setup::Setup::max_retries] |
| $d$ | [`search_width`][crate::centralized_telescope::setup::Setup::search_width] |
| $q$ | [`valid_proof_probability`][crate::centralized_telescope::setup::Setup::valid_proof_probability] |
| $b$ | [`dfs_bound`][crate::centralized_telescope::setup::Setup::dfs_bound] |
| $v$ | `retry_counter` |
| $t$ | `search_counter` |
| $H_0$ | `bin_hash` |
| $H_1$ | `round_hash` |
| $H_2$ | `proof_hash` |
| $s_i$ | `Element` |
| $s_1, \ldots, s_u$ | `element_sequence` |
| $p$ | [`lottery_probability`][crate::simple_lottery::setup::Setup::lottery_probability] |
| $limit$ | `step` |
| Paper | Code |
|--------------------|---------------------------|
| $\lambda_{sec}$ | `soundness_param` |
| $\lambda_{rel}$ | `completeness_param` |
| $S_p$ | `prover_set` |
| $n_p$ | `set_size` |
| $n_f$ | `lower_bound` |
| $u$ | `proof_size` |
| $r$ | `max_retries` |
| $d$ | `search_width` |
| $q$ | `valid_proof_probability` |
| $b$ | `dfs_bound` |
| $v$ | `retry_counter` |
| $t$ | `search_counter` |
| $H_0$ | `bin_hash` |
| $H_1$ | `round_hash` |
| $H_2$ | `proof_hash` |
| $s_i$ | `Element` |
| $s_1, \ldots, s_u$ | `element_sequence` |
| $p$ | `lottery_probability` |
| $limit$ | `step` |

0 comments on commit b5629b0

Please sign in to comment.