Changeset 2808

Timestamp:

2015-06-20T22:08:23-07:00 (10 years ago)

Author:

Marek Rychlik

Message:

* empty log message *

File:

• branches/f4grobner/ring.lisp (modified) (1 diff)

branches/f4grobner/ring.lisp

@@ -74 +74 @@
 
 (defgeneric r-zerop (object)
-  (:method ((self number)) (zerop self)))
+  (:method ((self number)) (zerop self))
+  (:documentation "Tests whether a ring element is 0."))
 
 (defgeneric r+ (x y)
-  (:method ((x number) (y number)) (+ x y))) 
+  (:method ((x number) (y number)) (+ x y))
+  (:documentation "Adds ring elements.")) 
 
 (defgeneric r- (x y)
-  (:method ((x number) (y number)) (- x y))) 
+  (:method ((x number) (y number)) (- x y))
+  (:documentation "Subtracts ring elements.")) 
 
 (defgeneric r* (x y)
-  (:method ((x number) (y number)) (* x y))) 
+  (:method ((x number) (y number)) (* x y))
+  (:documentation "Multiplies ring elements.")) 
 
-(defgeneric r-tensor-product (x y))
+(defgeneric r-tensor-product (x y)
+  (:documentation "Takes a tensor product of two objects."))
 
 (defgeneric r/ (x y)
-  (:method ((x number) (y number)) (/ x y))) 
+  (:method ((x number) (y number)) (/ x y))
+  (:documentation "Divides ring elements.")) 
 
 (defgeneric r-lcm (x y)
-  (:method ((x integer) (y integer)) (lcm x y))) 
+  (:method ((x integer) (y integer)) (lcm x y))
+  (:documentation "Returns the least common multiple of ring elements.")) 
 
 (defgeneric r-expt (x y)
-  (:method ((x integer) (y integer)) (expt x y))) 
+  (:method ((x integer) (y integer)) (expt x y))
+  (:documentation "Raises X to power Y.")) 
 
 (defgeneric r-ezgcd (x y)
   (:method ((x integer) (y integer)
             &aux (c (gcd x y)))
-    (values c (/ x c) (/ y c))))
+    (values c (/ x c) (/ y c)))
+  (:documentation "Solves the diophantine system: X=C*X1, Y=C*X2, C=GCD(X,Y)"))
 
 (defgeneric r-gcd (x y)