Skip to content

Commit e11fa6d

Browse files
committed
Documentation
1 parent 0203bb3 commit e11fa6d

4 files changed

Lines changed: 26 additions & 0 deletions

File tree

Generics.mag

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ declare attributes PadExactElt
2323
declare type Val_PadExactElt;
2424

2525
///# Internals
26+
///
27+
///toc
28+
///
2629
///## Generic interface
2730
///
2831
/// The type `StrPadExact` is for structures whose elements are in terms of Exact p-adic numbers. Examples of subtypes include `FldPadExact` for p-adic fields, `RngUPol_FldPadExact` for polynomials over p-adic fields, `SetCart_PadExact` for cartesian products of such structures. Elements of such structures have type deriving from `PadExactElt`.

Tuples.mag

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
///# Aggregates
22
///
33
/// Sometimes a collection of p-adic objects are highly related and should share a single update function. For example, if we Hensel-lift a system of roots of a system of multivariate polynomials, then updating one element of the system requires updating them all. In this case, we represent the whole aggregation as a single p-adic object.
4+
///
5+
///toc
46

57
import "ExactpAdics.mag": NEXTID;
68
Z := Integers();

docs/aggregates.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33

44
Sometimes a collection of p-adic objects are highly related and should share a single update function. For example, if we Hensel-lift a system of roots of a system of multivariate polynomials, then updating one element of the system requires updating them all. In this case, we represent the whole aggregation as a single p-adic object.
55

6+
7+
**Contents**
8+
* [Tuples](#tuples)
9+
* [Cartesian products](#cartesian-products)
10+
* [Creation of tuples](#creation-of-tuples)
11+
* [Basic operations](#basic-operations)
12+
613
## Tuples
714

815
### Cartesian products

docs/internals.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Internals
22

3+
4+
5+
**Contents**
6+
* [Generic interface](#generic-interface)
7+
* [Getters](#getters)
8+
* [Overview](#overview)
9+
* [Creation](#creation)
10+
* [Evaluation](#evaluation)
11+
* [Composition](#composition)
12+
* [Reductions](#reductions)
13+
* [Short-circuit reductions](#short-circuit-reductions)
14+
* [ExtDataFldPadExact](#extdatafldpadexact)
15+
16+
317
## Generic interface
418

519

0 commit comments

Comments
 (0)