Edit docs

semigroups · Mar 26, 2024 · df1cc98 · df1cc98
1 parent cfda100
commit df1cc98
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 2 deletions.
diff --git a/doc/ideals.xml b/doc/ideals.xml
@@ -98,6 +98,64 @@ gap> I := SemigroupIdeal(S, I, Idempotents(S));
   </ManSection>
 <#/GAPDoc>
 
+<#GAPDoc Label="LeftSemigroupIdeal">
+  <ManSection>
+    <Func Name = "LeftSemigroupIdeal" Arg = "S, obj1, obj2, .. . "/>
+    <Returns>
+      A left ideal of a semigroup.
+    </Returns>
+    <Description>
+      If <A>obj1</A>, <A>obj2</A>, .. . are (any combination) of elements of the
+      semigroup <A>S</A> or collections of elements of <A>S</A> (including
+      subsemigroups and ideals of <A>S</A>),  then <C>LeftSemigroupIdeal</C> returns the
+      left ideal of the semigroup <A>S</A> generated by the union of
+      <A>obj1</A>,  <A>obj2</A>, .. .. <P/>
+
+      The <Ref Func = "Parent" BookName = "ref"/> of the ideal returned by this
+      function is <A>S</A>.
+
+      <Example><![CDATA[
+gap> S := SymmetricInverseMonoid(10);
+<symmetric inverse monoid of degree 10>
+gap> I := LeftSemigroupIdeal(S, PartialPerm([1, 2]));
+<inverse partial perm semigroup ideal of rank 10 with 1 generator>
+gap> Size(I);
+4151
+gap> I := LeftSemigroupIdeal(S, I, Idempotents(S));
+<inverse partial perm semigroup ideal of rank 10 with 1025 generators>]]></Example>
+    </Description>
+  </ManSection>
+<#/GAPDoc>
+
+<#GAPDoc Label="RightSemigroupIdeal">
+  <ManSection>
+    <Func Name = "RightSemigroupIdeal" Arg = "S, obj1, obj2, .. . "/>
+    <Returns>
+      A Right ideal of a semigroup.
+    </Returns>
+    <Description>
+      If <A>obj1</A>, <A>obj2</A>, .. . are (any combination) of elements of the
+      semigroup <A>S</A> or collections of elements of <A>S</A> (including
+      subsemigroups and ideals of <A>S</A>),  then <C>RightSemigroupIdeal</C> returns the
+      Right ideal of the semigroup <A>S</A> generated by the union of
+      <A>obj1</A>,  <A>obj2</A>, .. .. <P/>
+
+      The <Ref Func = "Parent" BookName = "ref"/> of the ideal returned by this
+      function is <A>S</A>.
+
+      <Example><![CDATA[
+gap> S := SymmetricInverseMonoid(10);
+<symmetric inverse monoid of degree 10>
+gap> I := RightSemigroupIdeal(S, PartialPerm([1, 2]));
+<inverse partial perm semigroup ideal of rank 10 with 1 generator>
+gap> Size(I);
+4151
+gap> I := RightSemigroupIdeal(S, I, Idempotents(S));
+<inverse partial perm semigroup ideal of rank 10 with 1025 generators>]]></Example>
+    </Description>
+  </ManSection>
+<#/GAPDoc>
+
 <#GAPDoc Label="SupersemigroupOfIdeal">
   <ManSection>
     <Attr Name = "SupersemigroupOfIdeal" Arg = "I"/>

diff --git a/doc/z-chap09.xml b/doc/z-chap09.xml
@@ -29,6 +29,8 @@
     </Heading>
 
     <#Include Label = "SemigroupIdeal">
+    <#Include Label = "LeftSemigroupIdeal">
+    <#Include Label = "RightSemigroupIdeal">
     <#Include Label = "Ideals">
   </Section>
 

diff --git a/gap/ideals/froidure-pin.gi b/gap/ideals/froidure-pin.gi
@@ -44,7 +44,7 @@ InstallMethod(PositionsInSupersemigroup,
 [IsLeftSemigroupIdeal and HasGeneratorsOfSemigroupIdeal and
  CanUseFroidurePin],
 function(I)
-  local S, L, R, D, result, pos, x;
+  local S, L, result, pos, x;
   S := SupersemigroupOfIdeal(I);
   L := LeftCayleyDigraph(S);
 
@@ -65,7 +65,7 @@ InstallMethod(PositionsInSupersemigroup,
 [IsRightSemigroupIdeal and HasGeneratorsOfSemigroupIdeal and
  CanUseFroidurePin],
 function(I)
-  local S, L, R, D, result, pos, x;
+  local S, R, result, pos, x;
   S := SupersemigroupOfIdeal(I);
   R := RightCayleyDigraph(S);