Merge 74e2d12 into 04d9100

.github/workflows/CI.yml

@@ -4,22 +4,25 @@ on:
   push:
     branches:
       - master
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  workflow_dispatch:
 
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.version == 'nightly' }}
     strategy:
       fail-fast: false
       matrix:
-        version:
-          - '1.6'
-          - '1'
-          - 'nightly'
-        os:
-          - ubuntu-latest
-          - macOS-latest
+        version: ['1.6', '1', 'nightly']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
         arch:
           - x64
         include:

.github/workflows/CompatHelper.yml

@@ -1,7 +1,8 @@
 name: CompatHelper
+
 on:
   schedule:
-    - cron: 0 0 * * *
+    - cron: 0 0 * * 0 # weekly
   workflow_dispatch:
 permissions:
   contents: write

.github/workflows/Documentation.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@latest
         with:
-          version: '1.6'
+          version: '1'
       - name: Cache artifacts
         uses: actions/cache@v3
         env:

.github/workflows/clean.yml

@@ -0,0 +1,28 @@
+# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#gh-pages-Branch
+
+name: DocPreviewCleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

README.md

@@ -36,9 +36,9 @@ Toeplitz, Hankel, and circulant matrices.
 ### [`Cauchy` matrix](http://en.wikipedia.org/wiki/Cauchy_matrix)
 
 ```julia
-Cauchy(x,y)[i,j]=1/(x[i]+y[j])
-Cauchy(x)=Cauchy(x,x)
-cauchy(k::Number)=Cauchy(collect(1:k))
+Cauchy(x,y)[i,j] = 1/(x[i] + y[j])
+Cauchy(x) = Cauchy(x,x)
+Cauchy(k::Int) = Cauchy(1:k)
 
 julia> Cauchy([1,2,3],[3,4,5])
 3×3 Cauchy{Int64}:
@@ -52,7 +52,7 @@ julia> Cauchy([1,2,3])
  0.333333  0.25      0.2
  0.25      0.2       0.166667
 
-julia> Cauchy(pi)
+julia> Cauchy(3)
 3×3 Cauchy{Float64}:
  0.5       0.333333  0.25
  0.333333  0.25      0.2
@@ -120,7 +120,7 @@ julia> F*F #Special form preserved if the same column has the subdiagonals
  0.0  0.0  6.0  0.0  0.0  1.0
 
 julia> F*Frobenius(2, [5.0,4.0,3.0,2.0]) #Promotes to Matrix
-6×6 Array{Float64,2}:
+6×6 Matrix{Float64}:
  1.0   0.0  0.0  0.0  0.0  0.0
  0.0   1.0  0.0  0.0  0.0  0.0
  0.0   5.0  1.0  0.0  0.0  0.0
@@ -129,7 +129,7 @@ julia> F*Frobenius(2, [5.0,4.0,3.0,2.0]) #Promotes to Matrix
  0.0  17.0  3.0  0.0  0.0  1.0
 
 julia> F*[10.0,20,30,40,50,60.0]
-6-element Array{Float64,1}:
+6-element Vector{Float64}:
   10.0
   20.0
   30.0
@@ -143,18 +143,7 @@ julia> F*[10.0,20,30,40,50,60.0]
 
 ```julia
 julia> A=Hilbert(5)
-Hilbert{Rational{Int64}}(5,5)
-
-julia> Matrix(A)
-5×5 Array{Rational{Int64},2}:
- 1//1  1//2  1//3  1//4  1//5
- 1//2  1//3  1//4  1//5  1//6
- 1//3  1//4  1//5  1//6  1//7
- 1//4  1//5  1//6  1//7  1//8
- 1//5  1//6  1//7  1//8  1//9
-
-julia> Matrix(Hilbert(5))
-5×5 Array{Rational{Int64},2}:
+5×5 Hilbert{Rational{Int64}}:
  1//1  1//2  1//3  1//4  1//5
  1//2  1//3  1//4  1//5  1//6
  1//3  1//4  1//5  1//6  1//7
@@ -165,7 +154,7 @@ Inverses are also integer matrices:
 
 ```julia
 julia> inv(A)
-5×5 Array{Rational{Int64},2}:
+5×5 InverseHilbert{Rational{Int64}}:
     25//1    -300//1     1050//1    -1400//1     630//1
   -300//1    4800//1   -18900//1    26880//1  -12600//1
   1050//1  -18900//1    79380//1  -117600//1   56700//1
@@ -177,23 +166,23 @@ julia> inv(A)
 ### [`Kahan` matrix](http://math.nist.gov/MatrixMarket/data/MMDELI/kahan/kahan.html)
 
 ```julia
-julia> A=Kahan(5,5,1,35)
+julia> Kahan(5,5,1,35)
 5×5 Kahan{Int64,Int64}:
  1.0  -0.540302  -0.540302  -0.540302  -0.540302
  0.0   0.841471  -0.454649  -0.454649  -0.454649
  0.0   0.0        0.708073  -0.382574  -0.382574
  0.0   0.0        0.0        0.595823  -0.321925
  0.0   0.0        0.0        0.0        0.501368
 
-julia> A=Kahan(5,3,0.5,0)
+julia> Kahan(5,3,0.5,0)
 5×3 Kahan{Float64,Int64}:
  1.0  -0.877583  -0.877583
  0.0   0.479426  -0.420735
  0.0   0.0        0.229849
  0.0   0.0        0.0
  0.0   0.0        0.0
 
-julia> A=Kahan(3,5,0.5,1e-3)
+julia> Kahan(3,5,0.5,1e-3)
 3×5 Kahan{Float64,Float64}:
  1.0  -0.877583  -0.877583  -0.877583  -0.877583
  0.0   0.479426  -0.420735  -0.420735  -0.420735
@@ -233,11 +222,11 @@ Linear Algebra and its Applications, Vol. 81, p.153-198, Sep. 1986"
 
 ### [`Strang` matrix](http://doi.org/10.1137/141000671)
 
-A special `SymTridiagonal` matrix named after Gilbert Strang
+A special symmetric, tridiagonal, Toeplitz matrix named after Gilbert Strang.
 
 ```julia
 julia> Strang(6)
-6×6 Strang{Float64}:
+6×6 Strang{Int64}:
   2  -1   0   0   0   0
  -1   2  -1   0   0   0
   0  -1   2  -1   0   0
@@ -272,9 +261,9 @@ julia> A'
 ```
 
 The backslash operator `\` is overloaded
-to solve Vandermonde and adjoint Vandermonde systems in ``O(n^2)`` time
-using the algorithm of
-[Björck & Pereyra (1970)](https://doi.org/10.2307/2004623):
+to solve Vandermonde and adjoint Vandermonde systems
+in ``O(n^2)`` time using the algorithm of
+[Björck & Pereyra (1970)](https://doi.org/10.2307/2004623).
 ```julia
 julia> A \ a
 5-element Vector{Float64}:

docs/lit/examples/1-overview.jl

@@ -1,16 +1,134 @@
-#---------------------------------------------------------
-# # [SpecialMatrices overview](@id 1-overview)
-#---------------------------------------------------------
+#=
+# [SpecialMatrices overview](@id 1-overview)
 
-# This page illustrates the Julia package
-# [`SpecialMatrices`](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl).
+This page illustrates the Julia package
+[`SpecialMatrices`](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl).
+
+This package extends the `LinearAlgebra` library
+with support for special matrices that are used in linear algebra.
+Every special matrix has its own type
+and is stored efficiently.
+Use `Matrix(A)` to access the full matrix if needed.
+
+## Related packages
+
+[ToeplitzMatrices.jl](https://github.com/JuliaLinearAlgebra/ToeplitzMatrices.jl)
+supports
+Toeplitz, Hankel, and circulant matrices.
+=#
 
 # ### Setup
 
 # Packages needed here.
 
 using SpecialMatrices
+using Polynomials
+
+
+# ## [`Cauchy` matrix](http://en.wikipedia.org/wiki/Cauchy_matrix)
+
+Cauchy(1:3, 2:4)
+
+#
+Cauchy((1., 2.), 1:3)
+
+#
+Cauchy(3)
+
+
+# ## [`Companion` matrix](http://en.wikipedia.org/wiki/Companion_matrix)
+
+Companion(1:3)
+
+# From a polynomial
+p = Polynomial(4:-1:1)
+
+#
+Companion(p)
+
+
+# ## [`Frobenius` matrix](http://en.wikipedia.org/wiki/Frobenius_matrix)
+
+F = Frobenius(3, 2:4) # Specify subdiagonals of column 3
+
+# Special form of inverse:
+inv(F)
+
+# Special form preserved if the same column has the subdiagonals
+F * F
+
+# Otherwise it promotes to a `Matrix`:
+F * Frobenius(2, 2:5)
+
+# Efficient matrix-vector multiplication:
+F * (1:6)
+
+
+# ## [`Hilbert` matrix](http://en.wikipedia.org/wiki/Hilbert_matrix)
+
+H = Hilbert(5)
+
+# Inverses are also integer matrices:
+inv(H)
+
+
+#=
+## [`Kahan` matrix](http://math.nist.gov/MatrixMarket/data/MMDELI/kahan/kahan.html)
+
+See [N. J. Higham (1987)](https://doi.org/10.1137/1029112).
+=#
+
+
+Kahan(5, 5, 1, 35)
+
+#
+Kahan(5, 3, 0.5, 0)
+
+#
+Kahan(3, 5, 0.5, 1e-3)
+
+#=
+## `Riemann` matrix
+
+A Riemann matrix is defined as
+`A = B[2:N+1, 2:N+1]`,
+where
+`B[i,j] = i-1` if `i` divides `j`, and `-1` otherwise.
+The [Riemann hypothesis](http://en.wikipedia.org/wiki/Riemann_hypothesis)
+holds if and only if
+`det(A) = O( N! N^(-1/2+ϵ))` for every `ϵ > 0`.
+
+See
+[F. Roesler (1986)](https://doi.org/10.1016/0024-3795(86)90255-7).
+=#
+
+Riemann(5)
+
+
+#=
+## [`Strang` matrix](http://doi.org/10.1137/141000671)
+
+A special symmetric, tridiagonal, Toeplitz matrix named after Gilbert Strang.
+=#
+
+Strang(5)
+
+# ## [`Vandermonde` matrix](http://en.wikipedia.org/wiki/Vandermonde_matrix)
+
+a = 1:4
+V = Vandermonde(a)
+
+# Adjoint Vandermonde:
+
+V'
 
-# ### Cauchy
+#=
+The backslash operator `\` is overloaded
+to solve Vandermonde and adjoint Vandermonde systems
+in ``O(n^2)`` time using the algorithm of
+[Björck & Pereyra (1970)](https://doi.org/10.2307/2004623).
+=#
+V \ a
 
-Cauchy(collect(1:3), collect(2:4))
+#
+V' \ V[3,:]

docs/src/index.md

@@ -6,14 +6,10 @@ CurrentModule = SpecialMatrices
 
 ## Overview
 
-This Julia module exports methods for defining
-special matrices
+The Julia module
+[SpecialMatrices.jl](https://github.com/JuliaLinearAlgebra/SpecialMatrices.jl)
+exports methods for defining special matrices
 that are used in linear algebra.
 Every special matrix has its own type. 
 
-(This documentation is under construction).
-
-See the package README
-for details.
-
 See the Examples.