Skip to content

Commit

Permalink
standard doc is better for AbstractGramMatrix
Browse files Browse the repository at this point in the history
  • Loading branch information
MikaelSlevinsky committed Nov 1, 2024
1 parent 48ce507 commit 69b7317
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 10 deletions.
4 changes: 0 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ For this documentation, please see the documentation for [FastTransforms](https:

### Fast Cholesky factorization of the Gram matrix

```@docs
AbstractGramMatrix
```

```@docs
GramMatrix
```
Expand Down
7 changes: 1 addition & 6 deletions src/GramMatrix.jl
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
"""
AbstractGramMatrix
Supertype of Gram matrices such as [`GramMatrix`](@ref) and [`ChebyshevGramMatrix`](@ref).
"""
abstract type AbstractGramMatrix{T} <: LayoutMatrix{T} end

@inline issymmetric(G::AbstractGramMatrix) = true
Expand All @@ -23,7 +18,7 @@ the Gram matrix satisfies the skew-symmetric rank-2 displacement equation (``X =
```math
X^\\top W - WX = GJG^\\top,
```
where ``J = \\begin{pmatrix} 0 & 1\\ -1 & 0\\end{pmatrix}`` and where:
where ``J = \\begin{pmatrix} 0 & 1\\\\ -1 & 0\\end{pmatrix}`` and where:
```math
G_{:, 1} = e_n,\\quad{\\rm and}\\quad G_{:, 2} = W_{n-1, :}X_{n-1, n} - X^\\top W_{:, n}.
```
Expand Down

0 comments on commit 69b7317

Please sign in to comment.