Skip to content

Commit 85252ea

Browse files
committed
docs cleanup
1 parent dccc38c commit 85252ea

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

src/batch.jl

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,6 @@ struct BatchedDiagonalOperator{T,D,F} <: AbstractSciMLLinearOperator{T}
2626
end
2727
end
2828

29-
"""
30-
When `diag` is a multidimensional array, `L = DiagonalOperator(diag, ...)` forms
31-
an operator of size `(N, N)` where `N = size(diag, 1)` is the leading length of `diag`.
32-
`L` then is the elementwise-scaling operation on arrays of `length(u) = length(diag)`
33-
with leading length `size(u, 1) = N`. Note that `L` in this case doesn't act independently
34-
on coumn-vectors of its input.
35-
"""
3629
function DiagonalOperator(u::AbstractArray; update_func=DEFAULT_UPDATE_FUNC)
3730
BatchedDiagonalOperator(u; update_func=update_func)
3831
end

src/matrix.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,11 @@ the following signature:
9595
When `diag` is an `AbstractVector` of length N, `L=DiagonalOpeator(diag, ...)`
9696
can be applied to `AbstractArray`s with `size(u, 1) == N`. Each column of the `u`
9797
will be scaled by `diag`, as in `LinearAlgebra.Diagonal(diag) * u`.
98+
99+
When `diag` is a multidimensional array, `L = DiagonalOperator(diag, ...)` forms
100+
an operator of size `(N, N)` where `N = size(diag, 1)` is the leading length of `diag`.
101+
`L` then is the elementwise-scaling operation on arrays of `length(u) = length(diag)`
102+
with leading length `size(u, 1) = N`.
98103
"""
99104
function DiagonalOperator(diag::AbstractVector; update_func=DEFAULT_UPDATE_FUNC)
100105
function diag_update_func(A, u, p, t)

0 commit comments

Comments
 (0)