Skip to content

Commit

Permalink
Add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
lgoettgens committed Jul 12, 2024
1 parent 705e167 commit 6996998
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/Rings/AbelianClosure.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ import Hecke: conductor, data
#
################################################################################

@doc raw"""
QQAbField
The type of the abelian closure of the rationals. An object of this type can
be constructed using [`abelian_closure(::QQField)`](@ref).
"""
@attributes mutable struct QQAbField{T} <: Nemo.Field # union of cyclotomic fields
fields::Dict{Int, T} # Cache for the cyclotomic fields
s::String
Expand All @@ -59,6 +65,12 @@ end
const _QQAb = QQAbField{AbsSimpleNumField}(Dict{Int, AbsSimpleNumField}())
const _QQAb_sparse = QQAbField{AbsNonSimpleNumField}(Dict{Int, AbsNonSimpleNumField}())

@doc raw"""
QQAbFieldElem
Element type for the abelian closure of the rationals.
For more details see [`abelian_closure(::QQField)`](@ref).
"""
mutable struct QQAbFieldElem{T} <: Nemo.FieldElem
data::T # Element in cyclotomic field
c::Int # Conductor of field
Expand Down

0 comments on commit 6996998

Please sign in to comment.