Skip to content

Commit

Permalink
docs: Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
limakzi committed Apr 28, 2024
1 parent 46c0e9e commit 5096e98
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions lib/utils.gd
Original file line number Diff line number Diff line change
Expand Up @@ -128,32 +128,56 @@ DeclareGlobalFunction( "LeftOrder" );
#! returns a right order of element <A>m</A>.
DeclareGlobalFunction( "RightOrder" );

#! @Arguments [M]
#! @Arguments M
#! @Description
#! if magma is left cyclic <A>m</A>.
DeclareGlobalFunction( "IsLeftCyclic" );

#! @Arguments [M]
#! @Arguments M
#! @Description
#! if magma is left cyclic <A>m</A>.
DeclareGlobalFunction( "IsRightCyclic" );

#! @Arguments [M]
#! @Arguments M
#! @Description
#! if magma is right cancellative <A>m</A>.
#!
#! @BeginExampleSession
#! gap> List(AllSmallAntimagmas(2), M -> IsRightCancellative(M));
#! [ false, true ]
#! @EndExampleSession
#!
DeclareGlobalFunction( "IsRightCancellative" );

#! @Arguments [M]
#! @Arguments M
#! @Description
#! if magma is left cancellative <A>m</A>.
#!
#! @BeginExampleSession
#! gap> M := SmallAntimagma(2, 1);
#! <magma with 2 generators>
#! gap> Display( MultiplicationTable(M) );
#! [ [ 2, 1 ],
#! [ 2, 1 ] ]
#! gap> IsRightCancellative(M);
#! false
#! gap> IsLeftCancellative(M);
#! true
#! gap> List(AllSmallAntimagmas(2), M -> IsLeftCancellative(M));
#! [ true, false ]
#! @EndExampleSession
#!
DeclareGlobalFunction( "IsLeftCancellative" );

#! @Arguments [m, k]
#! @Arguments M
#! @Description
#! if magma is cancellative <A>m</A>.
#!
#! @BeginExampleSession
#! gap> List(AllSmallAntimagmas(2), M -> IsCancellative(M));
#! [ false, false ]
#! @EndExampleSession
#!
DeclareGlobalFunction( "IsCancellative" );

#! @Arguments [M]
Expand Down

0 comments on commit 5096e98

Please sign in to comment.