Skip to content

Commit e138d33

Browse files
james-d-mitchelljames-d-mitchell
committed
doc: remove or include unused doc
1 parent 551e966 commit e138d33

8 files changed

Lines changed: 11 additions & 179 deletions

File tree

‎doc/attr.xml‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1484,27 +1484,3 @@ gap> MinimalFaithfulTransformationDegree(S);
14841484
</Description>
14851485
</ManSection>
14861486
<#/GAPDoc>
1487-
1488-
# The following documentation is included but there are actually no
1489-
# implementations for this as of yet, and so we don't link this into the
1490-
# documentation.
1491-
1492-
<#GAPDoc Label="MinimalFaithfulTransformationRepresentation">
1493-
<ManSection>
1494-
<Attr Name="MinimalFaithfulTransformationRepresentation" Arg="S"/>
1495-
<Returns>An isomorphism to a transformation semigroup.</Returns>
1496-
<Description>
1497-
This function returns an isomorphism to a transformation semigroup of
1498-
minimal degree that is isomorphic to <A>S</A>. This is currently only
1499-
implemented for a very small number of types of semigroups. <P/>
1500-
1501-
See also <Ref Attr="MinimalFaithfulTransformationDegree"/>.
1502-
1503-
<Example><![CDATA[
1504-
gap> S := RightZeroSemigroup(10);
1505-
gap> MinimalFaithfulTransformationRepresentation(S);
1506-
TODO
1507-
]]></Example>
1508-
</Description>
1509-
</ManSection>
1510-
<#/GAPDoc>

‎doc/cong.xml‎

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -204,50 +204,6 @@ gap> RightSemigroupCongruence(S, pair1, pair2);
204204
</ManSection>
205205
<#/GAPDoc>
206206

207-
<!--
208-
<#GAPDoc Label="GeneratingPairsOfSemigroupCongruence">
209-
<ManSection>
210-
<Attr Name = "GeneratingPairsOfSemigroupCongruence" Arg = "cong"/>
211-
<Attr Name = "GeneratingPairsOfLeftSemigroupCongruence" Arg = "cong"/>
212-
<Attr Name = "GeneratingPairsOfRightSemigroupCongruence" Arg = "cong"/>
213-
<Returns>A list of lists.</Returns>
214-
<Description>
215-
If <A>cong</A> is a semigroup congruence, then
216-
<C>GeneratingPairsOfSemigroupCongruence</C> returns a list of pairs of
217-
elements from <C>Range(<A>cong</A>)</C> that <E>generates</E> the
218-
congruence; i.e. <A>cong</A> is the least congruence on the semigroup
219-
which contains all the pairs in the list. <P/>
220-
221-
If <A>cong</A> is a left or right semigroup congruence, then
222-
<C>GeneratingPairsOfLeft/RightSemigroupCongruence</C> will instead give a
223-
list of pairs which generate it as a left or right congruence. Note that,
224-
although a congruence is also a left and right congruence, its generating
225-
pairs as a left or right congruence may differ from its generating pairs
226-
as a two-sided congruence. <P/>
227-
228-
A congruence can be defined using a set of generating pairs: see
229-
<Ref Func = "SemigroupCongruence"/>,
230-
<Ref Func = "LeftSemigroupCongruence"/>, and
231-
<Ref Func = "RightSemigroupCongruence"/>. <P/>
232-
233-
<Example><![CDATA[
234-
gap> S := Semigroup([Transformation([3, 3, 2, 3]),
235-
> Transformation([3, 4, 4, 1])]);;
236-
gap> pairs :=
237-
> [[Transformation([1, 1, 1, 1]), Transformation([2, 2, 2, 3])],
238-
> [Transformation([2, 2, 3, 2]), Transformation([3, 3, 2, 3])]];;
239-
gap> cong := SemigroupCongruence(S, pairs);;
240-
gap> GeneratingPairsOfSemigroupCongruence(cong);
241-
[ [ Transformation( [ 1, 1, 1, 1 ] ),
242-
Transformation( [ 2, 2, 2, 3 ] ) ],
243-
[ Transformation( [ 2, 2, 3, 2 ] ),
244-
Transformation( [ 3, 3, 2, 3 ] ) ] ]
245-
]]></Example>
246-
</Description>
247-
</ManSection>
248-
<#/GAPDoc>
249-
-->
250-
251207
<#GAPDoc Label="CongruencesOfSemigroup">
252208
<ManSection>
253209
<Attr Name = "CongruencesOfSemigroup" Arg = "S"

‎doc/properties.xml‎

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -461,31 +461,6 @@ true]]></Example>
461461
</ManSection>
462462
<#/GAPDoc>
463463

464-
<#GAPDoc Label="IsInverseSemigroup">
465-
<ManSection>
466-
<Prop Name="IsInverseSemigroup" Arg="S"/>
467-
<Prop Name="IsInverseMonoid" Arg="S"/>
468-
<Returns><K>true</K> or <K>false</K>.</Returns>
469-
<Description>
470-
If <A>S</A> is a semigroup, then <C>IsInverseSemigroup</C> returns
471-
<K>true</K> if <A>S</A> is an inverse semigroup and <K>false</K> if it is
472-
not. If <A>S</A> is a monoid, then <C>IsInverseMonoid</C> returns <K>true</K>
473-
if <A>S</A> is an inverse monoid and <K>false</K> if it is not.<P/>
474-
475-
A semigroup is an <E>inverse semigroup</E> if every element
476-
<C>x</C> has a unique semigroup inverse, that is, a unique
477-
element <C>y</C> such that <C>x * y * x = x</C> and <C>y * x * y = y</C>.
478-
479-
<Example><![CDATA[
480-
gap> S := Semigroup(Transformation([1, 2, 4, 5, 6, 3]),
481-
> Transformation([3, 3, 4, 5, 6, 2]),
482-
> Transformation([1, 2, 5, 3, 6, 8, 4, 4]));
483-
gap> IsInverseSemigroup(S);
484-
true]]></Example>
485-
</Description>
486-
</ManSection>
487-
<#/GAPDoc>
488-
489464
<#GAPDoc Label="IsLeftSimple">
490465
<ManSection>
491466
<Prop Name = "IsLeftSimple" Arg = "S"/>

‎doc/semiffmat.xml‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,6 @@
88
#############################################################################
99
##
1010

11-
<#GAPDoc Label="IsMatrixOverFiniteFieldSemigroup">
12-
<ManSection>
13-
<Prop Name="IsMatrixOverFiniteFieldSemigroup" Arg="S"/>
14-
<Prop Name="IsMatrixOverFiniteFieldMonoid" Arg="S"/>
15-
<Returns><K>true</K> or <K>false</K>.</Returns>
16-
<Description>
17-
A <E>matrix semigroup</E> is simply a semigroup consisting of
18-
matrices over a finite field. An object in &GAP; is a matrix semigroup if
19-
it satisfies <Ref Prop="IsSemigroup" BookName="ref"/> and
20-
<Ref Filt = "IsMatrixOverFiniteFieldCollection"/>. <P/>
21-
22-
A <E>matrix monoid</E> is simply a monoid consisting of
23-
matrices over a finite field. An object in &GAP; is a matrix monoid if
24-
it satisfies <Ref Prop="IsMonoid" BookName="ref"/> and
25-
<Ref Filt = "IsMatrixOverFiniteFieldCollection"/>. <P/>
26-
27-
Note that it is possible for a matrix semigroup to have a
28-
multiplicative neutral element (i.e. an identity element) but not to
29-
satisfy <C>IsMatrixOverFiniteFieldMonoid</C>.
30-
</Description>
31-
</ManSection>
32-
<#/GAPDoc>
33-
34-
<#GAPDoc Label="MatrixSemigroup">
35-
<ManSection>
36-
<Func Name="MatrixSemigroup" Arg="list [, F]"/>
37-
<Returns>A matrix semigroup.</Returns>
38-
<Description>
39-
This is a helper function to create matrix semigroups from &GAP; matrices.
40-
The argument <A>list</A> is a homogeneous list of &GAP; matrices over a
41-
finite field, and the optional argument <A>F</A> is a finite field.<P/>
42-
43-
The specification of the field <A>F</A> can be necessary to prevent
44-
&GAP; from trying to find a smaller common field for the entries in
45-
<A>list</A>.
46-
<Example><![CDATA[
47-
gap> S := Semigroup([
48-
> Matrix(GF(9), Z(3) * [[1, 0, 0], [1, 1, 0], [0, 1, 0]]),
49-
> Matrix(GF(9), Z(3) * [[0, 0, 0], [0, 0, 1], [0, 1, 0]])]);
50-
<semigroup of 3x3 matrices over GF(3^2) with 2 generators>
51-
gap> S := Semigroup([
52-
> Matrix(GF(3), Z(3) * [[1, 0, 0], [1, 1, 0], [0, 1, 0]]),
53-
> Matrix(GF(3), Z(3) * [[0, 0, 0], [0, 0, 1], [0, 1, 0]])]);
54-
<semigroup of 3x3 matrices over GF(3) with 2 generators>
55-
gap> S := Semigroup([
56-
> Matrix(GF(4), Z(4) * [[1, 0, 0], [1, 1, 0], [0, 1, 0]]),
57-
> Matrix(GF(4), Z(4) * [[0, 0, 0], [0, 0, 1], [0, 1, 0]])]);
58-
<semigroup of 3x3 matrices over GF(2^2) with 2 generators>]]></Example>
59-
</Description>
60-
</ManSection>
61-
<#/GAPDoc>
62-
6311
<#GAPDoc>
6412
<ManSection>
6513
<Attr Name="DegreeOfMatrixSemigroup" Arg="S"/>

‎doc/semipbr.xml‎

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -85,35 +85,6 @@ gap> DegreeOfPBRSemigroup(S);
8585
</ManSection>
8686
<#/GAPDoc>
8787

88-
<#GAPDoc Label="IsomorphismPBRSemigroup">
89-
<ManSection>
90-
<Attr Name = "IsomorphismPBRSemigroup" Arg = "S"/>
91-
<Returns>An isomorphism.</Returns>
92-
<Description>
93-
If <A>S</A> is a semigroup, then <C>IsomorphismPBRSemigroup</C> returns
94-
an isomorphism from <A>S</A> to a PBR semigroup. When <A>S</A> is a
95-
transformation or bipartition semigroup of degree <C>n</C>,
96-
<C>IsomorphismPBRSemigroup</C> returns the
97-
natural embedding of <A>S</A> into the full PBR monoid on <C>n</C>
98-
points. <P/>
99-
100-
When <A>S</A> is any other type of semigroup, this function returns the
101-
composition of an isomorphism from <A>S</A> to a transformation
102-
semigroup, and an isomorphism from that transformation semigroup into a
103-
PBR semigroup.
104-
<P/>
105-
106-
See <Ref Oper = "AsPBRSemigroup"/>.
107-
<Example><![CDATA[
108-
gap> S := InverseSemigroup([
109-
> PartialPerm([2, 6, 7, 0, 0, 9, 0, 1, 0, 5]),
110-
> PartialPerm([3, 8, 1, 9, 0, 4, 10, 5, 0, 6])]);;
111-
gap> AsSemigroup(IsPBRSemigroup, S);
112-
<pbr semigroup of degree 11 with 4 generators>]]></Example>
113-
</Description>
114-
</ManSection>
115-
<#/GAPDoc>
116-
11788
<#GAPDoc Label="FullPBRMonoid">
11889
<ManSection>
11990
<Oper Name = "FullPBRMonoid" Arg = "n"/>

‎doc/z-chap05.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,9 @@
319319
<Item>
320320
<Ref Filt = "IsXMatrixSemigroup"/>
321321
</Item>
322+
<Item>
323+
<Ref Filt = "IsXMatrixMonoid"/>
324+
</Item>
322325
<Item>
323326
<Ref Prop = "IsFinite"/>
324327
</Item>

‎doc/z-chap08.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
<#Include Label = "SemilatticeOfStrongSemilatticeOfSemigroups">
6666
<#Include Label = "SemigroupsOfStrongSemilatticeOfSemigroups">
6767
<#Include Label = "HomomorphismsOfStrongSemilatticeOfSemigroups">
68+
<#Include Label = "UnderlyingSemilatticeOfSemigroups">
6869
</Section>
6970

7071
<!--**********************************************************************-->

‎doc/z-chap12.xml‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,32 @@
2424
<#Include Label = "IsCompletelyRegularSemigroup">
2525
<#Include Label = "IsCongruenceFreeSemigroup">
2626
<#Include Label = "IsCryptoGroup">
27-
<#Include Label = "IsSurjectiveSemigroup">
2827
<#Include Label = "IsGroupAsSemigroup">
2928
<#Include Label = "IsIdempotentGenerated">
3029
<#Include Label = "IsLeftSimple">
3130
<#Include Label = "IsLeftZeroSemigroup">
32-
<#Include Label = "IsMonogenicSemigroup">
3331
<#Include Label = "IsMonogenicMonoid">
32+
<#Include Label = "IsMonogenicSemigroup">
3433
<#Include Label = "IsMonoidAsSemigroup">
3534
<#Include Label = "IsOrthodoxSemigroup">
35+
<#Include Label = "IsRTrivial">
3636
<#Include Label = "IsRectangularBand">
3737
<#Include Label = "IsRectangularGroup">
3838
<#Include Label = "IsRegularSemigroup">
3939
<#Include Label = "IsRightZeroSemigroup">
40-
<#Include Label = "IsRTrivial">
40+
<#Include Label = "IsSelfDualSemigroup">
4141
<#Include Label = "IsSemigroupWithAdjoinedZero">
42-
<#Include Label = "IsSemilattice">
42+
<#Include Label = "IsSemigroupWithClosedIdempotents">
43+
<#Include Label = "IsSemigroupWithCommutingIdempotents">
44+
<#Include Label = "IsSemilattice">
4345
<#Include Label = "IsSimpleSemigroup">
46+
<#Include Label = "IsSurjectiveSemigroup">
4447
<#Include Label = "IsSynchronizingSemigroup">
4548
<#Include Label = "IsUnitRegularMonoid">
4649
<#Include Label = "IsZeroGroup">
4750
<#Include Label = "IsZeroRectangularBand">
4851
<#Include Label = "IsZeroSemigroup">
4952
<#Include Label = "IsZeroSimpleSemigroup">
50-
<#Include Label = "IsSelfDualSemigroup">
5153
</Section>
5254

5355
<Section>

0 commit comments

Comments
 (0)