Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add missing documentation source files #1626

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/src/manual/algebras/basics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Basics

```@meta
CurrentModule = Hecke
DocTestSetup = quote
using Hecke
end
```

## Creation of algebras

See the corresponding sections in ?????
```@docs
zero_algebra(::Field)
```

## Basic properties

```@docs
base_ring(::Hecke.AbstractAssociativeAlgebra)
basis(::Hecke.AbstractAssociativeAlgebra)
```

## Predicates

```@docs
is_zero(::Hecke.AbstractAssociativeAlgebra)
is_commutative(::Hecke.AbstractAssociativeAlgebra)
is_central(::AbstractAssociativeAlgebra)
```

## Generators

```@docs
gens(::AbstractAssociativeAlgebra)
gens_with_data(::AbstractAssociativeAlgebra)
```

## Center

```@docs
center(::Hecke.AbstractAssociativeAlgebra)
dimension_of_center(::Hecke.AbstractAssociativeAlgebra)
dimension_over_center(::Hecke.AbstractAssociativeAlgebra)
```
21 changes: 21 additions & 0 deletions docs/src/manual/algebras/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```@meta
CurrentModule = Hecke
```

# [Introduction](@id Algebras)

!!! note
The functions described in this section are experimental. While the overall
functionality provided will stay the same, names of specific functions or
conventions for the return values might change in future versions.

This section describes the functionality for finite-dimensional associative
algebras (or just *algebras* for short). Since different applications have different requirements,
the following types of algebras are implemented:
- structure constant algebras,
- matrix algebras,
- group algebras,
- quaternion algebras.

These share a common interface encompassing a wide range of functions, which is
indicated by the use of the type `AbstractAssociativeAlgebra` in the signature.
21 changes: 21 additions & 0 deletions docs/src/manual/algebras/structureconstant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Structure constant algebras

```@meta
CurrentModule = Hecke
DocTestSetup = quote
using Hecke
end
```

## Creation

```@docs
structure_constant_algebra(::Ring, ::Array{<:Any, 3})
structure_constant_algebra(::SimpleNumField)
```

## Structure constant table

```@docs
structure_constant_table(::StructureConstantAlgebra)
```
Loading