Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Supplement descriptions for defaulting loop indices to be u64 #3237

Merged
merged 6 commits into from
Oct 26, 2023
Merged

chore(docs): Supplement descriptions for defaulting loop indices to be u64 #3237

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8f9d9d
Remove mentioning of Field as default integer
Savio-Sou Oct 20, 2023
eacae6a
Mention `u64` is the default integer type
Savio-Sou Oct 20, 2023
4ba458c
Merge branch 'master' into ss/docs-default-integer
signorecello Oct 24, 2023
cbcd809
Merge branch 'master' into ss/docs-default-integer
signorecello Oct 25, 2023
865ca21
Update docs/docs/language_concepts/data_types/00_fields.md
Savio-Sou Oct 25, 2023
2c15822
Update docs/docs/language_concepts/data_types/01_integers.md
Savio-Sou Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/docs/language_concepts/data_types/01_integers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,16 @@ keywords:
An integer type is a range constrained field type. The Noir frontend currently supports unsigned,
arbitrary-sized integer types.

> **Note:** When an integer is defined in Noir without a specific type, it will default to `Field`. The one exception is for loop indices which default to `u64` since comparisons on `Field`s are not possible.

An integer type is specified first with the letter `u`, indicating its unsigned nature, followed by
its length in bits (e.g. `32`). For example, a `u32` variable can store a value in the range of
$\\([0,2^{32}-1]\\)$:
$\\([0,2^{32}-1]\\)$.

> **Note:** The default proving backend supports both even (e.g. `u16`, `u48`) and odd (e.g. `u5`, `u3`)
> sized integer types.

Taking a look of how the type is used:

```rust
fn main(x : Field, y : u32) {
Expand All @@ -28,6 +35,3 @@ fn main(x : Field, y : u32) {
`x`, `y` and `z` are all private values in this example. However, `x` is a field while `y` and `z`
are unsigned 32-bit integers. If `y` or `z` exceeds the range $\\([0,2^{32}-1]\\)$, proofs created
will be rejected by the verifier.

> **Note:** The default backend supports both even (e.g. `u16`, `u48`) and odd (e.g. `u5`, `u3`)
> sized integer types.
Loading