From 5ce0dc0387e2430c539f65e8538b85e64fba71ab Mon Sep 17 00:00:00 2001 From: tmigot Date: Fri, 16 Feb 2024 16:16:18 -0500 Subject: [PATCH] review documentation build with Julia 1.10 (#311) review documentation build with Julia 1.10 --- docs/src/index.md | 19 ++++++++++--------- docs/src/tutorial.md | 2 +- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 7b71e842..f20d9cfd 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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 @@ -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 diff --git a/docs/src/tutorial.md b/docs/src/tutorial.md index 6e1362d4..876cd0a0 100644 --- a/docs/src/tutorial.md +++ b/docs/src/tutorial.md @@ -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/).