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.

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

feat: Standard library functions can now be called with closure args #2471

Merged
merged 2 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions crates/nargo_cli/tests/compile_success_empty/option/src/main.nr
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
use dep::std::option::Option;

fn main() {
let ten = 10; // giving this a name, to ensure that the Option functions work with closures

let none = Option::none();
let some = Option::some(3);

Expand All @@ -14,15 +16,22 @@ fn main() {

assert(none.unwrap_or_else(|| 5) == 5);
assert(some.unwrap_or_else(|| 5) == 3);
assert(none.unwrap_or_else(|| ten + 5) == 15);
assert(some.unwrap_or_else(|| ten + 5) == 3);

assert(none.map(|x| x * 2).is_none());
assert(some.map(|x| x * 2).unwrap() == 6);
assert(some.map(|x| x * ten).unwrap() == 30);

assert(none.map_or(0, |x| x * 2) == 0);
assert(some.map_or(0, |x| x * 2) == 6);
assert(none.map_or(0, |x| x * ten) == 0);
assert(some.map_or(0, |x| x * ten) == 30);

assert(none.map_or_else(|| 0, |x| x * 2) == 0);
assert(some.map_or_else(|| 0, |x| x * 2) == 6);
assert(none.map_or_else(|| 0, |x| x * ten) == 0);
assert(some.map_or_else(|| ten, |x| x * 2) == 6);

assert(none.and(none).is_none());
assert(none.and(some).is_none());
Expand All @@ -35,6 +44,7 @@ fn main() {
assert(none.and_then(add1_u64).is_none());
assert(some.and_then(|_value| Option::none()).is_none());
assert(some.and_then(add1_u64).unwrap() == 4);
assert(some.and_then(|x| Option::some(x + ten)).unwrap() == 13);

assert(none.or(none).is_none());
assert(none.or(some).is_some());
Expand All @@ -45,6 +55,7 @@ fn main() {
assert(none.or_else(|| Option::some(5)).is_some());
assert(some.or_else(|| Option::none()).is_some());
assert(some.or_else(|| Option::some(5)).is_some());
assert(some.or_else(|| Option::some(ten)).is_some());

assert(none.xor(none).is_none());
assert(none.xor(some).is_some());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
name = "generators"
type = "bin"
authors = [""]
compiler_version = "0.10.3"

[dependencies]
57 changes: 57 additions & 0 deletions crates/nargo_cli/tests/execution_success/generators/src/main.nr
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// TODO?
// the syntax for these return types is very difficult to get right :/
// for arguments this can be handled with a generic Env (or with Fn traits when we add them)
// but for return types neither fo these will help, you need to type out the exact type
jfecher marked this conversation as resolved.
Show resolved Hide resolved
fn make_counter() -> fn[(&mut Field,)]() -> Field {
let mut x = &mut 0;

|| {
*x = *x + 1;
*x
}
}

fn fibonacci_generator() -> fn[(&mut Field, &mut Field)]() -> Field {
let mut x = &mut 1;
let mut y = &mut 2;

|| {
let old_x = *x;
let old_y = *y;

*y = *x + *y;
*x = old_y;

old_x
}
}

// we'll be able to un-hardcode the array length if we have the ::<> syntax proposed in https://github.com/noir-lang/noir/issues/2458
fn get_some<Env>(generator: fn[Env]() -> Field) -> [Field; 5] {
[0,0,0,0,0].map(|_| generator())
}

fn test_fib() {
let fib = fibonacci_generator();

assert(fib() == 1);
assert(fib() == 2);
assert(fib() == 3);
assert(fib() == 5);

assert(get_some(fib) == [8, 13, 21, 34, 55]);
}

fn test_counter() {
let counter = make_counter();
assert(counter() == 1);
assert(counter() == 2);
assert(counter() == 3);

assert(get_some(counter) == [4, 5, 6, 7, 8]);
}

fn main() {
test_fib();
test_counter();
}
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,21 @@ fn main() -> pub Field {

/// Test the array functions in std::array
fn test_array_functions() {
let two = 2; // giving this a name, to ensure that the Option functions work with closures

let myarray: [i32; 3] = [1, 2, 3];
assert(myarray.any(|n| n > 2));
assert(myarray.any(|n| n > two));

let evens: [i32; 3] = myarray.map(|n| n * two); // [2, 4, 6]

let evens: [i32; 3] = [2, 4, 6];
assert(evens.all(|n| n > 1));
assert(evens.all(|n| n >= two));

assert(evens.fold(0, |a, b| a + b) == 12);
assert(evens.fold(0, |a, b| a + b + two) == 18);
assert(evens.reduce(|a, b| a + b) == 12);
assert(evens.reduce(|a, b| a + b + two) == 16);

// TODO: is this a sort_via issue with the new backend,
// or something more general?
Expand All @@ -68,6 +75,7 @@ fn test_array_functions() {
// assert(descending == [3, 2, 1]);

assert(evens.map(|n| n / 2) == myarray);
assert(evens.map(|n| n / two) == myarray);
}

fn foo() -> [u32; 2] {
Expand Down
12 changes: 6 additions & 6 deletions noir_stdlib/src/array.nr
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ impl<T, N> [T; N] {
fn sort(_self: Self) -> Self {}

// Sort with a custom sorting function.
fn sort_via(mut a: Self, ordering: fn(T, T) -> bool) -> Self {
fn sort_via<Env>(mut a: Self, ordering: fn[Env](T, T) -> bool) -> Self {
for i in 1 .. a.len() {
for j in 0..i {
if ordering(a[i], a[j]) {
Expand All @@ -33,7 +33,7 @@ impl<T, N> [T; N] {

// Apply a function to each element of an array, returning a new array
// containing the mapped elements.
fn map<U>(self, f: fn(T) -> U) -> [U; N] {
fn map<U, Env>(self, f: fn[Env](T) -> U) -> [U; N] {
let first_elem = f(self[0]);
let mut ret = [first_elem; N];

Expand All @@ -47,7 +47,7 @@ impl<T, N> [T; N] {
// Apply a function to each element of the array and an accumulator value,
// returning the final accumulated value. This function is also sometimes
// called `foldl`, `fold_left`, `reduce`, or `inject`.
fn fold<U>(self, mut accumulator: U, f: fn(U, T) -> U) -> U {
fn fold<U, Env>(self, mut accumulator: U, f: fn[Env](U, T) -> U) -> U {
for elem in self {
accumulator = f(accumulator, elem);
}
Expand All @@ -57,7 +57,7 @@ impl<T, N> [T; N] {
// Apply a function to each element of the array and an accumulator value,
// returning the final accumulated value. Unlike fold, reduce uses the first
// element of the given array as its starting accumulator value.
fn reduce(self, f: fn(T, T) -> T) -> T {
fn reduce<Env>(self, f: fn[Env](T, T) -> T) -> T {
let mut accumulator = self[0];
for i in 1 .. self.len() {
accumulator = f(accumulator, self[i]);
Expand All @@ -66,7 +66,7 @@ impl<T, N> [T; N] {
}

// Returns true if all elements in the array satisfy the predicate
fn all(self, predicate: fn(T) -> bool) -> bool {
fn all<Env>(self, predicate: fn[Env](T) -> bool) -> bool {
let mut ret = true;
for elem in self {
ret &= predicate(elem);
Expand All @@ -75,7 +75,7 @@ impl<T, N> [T; N] {
}

// Returns true if any element in the array satisfies the predicate
fn any(self, predicate: fn(T) -> bool) -> bool {
fn any<Env>(self, predicate: fn[Env](T) -> bool) -> bool {
let mut ret = false;
for elem in self {
ret |= predicate(elem);
Expand Down
14 changes: 7 additions & 7 deletions noir_stdlib/src/option.nr
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ impl<T> Option<T> {

/// Returns the wrapped value if `self.is_some()`. Otherwise, calls the given function to return
/// a default value.
fn unwrap_or_else(self, default: fn() -> T) -> T {
fn unwrap_or_else<Env>(self, default: fn[Env]() -> T) -> T {
if self._is_some {
self._value
} else {
Expand All @@ -57,7 +57,7 @@ impl<T> Option<T> {
}

/// If self is `Some(x)`, this returns `Some(f(x))`. Otherwise, this returns `None`.
fn map<U>(self, f: fn(T) -> U) -> Option<U> {
fn map<U, Env>(self, f: fn[Env](T) -> U) -> Option<U> {
if self._is_some {
Option::some(f(self._value))
} else {
Expand All @@ -66,7 +66,7 @@ impl<T> Option<T> {
}

/// If self is `Some(x)`, this returns `f(x)`. Otherwise, this returns the given default value.
fn map_or<U>(self, default: U, f: fn(T) -> U) -> U {
fn map_or<U, Env>(self, default: U, f: fn[Env](T) -> U) -> U {
if self._is_some {
f(self._value)
} else {
Expand All @@ -75,7 +75,7 @@ impl<T> Option<T> {
}

/// If self is `Some(x)`, this returns `f(x)`. Otherwise, this returns `default()`.
fn map_or_else<U>(self, default: fn() -> U, f: fn(T) -> U) -> U {
fn map_or_else<U, Env1, Env2>(self, default: fn[Env1]() -> U, f: fn[Env2](T) -> U) -> U {
if self._is_some {
f(self._value)
} else {
Expand All @@ -96,7 +96,7 @@ impl<T> Option<T> {
/// with the Some value contained within self, and returns the result of that call.
///
/// In some languages this function is called `flat_map` or `bind`.
fn and_then<U>(self, f: fn(T) -> Option<U>) -> Option<U> {
fn and_then<U, Env>(self, f: fn[Env](T) -> Option<U>) -> Option<U> {
if self._is_some {
f(self._value)
} else {
Expand All @@ -114,7 +114,7 @@ impl<T> Option<T> {
}

/// If self is Some, return self. Otherwise, return `default()`.
fn or_else<U>(self, default: fn() -> Self) -> Self {
fn or_else<U, Env>(self, default: fn[Env]() -> Self) -> Self {
if self._is_some {
self
} else {
Expand All @@ -140,7 +140,7 @@ impl<T> Option<T> {

/// Returns `Some(x)` if self is `Some(x)` and `predicate(x)` is true.
/// Otherwise, this returns `None`
fn filter(self, predicate: fn(T) -> bool) -> Self {
fn filter<Env>(self, predicate: fn[Env](T) -> bool) -> Self {
if self._is_some {
if predicate(self._value) {
self
Expand Down