[stdlib] Update stdlib corresponding to 2024-05-03 nightly/mojo

docs/faq.md

@@ -346,27 +346,37 @@ containers to enable remote development in Mojo.
 
 ### Does the Mojo SDK collect telemetry?
 
-Yes, in combination with the Modular CLI tool, the Mojo SDK collects some basic
-system information and crash reports that enable us to identify, analyze, and
-prioritize Mojo issues.
+Yes, the Mojo SDK collects some basic system information, basic
+compiler/runtime events, and crash reports that enable us to identify, analyze,
+and prioritize Mojo issues.
 
-Mojo is still in its early days, and this telemetry is crucial to help us
-quickly identify problems and improve Mojo. Without this telemetry, we would
-have to rely on user-submitted bug reports, and in our decades of building
-developer products, we know that most people don’t bother. Plus, a lot of
-product issues are not easily identified by users or quantifiable with
-individual bug reports. The telemetry provides us the insights we need to build
-Mojo into a premier developer product.
+This telemetry is crucial to help us quickly identify problems and improve our
+products. Without this telemetry, we would have to rely on user-submitted bug
+reports, and in our decades of experience building developer products, we know
+that most people don’t do that. The telemetry provides us the insights we need
+to build better products for you.
 
-Of course, if you don't want to share this information with us, you can easily
-opt-out of all telemetry, using the [`modular` CLI](/cli). To stop sharing
-system information, run this:
+You can opt-out of the crash report and compiler/runtime telemetry, but
+package install/update/uninstall events cannot be
+disabled (see the [MAX SDK terms](https://www.modular.com/legal/max)).
 
-`modular config-set telemetry.enabled=false`
+To disable crash reports, use this command:
 
-To stop sharing crash reports, run this:
+```sh
+modular config-set crash_reporting.enabled=false
+```
 
-`modular config-set crash_reporting.enabled=false`
+To reduce other telemetry to only the required telemetry events, use this
+command:
+
+```sh
+modular config-set telemetry.level=0
+```
+
+There are 3 telemetry levels: `0` currently records nothing (unless you're also
+using MAX, which records hardware information and session durations); `1`
+records high-level events such as when the compiler is invoked; and `2` records
+more detail such as the time spend compiling.
 
 ## Versioning & compatibility
 

docs/manual/functions.ipynb

@@ -380,7 +380,7 @@
    "source": [
     "\n",
     "Memory-only types, such as `String`, are available as a \n",
-    "[`VariadicListMem`](/mojo/stdlib/builtin/builtin_list/VariadicListmem).\n",
+    "[`VariadicListMem`](/mojo/stdlib/builtin/builtin_list/VariadicListMem).\n",
     "Iterating over this list directly with a `for..in` loop currently produces a\n",
     "[`Reference`](/mojo/stdlib/memory/unsafe/reference) for each value instead\n",
     "of the value itself. You must add an empty subscript operator `[]` to\n",

docs/manual/lifecycle/life.ipynb

@@ -28,7 +28,7 @@
     "destroyed](/mojo/manual/lifecycle/death.html).)\n",
     "\n",
     "All data types in Mojo—including basic types in the standard library such as\n",
-    "[`Bool`](/mojo/stdlib/builtin/bool/bool),\n",
+    "[`Bool`](/mojo/stdlib/builtin/bool/Bool),\n",
     "[`Int`](/mojo/stdlib/builtin/int/Int), and\n",
     "[`String`](/mojo/stdlib/builtin/string/String), up to complex types such\n",
     "as [`SIMD`](/mojo/stdlib/builtin/simd/SIMD) and\n",

docs/manual/parameters/index.ipynb

@@ -517,7 +517,7 @@
     "\n",
     "The Mojo compiler is also smart about type inference with parameters. Note\n",
     "that the above function is able to call the parametric\n",
-    "[`sqrt[]()`](https://docs.modular.com/mojo/stdlib/math/math/sqrt) function\n",
+    "[`sqrt[]()`](/mojo/stdlib/math/math/sqrt) function\n",
     "without specifying the parameters—the compiler infers its parameters based on\n",
     "the parametric `x` value passed into it, as if you\n",
     "wrote `sqrt[dt, width](x)` explicitly. Also note that `rsqrt()` chose to\n",

docs/manual/types.ipynb

@@ -541,7 +541,7 @@
     "\n",
     "The collection types are _generic types_: while a given collection can only\n",
     "hold a specific type of value (such as `Int` or `Float64`), you specify the\n",
-    "type at compile time using a [parameter]((/mojo/manual/parameters/)). For\n",
+    "type at compile time using a [parameter](/mojo/manual/parameters/). For\n",
     "example, you can create a `List` of `Int` values like this:"
    ]
   },

examples/notebooks/RayTracing.ipynb

@@ -708,9 +708,6 @@
         }
       ],
       "source": [
-        "from math import max\n",
-        "\n",
-        "\n",
         "fn scene_intersect(\n",
         "    orig: Vec3f,\n",
         "    dir: Vec3f,\n",

stdlib/COMPATIBLE_COMPILER_VERSION

@@ -1 +1 @@
-2024.4.2923
+2024.5.303

stdlib/docs/development.md

@@ -153,8 +153,8 @@ Let's try adding a small piece of functionality to `path.mojo`:
 ```mojo
 # ./stdlib/src/pathlib/path.mojo
 
-fn print_cwd() raises:
-    print("cwd:", cwd())
+fn get_cwd_message() raises -> String:
+    return "Your cwd is: " + cwd()
 ```
 
 And make sure you're importing it from the module root:
@@ -165,7 +165,7 @@ And make sure you're importing it from the module root:
 from .path import (
     DIR_SEPARATOR,
     cwd,
-    print_cwd,
+    get_cwd_message,
     Path,
 )
 ```
@@ -180,13 +180,13 @@ functionality before you write tests:
 from src import pathlib
 
 def main():
-    pathlib.print_cwd()
+    print(pathlib.get_cwd_message())
 ```
 
 Now when you run `mojo main.mojo` it'll reflect the changes:
 
 ```plaintext
-cwd: /Users/jack/src/mojo/stdlib
+Your cwd is: /Users/jack/src/mojo/stdlib
 ```
 
 ### A change with dependencies
@@ -202,10 +202,11 @@ Try adding this to `os.mojo`, which depends on what we just added to
 
 import pathlib
 
-fn print_paths() raises:
-    pathlib.print_cwd()
+fn get_cwd_and_paths() raises -> List[String]:
+    result = List[String]()
+    result.append(pathlib.get_cwd_message())
     for path in cwd().listdir():
-        print(path[])
+        result.append(str(path[]))
 ```
 
 This won't work because it's importing `pathlib` from the `stdlib.mojopkg` that
@@ -224,7 +225,8 @@ syntax:
 import os
 
 def main():
-    os.print_paths()
+    all_paths = os.get_cwd_and_paths()
+    print(__type_of(all_paths).__str__(all_paths))
 ```
 
 We also need to set the following environment variable that tells Mojo to
@@ -268,30 +270,25 @@ If you haven't already, follow the steps at:
 
 ### Adding a test
 
-This will show you how the `FileCheck` utility works. First, turn it on by
-adding it to the end of line 7 in `./stdlib/test/pathlib/test_pathlib.mojo`:
+This section will show you how to add a unit test.
+Add the following at the top of `./stdlib/test/pathlib/test_pathlib.mojo`:
 
 ```mojo
-# RUN: %mojo -debug-level full -D TEMP_FILE=%t %s | FileCheck %s
+# RUN: %mojo %s
 ```
 
 Now we can add the test and force it to fail:
 
 ```mojo
-# CHECK-LABEL: test_print_cwd
-
-def test_print_cwd():
-    print("== test_print_cwd")
-
-    # CHECK: This will fail
-    print_cwd()
+def test_get_cwd_message():
+    assert_equal(get_cwd_message(), "Some random text")
 ```
 
 Don't forget to call it from `main()`:
 
 ```bash
 def main():
-    test_print_cwd()
+    test_get_cwd_message()
 ```
 
 Now, instead of testing all the modules, we can just test `pathlib`:
@@ -304,29 +301,20 @@ This will give you an error showing exactly what went wrong:
 
 ```plaintext
 /Users/jack/src/mojo-toy-2/stdlib/test/pathlib/test_pathlib.mojo:27:11:
-error: CHECK: expected string not found in input
-
-# CHECK: This will fail
-          ^
-<stdin>:1:18: note: scanning from here
-== test_print_cwd
-                 ^
+AssertionError: `left == right` comparison failed:
+   left: Your cwd is: /Users/jack/src/mojo/stdlib
+  right: Some random text
 ```
 
 Lets fix the test that we just added:
 
 ```mojo
-# CHECK-LABEL: test_print_cwd
-
-def test_print_cwd():
-    print("== test_print_cwd")
-
-    # CHECK: cwd:
-    print_cwd()
+def test_get_cwd_message():
+    assert_true(get_cwd_message().startswith("Your cwd is:"))
 ```
 
-We're now checking that `print_cwd` is prefixed with `cwd:` just like the
-function we added. Run the test again:
+We're now checking that `get_cwd_message` is prefixed with `Your cwd is:` just
+like the function we added. Run the test again:
 
 ```plaintext
 Testing Time: 0.65s

stdlib/src/builtin/_closure.mojo

@@ -19,18 +19,14 @@ struct __ParameterClosureCaptureList[fn_type: AnyRegType, fn_ref: fn_type]:
     # Parameter closure invariant requires this function be marked 'capturing'.
     @parameter
     @always_inline
-    fn __init__() -> Self:
-        return Self {
-            value: __mlir_op.`kgen.capture_list.create`[callee=fn_ref]()
-        }
+    fn __init__(inout self):
+        self.value = __mlir_op.`kgen.capture_list.create`[callee=fn_ref]()
 
     @always_inline
-    fn __copyinit__(existing: Self) -> Self:
-        return Self {
-            value: __mlir_op.`kgen.capture_list.copy`[callee=fn_ref](
-                existing.value
-            )
-        }
+    fn __copyinit__(inout self, existing: Self):
+        self.value = __mlir_op.`kgen.capture_list.copy`[callee=fn_ref](
+            existing.value
+        )
 
     @always_inline
     fn __del__(owned self):

stdlib/src/builtin/_math.mojo

@@ -0,0 +1,81 @@
+# ===----------------------------------------------------------------------=== #
+# Copyright (c) 2024, Modular Inc. All rights reserved.
+#
+# Licensed under the Apache License v2.0 with LLVM Exceptions:
+# https://llvm.org/LICENSE.txt
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ===----------------------------------------------------------------------=== #
+"""Module to contain some components of the future math module.
+
+This is needed to work around some circular dependencies; all elements of this
+module should be exposed by the current `math` module. The contents of this
+module should be eventually moved to the `math` module when it's open sourced.
+"""
+
+# ===----------------------------------------------------------------------===#
+# Ceilable
+# ===----------------------------------------------------------------------===#
+
+
+trait Ceilable:
+    """
+    The `Ceilable` trait describes a type that defines a ceiling operation.
+
+    Types that conform to `Ceilable` will work with the builtin `ceil`
+    function. The ceiling operation always returns the same type as the input.
+
+    For example:
+    ```mojo
+    from math import Ceilable, ceil
+
+    @value
+    struct Complex(Ceilable):
+        var re: Float64
+        var im: Float64
+
+        fn __ceil__(self) -> Self:
+            return Self(ceil(re), ceil(im))
+    ```
+    """
+
+    # TODO(MOCO-333): Reconsider the signature when we have parametric traits or
+    # associated types.
+    fn __ceil__(self) -> Self:
+        ...
+
+
+# ===----------------------------------------------------------------------===#
+# Floorable
+# ===----------------------------------------------------------------------===#
+
+
+trait Floorable:
+    """
+    The `Floorable` trait describes a type that defines a floor operation.
+
+    Types that conform to `Floorable` will work with the builtin `floor`
+    function. The floor operation always returns the same type as the input.
+
+    For example:
+    ```mojo
+    from math import Floorable, floor
+
+    @value
+    struct Complex(Floorable):
+        var re: Float64
+        var im: Float64
+
+        fn __floor__(self) -> Self:
+            return Self(floor(re), floor(im))
+    ```
+    """
+
+    # TODO(MOCO-333): Reconsider the signature when we have parametric traits or
+    # associated types.
+    fn __floor__(self) -> Self:
+        ...

stdlib/src/builtin/abs.mojo

@@ -35,6 +35,8 @@ trait Absable:
     ```
     """
 
+    # TODO(MOCO-333): Reconsider the signature when we have parametric traits or
+    # associated types.
     fn __abs__(self) -> Self:
         ...