Skip to content

Commit

Permalink
remove eye from the docs, update around @SVector and @SMatrix d…
Browse files Browse the repository at this point in the history
…ocs (#1216)
  • Loading branch information
hyrodium authored Oct 30, 2023
1 parent d32451e commit 77abe1b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/src/pages/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ where you can use native Julia array literals syntax, comprehensions, and the
macro, and must be made of combinations of literal values, functions, or global
variables, but is not limited to just simple ranges. Extending this to
(hopefully statically known by type-inference) local-scope variables is hoped
for the future. The `zeros()`, `ones()`, `fill()`, `rand()` and `randn()` functions do not have this
for the future. The `zeros()`, `ones()`, `fill()`, `rand()`, `randn()`, and `randexp()` functions do not have this
limitation.)

### `SMatrix`
Expand All @@ -28,7 +28,7 @@ convenience constructors are provided, so that `L`, `T` and even `M` are
unnecessary. At minimum, you can type `SMatrix{2}(1,2,3,4)` to create a 2×2
matrix (the total number of elements must divide evenly into `N`). A
convenience macro `@SMatrix [1 2; 3 4]` is provided (which also accepts
comprehensions and the `zeros()`, `ones()`, `fill()`, `rand()`, `randn()` and `eye()`
comprehensions and the `zeros()`, `ones()`, `fill()`, `rand()`, `randn()`, and `randexp()`
functions).

### `SArray`
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ a = @SArray randn(2, 2, 2, 2, 2, 2)
# Supports all the common operations of AbstractArray
v7 = v1 + v2
v8 = sin.(v3)
v3 == m3 * v3 # recall that m3 = eye(SMatrix{3,3})
v3 == m3 * v3 # recall that m3 = SMatrix{3,3}(1I)
# map, reduce, broadcast, map!, broadcast!, etc...

# Indexing can also be done using static arrays of integers
Expand Down

0 comments on commit 77abe1b

Please sign in to comment.