close Warning: Can't synchronize with repository "(default)" (The repository directory has changed, you should resynchronize the repository with: trac-admin $ENV repository resync '(default)'). Look in the Trac log for more information.

source: branches/f4grobner/ring.lisp@ 3170

Last change on this file since 3170 was 3139, checked in by Marek Rychlik, 9 years ago

* empty log message *

File size: 8.7 KB
Line 
1;;; -*- mode: lisp; package: maxima; syntax: common-lisp; base: 10 -*-
2;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3;;;
4;;; copyright (c) 1999, 2002, 2009, 2015 marek rychlik <rychlik@u.arizona.edu>
5;;;
6;;; this program is free software; you can redistribute it and/or modify
7;;; it under the terms of the gnu general public license as published by
8;;; the free software foundation; either version 2 of the license, or
9;;; (at your option) any later version.
10;;;
11;;; this program is distributed in the hope that it will be useful,
12;;; but without any warranty; without even the implied warranty of
13;;; merchantability or fitness for a particular purpose. see the
14;;; gnu general public license for more details.
15;;;
16;;; you should have received a copy of the gnu general public license
17;;; along with this program; if not, write to the free software
18;;; foundation, inc., 59 temple place - suite 330, boston, ma 02111-1307, usa.
19;;;
20;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
21
22(defpackage "RING"
23 (:use :cl)
24 (:export "R-PARSE"
25 "UNIT-ELEMENT"
26 "R-ZEROP"
27 "R+"
28 "R-"
29 "R*"
30 "R+"
31 "R/"
32 "R-EXPT"
33 "R-LCM"
34 "R-EZGCD"
35 "R-GCD"
36 "R-TOTAL-DEGREE"
37 "R-DIMENSION"
38 "R-EXPONENTS"
39 "R-COEFF"
40 "R-SUGAR"
41 "R-DIVIDES-P"
42 "R-DIVIDES-LCM-P"
43 "R-LCM-DIVIDES-LCM-P"
44 "R-LCM-EQUAL-LCM-P"
45 "R-REL-PRIME-P"
46 "R-EQUALP"
47 "R-CLONE"
48 "R-ELT"
49 "R->LIST"
50 "R-DIVISIBLE-BY-P"
51 "R-REL-PRIME-P"
52 "R-DEPENDS-P"
53 "LEFT-TENSOR-PRODUCT-BY"
54 "RIGHT-TENSOR-PRODUCT-BY"
55 "LEFT-CONTRACT"
56 "R-LENGTH"
57 "MULTIPLY-BY"
58 "DIVIDE-BY"
59 "ADD-TO"
60 "SUBTRACT-FROM"
61 "UNARY-MINUS"
62 "SCALAR"
63 "SCALAR-COEFF"
64 "INSERT-ITEM"
65 "APPEND-ITEM"
66 "COPY-INSTANCE")
67 (:shadowing-import-from
68 #+openmcl-native-threads #:ccl
69 #+cmu #:pcl
70 #+sbcl #:sb-pcl
71 #+lispworks #:hcl
72 #+allegro #:mop
73 #+clisp #:clos
74 #:class-slots #:slot-definition-name)
75 (:documentation
76 "Implements ring operations. These are all operations that are
77performed on the coefficients by the package, and thus the coefficient
78ring can be changed by merely redefining these operations."))
79
80(in-package :ring)
81
82(defclass scalar ()
83 ((coeff :initarg :coeff :accessor scalar-coeff))
84 (:default-initargs :coeff nil)
85 (:documentation "Wraps objects suitable as scalars/polynomial coefficients"))
86
87(defgeneric unit-element (class))
88
89(defgeneric r-zerop (object)
90 (:method ((self number)) (zerop self))
91 (:documentation "Tests whether a ring element is 0."))
92
93(defgeneric r+ (x y)
94 (:method ((x number) (y number)) (+ x y))
95 (:documentation "Adds ring elements."))
96
97(defgeneric r- (x y)
98 (:method ((x number) (y number)) (- x y))
99 (:documentation "Subtracts ring elements."))
100
101(defgeneric r* (x y)
102 (:method ((x number) (y number)) (* x y))
103 (:documentation "Multiplies ring elements."))
104
105(defgeneric left-tensor-product-by (self other)
106 (:documentation "Takes a tensor product of SELF with OTHER, where
107OTHER is the left factor."))
108
109(defgeneric right-tensor-product-by (self other)
110 (:documentation "Takes a tensor product of SELF with OTHER, where
111OTHER is the right factor."))
112
113(defgeneric r/ (x y)
114 (:method ((x number) (y number)) (/ x y))
115 (:documentation "Divides ring elements."))
116
117(defgeneric r-lcm (x y)
118 (:method ((x integer) (y integer)) (lcm x y))
119 (:documentation "Returns the least common multiple of ring elements."))
120
121(defgeneric r-expt (x y)
122 (:method ((x integer) (y integer)) (expt x y))
123 (:documentation "Raises X to power Y."))
124
125(defgeneric r-ezgcd (x y)
126 (:method ((x integer) (y integer)
127 &aux (c (gcd x y)))
128 (values c (/ x c) (/ y c)))
129 (:documentation "Solves the diophantine system: X=C*X1, Y=C*X2,
130C=GCD(X,Y). It returns C, X1 and Y1. The result may be obtained by
131the Euclidean algorithm."))
132
133(defgeneric r-gcd (x y)
134 (:method ((x integer) (y integer))
135 (gcd x y))
136 (:documentation "Returns GCD(X,Y)."))
137
138(defgeneric r-dimension (object))
139(defgeneric r-exponents (object))
140
141(defgeneric r-coeff (object))
142(defgeneric (setf r-coeff) (new-value object))
143
144(defgeneric r-total-degree (object &optional start end))
145
146(defgeneric r-divides-p (object1 object2)
147 (:method ((object1 integer) (object2 integer))
148 (zerop (rem object2 object1)))
149 (:documentation "Returns T if OBJECT1 divides OBJECT2"))
150
151(defgeneric r-divides-lcm-p (object1 object2 object3)
152 (:documentation "Returns T if OBJECT divides LCM(OBJECT2, OBJECT3), NIL otherwise."))
153
154(defgeneric r-lcm-divides-lcm-p (object1 object2 object3 object4)
155 (:documentation "Returns T if LCM(OBJECT1,OBJECT2) divides LCM(OBJECT3,OBJECT4), NIL otherwise."))
156
157(defgeneric r-lcm-equal-lcm-p (object1 object2 object3 object4)
158 (:documentation "Returns T if object LCM(OBJECT1,OBJECT2) equals LCM(OBJECT3,OBJECT4), NIL otherwise."))
159
160(defgeneric r-equalp (object1 object2)
161 (:method (object1 object2) (equalp object1 object2))
162 (:method ((object1 list) (object2 list))
163 (every #'r-equalp object1 object2))
164 (:documentation "Equality using deep comparison of object slots."))
165
166(defgeneric r-elt (object index)
167 (:documentation "Access a part of an object OBJECT with index INDEX."))
168
169(defgeneric (setf r-elt) (new-value object index)
170 (:documentation "A setter of a part of an object OBJECT with index INDEX."))
171
172(defgeneric r-length (object))
173
174(defgeneric r->list (object))
175(defgeneric r-sugar (object))
176(defgeneric r-rel-prime-p (object1 object2))
177(defgeneric left-contract (object k))
178(defgeneric r-divisible-by-p (object1 object2))
179(defgeneric r-depends-p (object k))
180
181(defgeneric multiply-by (self other)
182 (:method (self other) (r* self other))
183 (:documentation "Multiply object SELF and OTHER and store the result
184into SELF. It returns SELF. For instances of a class, this operation
185may be destructive."))
186
187(defgeneric divide-by (self other)
188 (:method (self other) (r/ self other))
189 (:documentation "Divided object SELF by OTHER and store the result
190into SELF. It returns SELF. For instances of a class, this operation
191may be destructive."))
192
193(defgeneric add-to (self other)
194 (:documentation "Add to object SELF another object OTHER. For
195complex objects, it may destructively modify SELF and destructively
196modify/invalidate object OTHER. For standard classes implementing this
197method, the result should be an object which is EQ to SELF. For
198built-in classes, such as NUMBER, the returned object may not be EQ to
199the original, but it will be EQL to it.")
200 (:method (self other) (r+ self other)))
201
202(defgeneric subtract-from (self other)
203 (:documentation "Subtract from an object SELF another object OTHER.
204For complex objects, it may destructively modify SELF and
205destructively modify/invalidate object OTHER. For standard classes
206implementing this method, the result should be an object which is EQ
207to SELF. For built-in classes, such as NUMBER, the returned object may
208not be EQ to the original.")
209 (:method (self other) (r- self other)))
210
211(defgeneric unary-minus (self)
212 (:method ((x number)) (- x)))
213
214(defgeneric insert-item (self item))
215(defgeneric append-item (self item))
216
217;; Source: http://stackoverflow.com/questions/11067899/is-there-a-generic-method-for-cloning-clos-objects
218;; NOTE: This is a shallow copy. Add an around method for classes which need deep copy of the slots.
219(defgeneric copy-instance (object &rest initargs &key &allow-other-keys)
220 (:documentation "Makes and returns a shallow copy of OBJECT.
221
222 An uninitialized object of the same class as OBJECT is allocated by
223 calling ALLOCATE-INSTANCE. For all slots returned by
224 CLASS-SLOTS, the returned object has the
225 same slot values and slot-unbound status as OBJECT.
226
227 REINITIALIZE-INSTANCE is called to update the copy with INITARGS.")
228 (:method ((object standard-object) &rest initargs &key &allow-other-keys)
229 (let* ((class (class-of object))
230 (copy (allocate-instance class)))
231 (dolist (slot-name (mapcar #'slot-definition-name (class-slots class)))
232 (when (slot-boundp object slot-name)
233 (setf (slot-value copy slot-name)
234 (slot-value object slot-name))))
235 (apply #'reinitialize-instance copy initargs))))
236
237#|
238;; A stripped-down version of shallow copy
239;; Source: http://stackoverflow.com/questions/11067899/is-there-a-generic-method-for-cloning-clos-objects
240(defun shallow-copy-object (original)
241 (let* ((class (class-of original))
242 (copy (allocate-instance class)))
243 (dolist (slot (mapcar #'slot-definition-name (class-slots class)))
244 (when (slot-boundp original slot)
245 (setf (slot-value copy slot)
246 (slot-value original slot))))
247 copy))
248|#
Note: See TracBrowser for help on using the repository browser.