Skip to content

Commit 896212b

Browse files
doc: don't document Integers as filter (semigroups#1157)
* doc: don't document Integers as filter This should resolve semigroups#1155 * maxplusmat: fix doc typo * Fix maxplus matrix docs --------- Co-authored-by: Codex <codex@openai.com>
1 parent ce28b61 commit 896212b

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

doc/maxplusmat.xml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,10 @@
2020
<!-- <Filt Name = "IsProjectiveMaxPlusMatrix" Arg = "obj" Type =
2121
"Category"/> -->
2222
<Filt Name = "IsNTPMatrix" Arg = "obj" Type = "Category"/>
23-
<Filt Name = "Integers" Arg = "obj" Type = "Category"/>
2423
<Returns><K>true</K> or <K>false</K>.</Returns>
2524
<Description>
2625
Every matrix over a semiring in &SEMIGROUPS; is a member of one of these
27-
categories, which are subcategory of <Ref Filt = "IsMatrixOverSemiring"/>.
26+
categories, which are subcategories of <Ref Filt = "IsMatrixOverSemiring"/>.
2827
<P/>
2928

3029
<C>IsTropicalMatrix</C> is a supercategory of
@@ -37,7 +36,7 @@
3736
BookName="ref"/>, the underlying list of lists used to create the
3837
matrix can be accessed using <Ref Attr = "AsList"/>, the rows of
3938
<C>mat</C> can be accessed using <C>mat[i]</C> where <C>i</C> is between
40-
<C>1</C> and the dimension of the matrix, it also possible to loop over
39+
<C>1</C> and the dimension of the matrix, it is also possible to loop over
4140
the rows of a matrix; for tropical matrices <Ref
4241
Attr = "ThresholdTropicalMatrix"/>; for ntp matrices <Ref
4342
Attr = "ThresholdNTPMatrix"/> and <Ref Attr = "PeriodNTPMatrix"/>.
@@ -180,13 +179,14 @@ gap> PeriodNTPMatrix(mat);
180179
<Oper Name = "InverseOp" Arg = "mat" Label = "for an integer matrix"/>
181180
<Returns>An integer matrix.</Returns>
182181
<Description>
183-
If <A>mat</A> is an integer matrix (i.e. belongs to the category
184-
<Ref Filt = "Integers"/>) whose inverse (if it exists) is also an
185-
integer matrix, then <C>InverseOp</C> returns the inverse of <A>mat</A>.
182+
If <A>mat</A> is an integer matrix whose inverse (if it exists) is also
183+
an integer matrix (i.e. a matrix whose <Ref Attr="BaseDomain"
184+
BookName="ref"/> is <Ref Var= "Integers" BookName="ref"/>), then
185+
<C>InverseOp</C> returns the inverse of <A>mat</A>.
186186
<P/>
187187

188188
An integer matrix has an integer matrix inverse if and only if it
189-
has determinant one.
189+
has determinant <M>\pm 1</M>.
190190
<Example><![CDATA[
191191
gap> mat := Matrix(Integers, [[0, 0, -1],
192192
> [0, 1, 0],
@@ -206,9 +206,10 @@ true
206206
<Attr Name = "IsTorsion" Arg = "mat" Label = "for an integer matrix"/>
207207
<Returns><K>true</K> or <K>false</K></Returns>
208208
<Description>
209-
If <A>mat</A> is an integer matrix (i.e. belongs to the
210-
category <Ref Filt = "Integers"/>), then <C>IsTorsion</C> returns
211-
<K>true</K> if <A>mat</A> is torsion and <K>false</K> otherwise. <P/>
209+
If <A>mat</A> is an integer matrix (i.e. a matrix whose <Ref
210+
Attr="BaseDomain" BookName="ref"/> is <Ref Var= "Integers"
211+
BookName="ref"/>), then <C>IsTorsion</C> returns <K>true</K> if
212+
<A>mat</A> is torsion and <K>false</K> otherwise. <P/>
212213

213214
An integer matrix <A>mat</A> is torsion if and only if there exists an
214215
integer <C>n</C> such that <A>mat</A> to the power of <C>n</C> is
@@ -238,7 +239,7 @@ false
238239
<Attr Name = "Order" Arg = "mat"/>
239240
<Returns>An integer or <C>infinity</C>.</Returns>
240241
<Description>
241-
If <A>mat</A> is an integer matrix, then <C>InverseOp</C> returns the
242+
If <A>mat</A> is an integer matrix, then <C>Order</C> returns the
242243
order of <A>mat</A>. The order of <A>mat</A> is the smallest integer
243244
power of <A>mat</A> equal to the identity. If no such integer exists, the
244245
order is equal to <C>infinity</C>.

0 commit comments

Comments
 (0)