Skip to content

Commit

Permalink
review documentation build with Julia 1.10 (#311)
Browse files Browse the repository at this point in the history
review documentation build with Julia 1.10
  • Loading branch information
tmigot authored Feb 16, 2024
1 parent 849dfad commit 5ce0dc0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# A Julia Linear Operator Package

Operators behave like matrices (with [exceptions](#Differences-1)) but are defined
Operators behave like matrices (with [exceptions](@ref differences)) but are defined
by their effect when applied to a vector.
They can be transposed, conjugated, or combined with other operators cheaply.
The costly operation is deferred until multiplied with a vector.

## Compatibility

Julia 1.3 and up.
Julia 1.6 and up.

## How to Install

Expand Down Expand Up @@ -68,21 +68,22 @@ operators (see [differences](@ref differences)).
Unlike matrices, an operator never reduces to a vector or a number.

```@example exdiff
using LinearOperators #hide
using LinearOperators
A = rand(5,5)
opA = LinearOperator(A)
A[:,1] * 3 # Vector
A[:,1] * 3 isa Vector
```
```@example exdiff
opA[:,1] * 3 # LinearOperator
opA[:,1] * 3 isa LinearOperator
```
```@example exdiff
# A[:,1] * [3] # ERROR
opA[:,1] * [3] isa Vector
```
```@example exdiff
opA[:,1] * [3] # Vector
However, the following returns an error
```julia
A[:,1] * [3]
```
This is also true for `A[i,:]`, which returns vectors on Julia 0.6, and for the scalar
This is also true for `A[i,:]`, which would return a vector and for the scalar
`A[i,j]`.
Similarly, `opA[1,1]` is an operator of size (1,1):"
```@example exdiff
Expand Down
2 changes: 1 addition & 1 deletion docs/src/tutorial.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You can check an [Introduction to LinearOperators.jl](https://juliasmoothoptimizers.github.io/tutorials/introduction-to-linear-operators/) on our site, [juliasmoothoptimizers.github.io](https://juliasmoothoptimizers.github.io).
You can check an [Introduction to LinearOperators.jl](https://jso.dev/tutorials/introduction-to-linear-operators/) on our site, [jso.dev](https://jso.dev/).

0 comments on commit 5ce0dc0

Please sign in to comment.