Skip to content

Commit 29de896

Browse files
update README
1 parent c73104f commit 29de896

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Is a form of `vec` which is safe for all values in vector spaces, i.e. if
7575
is already a vector, like an AbstractVector or Number, it will return said
7676
AbstractVector or Number.
7777

78-
## zeromatrix(u::AbstractVector)
78+
## zeromatrix(u)
7979

8080
Creates the zero'd matrix version of `u`. Note that this is unique because
8181
`similar(u,length(u),length(u))` returns a mutable type, so is not type-matching,
@@ -85,15 +85,24 @@ i.e. you'll get a CPU array from a GPU array. The generic fallback is
8585
with weird (recursive) broadcast overloads. For higher order tensors, this
8686
returns the matrix linear operator type which acts on the `vec` of the array.
8787

88-
## List of things to add
88+
## restructure(x,y)
89+
90+
Restructures the object `y` into a shape of `x`, keeping its values intact. For
91+
simple objects like an `Array`, this simply amounts to a reshape. However, for
92+
more complex objects such as an `ArrayPartition`, not all of the structural
93+
information is adequately contained in the type for standard tools to work. In
94+
these cases, `restructure` gives a way to convert for example an `Array` into
95+
a matching `ArrayPartition`.
96+
97+
# List of things to add
8998

9099
- https://github.com/JuliaLang/julia/issues/22216
91100
- https://github.com/JuliaLang/julia/issues/22218
92101
- https://github.com/JuliaLang/julia/issues/22622
93102
- https://github.com/JuliaLang/julia/issues/25760
94103
- https://github.com/JuliaLang/julia/issues/25107
95104

96-
## Array Types to Handle
105+
# Array Types to Handle
97106

98107
The following common array types are being understood and tested as part of this
99108
development.

0 commit comments

Comments
 (0)