Changeset b9d0f4e in git

Timestamp:

Feb 26, 2018, 3:17:40 PM (5 years ago)

Author:

Karim Abou Zeid <karim23697@…>

Branches:

(u'spielwiese', '0d6b7fcd9813a1ca1ed4220cfa2b104b97a0a003')

Children:

dc9b97b94d6347995be139057074bed6e378f7d4

Parents:

a2cd284766c6d39d5f8d6fb5b7f7f9ebf9d9cb02

Message:

Add doc for dyck, fib, tetrahedron and triangular

File:

• Singular/LIB/fpalgebras.lib (modified) (6 diffs)

Singular/LIB/fpalgebras.lib

@@ -642 +642 @@
 
 proc dyckGrp1(int n, int d, intvec P)
-"
-The Dyck group with the following presentation
-< x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
-negative exponents are allowed
-representation in the form x_i^p_i - x_(i+1)^p_(i+1)
+"USAGE: dyckGrp1(n,d,P); n an integer, d an integer, P an intvec
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - The Dyck group with the following presentation
+@*      < x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
+@*    - negative exponents are allowed
+@*    - representation in the form x_i^p_i - x_(i+1)^p_(i+1)
+@*    - d gives the degreebound for the Letterplace ring
 "
 {
@@ -682 +685 @@
 
 proc dyckGrp2(int n, int d, intvec P)
-"
-The Dyck group with the following presentation
-< x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
-negative exponents are allowed
-representation in the form x_i^p_i - 1
+"USAGE: dyckGrp2(n,d,P); n an integer, d an integer, P an intvec
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - The Dyck group with the following presentation
+@*      < x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
+@*    - negative exponents are allowed
+@*    - representation in the form x_i^p_i - 1
+@*    - d gives the degreebound for the Letterplace ring
 "
 {
@@ -723 +729 @@
 
 proc dyckGrp3(int n, int d, intvec P)
-"
-The Dyck group with the following presentation
-< x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
-only positive exponents are allowed
-no inverse generators needed
+"USAGE: dyckGrp2(n,d,P); n an integer, d an integer, P an intvec
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - The Dyck group with the following presentation
+@*      < x_1, x_2, ... , x_n | (x_1)^p1 = (x_2)^p2 = ... = (x_n)^pn = x_1 * x_2 * ... * x_n = 1 >
+@*    - only positive exponents are allowed
+@*    - no inverse generators needed
+@*    - d gives the degreebound for the Letterplace ring
 "
 {
@@ -767 +776 @@
 ////////////////////////////////////////////////////////////////////
 
-proc fibGroup(int m, int d)
-"The Fibonacci group F(2, m) with the following presentation
-< x_1, x_2, ... , x_m | x_i * x_(i + 1) = x_(i + 2) >
-TODO: basefield Q oder F2?
-inverse Elemente!
-"
+proc fibonacciGroup(int m, int d)
+"USAGE: fibonacciGroup(m,d); m an integer, d an integer
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - The Fibonacci group F(2, m) with the following presentation
+@*      < x_1, x_2, ... , x_m | x_i * x_(i + 1) = x_(i + 2) >
+@*    - d gives the degreebound for the Letterplace ring
+"
+// TODO: basefield Q oder F2?
+// TODO: inverse Elemente!
 {
  if (m < 3) {ERROR("At least three generators are required!");}
@@ -810 +823 @@
 ////////////////////////////////////////////////////////////////////
 
-proc tetrahedron (int g, int d)
-"The following examples are found in 
+proc tetrahedronGroup(int g, int d)
+"USAGE: tetrahedronGroup(g,d); g an integer, d an integer
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - g gives the number of the example
+@*    - d gives the degreebound for the Letterplace ring
+@*
+The examples are found in
 Classification of the finite generalized tetrahedron groups
 by Gerhard Rosenberger and Martin Scheer.
-The following 5 examples are denoted in Proposition 1.9 and concern
+The 5 examples are denoted in Proposition 1.9 and concern
 finite generalized tetrahedron group in the Tsarnarov-case, which are
 not equivalent to a presentation for an ordinary tetrahedron group.
-g gives the number of the example
+@*
 "
 {
@@ -864 +883 @@
 ////////////////////////////////////////////////////////////////////
 
-proc trianGrp(int g, int d)
-"The following examples are found in 
+proc triangularGroup(int g, int d)
+"USAGE: triangularGroup(g,d); g an integer, d an integer
+RETURN: ring
+NOTE: - the ring contains the ideal I, which contains the required relations
+@*    - g gives the number of the example
+@*    - d gives the degreebound for the Letterplace ring
+@*
+The examples are found in
 Classification of the finite generalized tetrahedron groups
 by Gerhard Rosenberger and Martin Scheer.
-Triangle groups, as in theorem 2.12
-g is the number of the example
+The 14 examples are denoted in theorem 2.12
+@*
 "
 {