This repository has been archived by the owner on Jan 30, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
free_monoid.py
326 lines (255 loc) · 9.48 KB
/
free_monoid.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
r"""
Free Monoids
AUTHORS:
- David Kohel (2005-09)
- Simon King (2011-04): Put free monoids into the category framework
Sage supports free monoids on any prescribed finite number
`n\geq 0` of generators. Use the ``FreeMonoid``
function to create a free monoid, and the ``gen`` and
``gens`` functions to obtain the corresponding
generators. You can print the generators as arbitrary strings using
the optional ``names`` argument to the
``FreeMonoid`` function.
"""
#*****************************************************************************
# Copyright (C) 2005 David Kohel <kohel@maths.usyd.edu>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
# http://www.gnu.org/licenses/
#*****************************************************************************
from sage.rings.integer import Integer
from sage.structure.category_object import normalize_names
from free_monoid_element import FreeMonoidElement
from monoid import Monoid_class
from sage.combinat.words.finite_word import FiniteWord_class
from sage.structure.factory import UniqueFactory
from sage.misc.cachefunc import cached_method
from sage.misc.decorators import rename_keyword
from sage.rings.all import ZZ
class FreeMonoidFactory(UniqueFactory):
"""
Create the free monoid in `n` generators.
INPUT:
- ``n`` - integer
- ``names`` - names of generators
OUTPUT: free monoid
EXAMPLES::
sage: FreeMonoid(0,'')
Free monoid on 0 generators ()
sage: F.<a,b,c,d,e> = FreeMonoid(5); F
Free monoid on 5 generators (a, b, c, d, e)
sage: F(1)
1
sage: mul([ a, b, a, c, b, d, c, d ], F(1))
a*b*a*c*b*d*c*d
"""
def create_key(self, n, names):
n = int(n)
names = normalize_names(n, names)
return (n, names)
def create_object(self, version, key, **kwds):
return FreeMonoid_class(*key)
FreeMonoid_factory = FreeMonoidFactory("sage.monoids.free_monoid.FreeMonoid_factory")
@rename_keyword(deprecation=15289, n="index_set")
def FreeMonoid(index_set=None, names=None, commutative=False, **kwds):
r"""
Return a free monoid on `n` generators or with the generators indexed by
a set `I`.
We construct free monoids by specifing either:
- the number of generators and/or the names of the generators
- the indexing set for the generators
INPUT:
- ``index_set`` -- an indexing set for the generators; if an integer,
than this becomes `\{0, 1, \ldots, n-1\}`
- ``names`` -- names of generators
- ``commutative`` -- (default: ``False``) whether the free monoid is
commutative or not
OUTPUT:
A free monoid.
EXAMPLES::
sage: F.<a,b,c,d,e> = FreeMonoid(); F
Free monoid on 5 generators (a, b, c, d, e)
sage: FreeMonoid(index_set=ZZ)
Free monoid indexed by Integer Ring
sage: F.<x,y,z> = FreeMonoid(abelian=True); F
Free abelian monoid on 3 generators (x, y, z)
sage: FreeMonoid(index_set=ZZ, commutative=True)
Free abelian monoid indexed by Integer Ring
TESTS::
sage: FreeMonoid(index_set=ZZ, names='x,y,z')
Free monoid indexed by Integer Ring
"""
if 'abelian' in kwds:
commutative = kwds.pop('abelian')
if commutative:
from sage.monoids.free_abelian_monoid import FreeAbelianMonoid
return FreeAbelianMonoid(index_set, names, **kwds)
if isinstance(index_set, str): # Swap args (this works if names is None as well)
names, index_set = index_set, names
if index_set is None and names is not None:
if isinstance(names, str):
index_set = names.count(',')
else:
index_set = len(names)
if index_set not in ZZ:
if names is not None:
if isinstance(names, str):
names = names.split(',')
names = normalize_names(len(names), names)
from sage.monoids.indexed_free_monoid import IndexedFreeMonoid
return IndexedFreeMonoid(index_set, names=names, **kwds)
if names is None:
raise ValueError("names must be specified")
return FreeMonoid_factory(index_set, names)
def is_FreeMonoid(x):
"""
Return True if `x` is a free monoid.
EXAMPLES::
sage: from sage.monoids.free_monoid import is_FreeMonoid
sage: is_FreeMonoid(5)
False
sage: is_FreeMonoid(FreeMonoid(7,'a'))
True
sage: is_FreeMonoid(FreeAbelianMonoid(7,'a'))
False
sage: is_FreeMonoid(FreeAbelianMonoid(0,''))
False
sage: is_FreeMonoid(FreeMonoid(index_set=ZZ))
True
sage: is_FreeMonoid(FreeAbelianMonoid(index_set=ZZ))
False
"""
if isinstance(x, FreeMonoid_class):
return True
from sage.monoids.indexed_free_monoid import IndexedFreeMonoid
return isinstance(x, IndexedFreeMonoid)
class FreeMonoid_class(Monoid_class):
"""
The free monoid on `n` generators.
"""
Element = FreeMonoidElement
def __init__(self, n, names=None):
"""
Create free monoid on `n` generators.
INPUT:
- ``n`` - integer
- ``names`` - (optional) variable name or list of
variable names
EXAMPLES::
sage: F = FreeMonoid(3,'x'); F
Free monoid on 3 generators (x0, x1, x2)
sage: x = F.gens()
sage: x[0]*x[1]**5 * (x[0]*x[2])
x0*x1^5*x0*x2
sage: F = FreeMonoid(3, 'a')
sage: F
Free monoid on 3 generators (a0, a1, a2)
::
sage: M = FreeMonoid(3, names=['a','b','c'])
sage: TestSuite(M).run()
"""
if not isinstance(n, (int, long, Integer)):
raise TypeError("n (=%s) must be an integer."%n)
if n < 0:
raise ValueError("n (=%s) must be nonnegative."%n)
self.__ngens = int(n)
#self._assign_names(names)
Monoid_class.__init__(self,names)
def __cmp__(self, other):
if not isinstance(other, FreeMonoid_class):
return -1
c = cmp(self.__ngens, other.__ngens)
if c: return c
if self.variable_names() == other.variable_names():
return 0
return 1
def _repr_(self):
return "Free monoid on %s generators %s"%(self.__ngens,self.gens())
def _element_constructor_(self, x, check=True):
"""
Return `x` coerced into this free monoid.
One can create a free monoid element from the integer 1, from a
list of 2-tuples of integers `(i,j)`, where `(i,j)`
corresponds to `x_i^j`, where `x_i` is the
`i`th generator, and words in teh same alphabet as the generators.
EXAMPLES::
sage: F = FreeMonoid(3, 'a')
sage: F(1)
1
sage: F(F.gen(0))
a0
sage: F(0)
Traceback (most recent call last):
...
TypeError: Argument x (= 0) is of the wrong type.
An example with a list::
sage: F([(0,5),(1,2),(0,10),(0,2),(1,2)])
a0^5*a1^2*a0^12*a1^2
An example using words::
sage: F = FreeMonoid(3, 'a,b,c')
sage: w = Word('aabbcabac')
sage: F(w)
a^2*b^2*c*a*b*a*c
sage: F(Word([]))
1
"""
## There should really some careful type checking here...
if isinstance(x, FreeMonoidElement) and x.parent() is self:
return x
if isinstance(x, FreeMonoidElement) and x.parent() == self:
return self.element_class(self,x._element_list,check)
if isinstance(x, (int, long, Integer)) and x == 1:
return self.element_class(self, x, check)
if isinstance(x, FiniteWord_class):
d = self.gens_dict()
return self.prod([d[let] for let in x])
if isinstance(x, list):
return self.element_class(self, x, check)
raise TypeError("Argument x (= %s) is of the wrong type."%x)
def __contains__(self, x):
return isinstance(x, FreeMonoidElement) and x.parent() == self
def gen(self,i=0):
"""
The `i`-th generator of the monoid.
INPUT:
- ``i`` - integer (default: 0)
EXAMPLES::
sage: F = FreeMonoid(3, 'a')
sage: F.gen(1)
a1
sage: F.gen(2)
a2
sage: F.gen(5)
Traceback (most recent call last):
...
IndexError: Argument i (= 5) must be between 0 and 2.
"""
n = self.__ngens
if i < 0 or not i < n:
raise IndexError("Argument i (= %s) must be between 0 and %s."%(i, n-1))
return self.element_class(self,[(Integer(i),Integer(1))])
def ngens(self):
"""
The number of free generators of the monoid.
EXAMPLES::
sage: F = FreeMonoid(2005, 'a')
sage: F.ngens()
2005
"""
return self.__ngens
def cardinality(self):
r"""
Return the cardinality of ``self``, which is `\infty`.
EXAMPLES::
sage: F = FreeMonoid(2005, 'a')
sage: F.cardinality()
+Infinity
"""
if self.__ngens == 0:
from sage.rings.all import ZZ
return ZZ.one()
from sage.rings.infinity import infinity
return infinity