Add doc

JuliaAlgebra · Dec 15, 2024 · 2f0f302 · 2f0f302
1 parent 114a86a
commit 2f0f302
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 6 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -15,6 +15,13 @@ maxdegree_basis
 explicit_basis_covering
 ```
 
+## Basis elements
+
+```@docs
+Polynomial
+SemisimpleElement
+```
+
 ## Monomial basis
 
 ```@docs
@@ -40,3 +47,10 @@ ChebyshevFirstKind
 ChebyshevSecondKind
 Trigonometric
 ```
+
+## Additional basis
+
+```@docs
+FixedBasis
+SemisimpleBasis
+```
diff --git a/src/fixed.jl b/src/fixed.jl
@@ -1,3 +1,11 @@
+"""
+    struct FixedBasis{B,M,T,V} <:
+        SA.ExplicitBasis{SA.AlgebraElement{Algebra{FullBasis{B,M},B,M},T,V},Int}
+        elements::Vector{SA.AlgebraElement{Algebra{FullBasis{B,M},B,M},T,V}}
+    end
+
+Fixed basis with polynomials `elements`.
+"""
 struct FixedBasis{B,M,T,V} <:
        SA.ExplicitBasis{SA.AlgebraElement{Algebra{FullBasis{B,M},B,M},T,V},Int}
     elements::Vector{SA.AlgebraElement{Algebra{FullBasis{B,M},B,M},T,V}}
@@ -13,18 +21,33 @@ function Base.show(io::IO, b::FixedBasis)
     return
 end
 
+"""
+    struct SemisimpleBasis{T,I,B<:SA.ExplicitBasis{T,I}} <: SA.ExplicitBasis{T,I}
+        bases::Vector{B}
+    end
+
+Semisimple basis for use with [SymbolicWedderburn](https://github.com/kalmarek/SymbolicWedderburn.jl/).
+Its elements are of [`SemisimpleElement`](@ref)s.
+"""
 struct SemisimpleBasis{T,I,B<:SA.ExplicitBasis{T,I}} <: SA.ExplicitBasis{T,I}
     bases::Vector{B}
 end
 
 Base.length(b::SemisimpleBasis) = length(first(b.bases))
 
-struct MultiPoly{P}
-    polynomials::Vector{P}
+"""
+    struct SemisimpleElement{P}
+        polynomials::Vector{P}
+    end
+
+Elements of [`SemisimpleBasis`](@ref).
+"""
+struct SemisimpleElement{P}
+    elements::Vector{P}
 end
-SA.star(p::MultiPoly) = MultiPoly(SA.star.(p.polynomials))
+SA.star(p::SemisimpleElement) = SemisimpleElement(SA.star.(p.polynomials))
 
-Base.getindex(b::SemisimpleBasis, i::Integer) = MultiPoly(getindex.(b.bases, i))
+Base.getindex(b::SemisimpleBasis, i::Integer) = SemisimpleElement(getindex.(b.bases, i))
 
 function Base.show(io::IO, b::SemisimpleBasis)
     if length(b.bases) == 1

diff --git a/test/fixed.jl b/test/fixed.jl
@@ -21,7 +21,7 @@ using DynamicPolynomials
     @test sprint(show, semi) ==
           "Semisimple basis with 2 simple sub-bases:\n  FixedBasis([$p1])\n  FixedBasis([$p2])"
     mult = semi[1]
-    @test all(mult.polynomials .≈ [p1, p2])
+    @test all(mult.elements .≈ [p1, p2])
     smult = SA.star(mult)
-    @test all(smult.polynomials .≈ [p2, p1])
+    @test all(smult.elements .≈ [p2, p1])
 end