Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

r""" 

Examples of semigroups in cython 

""" 

  

from sage.structure.parent cimport Parent 

from sage.structure.element cimport Element 

from sage.categories.all import Category, Semigroups 

from sage.categories.examples.semigroups import LeftZeroSemigroup as LeftZeroSemigroupPython 

from cpython.object cimport PyObject_RichCompare 

  

  

class IdempotentSemigroups(Category): 

def super_categories(self): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import IdempotentSemigroups 

sage: IdempotentSemigroups().super_categories() 

[Category of semigroups] 

""" 

return [Semigroups()] 

  

class ElementMethods: 

def _pow_int(self, i): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(2)._pow_int(3) 

2 

""" 

assert i > 0 

return self 

  

def is_idempotent(self): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(2).is_idempotent() 

True 

""" 

return True 

  

  

cdef class LeftZeroSemigroupElement(Element): 

cdef object _value 

  

def __init__(self, parent, value): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: x = S(3) 

sage: TestSuite(x).run() 

""" 

Element.__init__(self, parent = parent) 

self._value = value 

  

def _repr_(self): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(3) # indirect doctest 

3 

""" 

return repr(self._value) 

  

def __reduce__(self): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: x = S(3) 

sage: x.__reduce__() 

(<type 'sage.categories.examples.semigroups_cython.LeftZeroSemigroupElement'>, 

(An example of a semigroup: the left zero semigroup, 3)) 

""" 

return LeftZeroSemigroupElement, (self._parent, self._value) 

  

cpdef _richcmp_(self, other, int op): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(3) == S(3) 

True 

sage: S(3) == S(2) 

False 

""" 

left = (<LeftZeroSemigroupElement>self)._value 

right = (<LeftZeroSemigroupElement>other)._value 

return PyObject_RichCompare(left, right, op) 

  

cpdef _mul_(self, other): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(2) * S(3) 

2 

sage: S(2)._mul_(S(3)) 

2 

""" 

return self.parent().product(self, other) 

  

def __pow__(self, i, dummy): 

""" 

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S(2)^3 

2 

""" 

return self._pow_int(i) 

  

  

class LeftZeroSemigroup(LeftZeroSemigroupPython): 

r""" 

An example of semigroup 

  

This class illustrates a minimal implementation of a semi-group 

where the element class is an extension type, and still gets code 

from the category. The category itself must be a Python class 

though. 

  

This is purely a proof of concept. The code obviously needs refactorisation! 

  

Comments: 

  

- one cannot play ugly class surgery tricks (as with _mul_parent). 

available operations should really be declared to the coercion model! 

  

EXAMPLES:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup(); S 

An example of a semigroup: the left zero semigroup 

  

This is the semigroup which contains all sort of objects:: 

  

sage: S.some_elements() 

[3, 42, 'a', 3.4, 'raton laveur'] 

  

with product rule is given by $a \times b = a$ for all $a,b$. :: 

  

sage: S('hello') * S('world') 

'hello' 

  

sage: S(3)*S(1)*S(2) 

3 

  

sage: S(3)^12312321312321 

3 

  

sage: TestSuite(S).run(verbose = True) 

running ._test_an_element() . . . pass 

running ._test_associativity() . . . pass 

running ._test_cardinality() . . . pass 

running ._test_category() . . . pass 

running ._test_elements() . . . 

Running the test suite of self.an_element() 

running ._test_category() . . . pass 

running ._test_eq() . . . pass 

running ._test_new() . . . pass 

running ._test_not_implemented_methods() . . . pass 

running ._test_pickling() . . . pass 

pass 

running ._test_elements_eq_reflexive() . . . pass 

running ._test_elements_eq_symmetric() . . . pass 

running ._test_elements_eq_transitive() . . . pass 

running ._test_elements_neq() . . . pass 

running ._test_eq() . . . pass 

running ._test_new() . . . pass 

running ._test_not_implemented_methods() . . . pass 

running ._test_pickling() . . . pass 

running ._test_some_elements() . . . pass 

  

That's really the only method which is obtained from the category ... :: 

  

sage: S(42).is_idempotent 

<bound method IdempotentSemigroups.element_class.is_idempotent of 42> 

sage: S(42).is_idempotent() 

True 

  

sage: S(42)._pow_int 

<bound method IdempotentSemigroups.element_class._pow_int of 42> 

sage: S(42)^10 

42 

  

sage: S(42).is_idempotent 

<bound method IdempotentSemigroups.element_class.is_idempotent of 42> 

sage: S(42).is_idempotent() 

True 

""" 

  

def __init__(self): 

""" 

TESTS:: 

  

sage: from sage.categories.examples.semigroups_cython import LeftZeroSemigroup 

sage: S = LeftZeroSemigroup() 

sage: S.category() 

Category of idempotent semigroups 

sage: TestSuite(S).run() 

""" 

Parent.__init__(self, category = IdempotentSemigroups()) 

  

Element = LeftZeroSemigroupElement