Annotation of OpenXM/src/kan96xx/Kan/usage.sm1, Revision 1.2
1.2 ! takayama 1: %% $OpenXM$
1.1 maekawa 2: %% usage.sm1
3: %% [(key word)
4: %% [( )
5: %% ( )
6: %% ]
7: %% ] putUsages
8: [(putUsages)
9: [$[(key word) [(explanation line 1) (explanation line 2) ... ]] putUsages$ ]
10: ] putUsages
11:
12: [(;)
13: [(Output the prompt sm1>)]
14: ] putUsages
15:
16: [(::)
17: [(Pop the top of the stack and print it.)]
18: ] putUsages
19:
20: [(Libraries)
21: [
22: (Doc/appell.sm1 : It generates Appell differential equations.)
23: (Doc/bfunction.sm1: Computing the b-function of a given polynomial)
24: ( by using Groebner basis. Written by T.Oaku.)
25: (Doc/factor-a.sm1: A sample interface to factor polynomials by risa/asir.)
26: (Doc/gkz.sm1 : It generates GKZ systems for given A and b.)
27: (Doc/hol.sm1 : Basic package for holonomic systems. Holonomic rank,)
28: ( characteristic ideal, singular locus.)
29: (Doc/resol0.sm1 : Constructing Schreyer resolutions. tower.sm1, tower-sugar.sm1)
30: (Doc/rest0.sm1 : Computing the restriction (inverse image) as a complex.)
31: ( This package is under developement by T.Oaku.)
32: ( cf. restall_s.sm1, resol0.sm1)
33: ]
34: ] putUsages
35: /Loadall {
36: [(parse) (bfunction.sm1) pushfile] extension
37: [(parse) (hol.sm1) pushfile] extension
38: [(parse) (gkz.sm1) pushfile] extension
39: [(parse) (appell.sm1)pushfile] extension
40: [(parse) (resol0.sm1)pushfile] extension
41: } def
42: [(Loadall)
43: [(Loadall loads the packages bfunction.sm1, hol.sm1, gkz.sm1, appell.sm1,)
44: (resol0.sm1)
45: ]] putUsages
46:
47: [(Version)
48: [(Packages must be loaded in a proper version of kan/sm1.)
49: (It can be checked as follows.)
50: (Example: )
51: ( /factor-a.version (2.981101) def)
52: ( factor-a.version [(Version)] system_variable gt )
53: $ { (This package requires the latest version of kan/sm1) message$
54: $ (Please get it from http://www.math.kobe-u.ac.jp/KAN) message$
55: $ error$
56: $ } { } ifelse$
57: ]]putUsages
58:
59:
60: [(bugs)
61: [(All known bugs are fixed.)
62: ]
63: ] putUsages
64:
65: [(factor)
66: [(Load Doc/factor-a.sm1, then factorization can be computed by invoking )
67: (asir, of which ftp cite is at http://www.math.kobe-u.ac.jp)
68: ]
69: ] putUsages
70:
71:
72: [(message)
73: [ (string message)
74: (Output the string to the screen with the newline.)
75: (cf. messagen.)
76: $Example: (Hello world) message$
77: ]
78: ] putUsages
79:
80: [(messagen)
81: [ (string messagen)
82: (Output the string to the screen without the newline.)
83: (cf. message.)
84: $Example: (Hello world) messagen$
85: ]
86: ] putUsages
87:
88: [(ring_of_polynomials)
89: [ (string ring_of_polynomials)
90: (This command is used to define a ring of polynomials with the macros)
91: (define_ring, weight_vector and elimination_order.)
92: (The user cannot use the variable names h, e, H and E.)
93: (cf. show_ring, system_variable --- CurrentRing)
94: ( print_switch_status, switch_function)
95: (Example: [(x,y,z) ring_of_polynomials (x,y) elimination_order 0] define_ring)
96: ]
97: ] putUsages
98:
99: [(ring_of_differential_operators)
100: [ (string ring_of_differential_operators)
101: (This command is used to define a ring of differential operators )
102: (with the macros define_ring, weight_vector and elimination_order.)
103: (The user cannot use the variable names h, e, H and E.)
104: (cf. show_ring, system_variable --- CurrentRing)
105: ( print_switch_status, switch_function)
106: (Example: [(x,y,z) ring_of_differential_operators (Dx,Dy) elimination_order 0] define_ring)
107: ( Dx,Dy, and Dz are corresponding differential operators to the )
108: ( space variables x, y and z.)
109: ]
110: ] putUsages
111:
112: [(ring_of_difference_operators)
113: [ (string ring_of_difference_operators)
114: ( )
115: (This command has not been maintained since 1996. So, there may be)
116: (troubles if it is used with new features of kan/sm1.)
117: ( )
118: (This command is used to define a ring of difference operators )
119: (with the macros define_ring, weight_vector and elimination_order.)
120: (The user cannot use the variable names h, e, H and E.)
121: (cf. show_ring, system_variable --- CurrentRing)
122: ( print_switch_status, switch_function)
123: (Example: [(x,y,z) ring_of_difference_operators (Ex,Ey) elimination_order 0] define_ring)
124: ( Ex,Ey, and Ez are corresponding difference operators to the )
125: ( space variables x, y and z ( Ex x = (x+1) Ex).)
126: ]
127: ] putUsages
128:
129:
130: [(ring_of_q_difference_operators)
131: [ (string ring_of_q_difference_operators)
132: ( )
133: (This command has not been maintained since 1996. So, there may be)
134: (troubles if it is used with new features of kan/sm1.)
135: ( )
136: (This command is used to define a ring of q-difference operators )
137: (with the macros define_qring, weight_vector and elimination_order.)
138: (Note that you should use this macro with define_qring instead of)
139: (define_ring.)
140: (The user cannot use the variable names h, e, q and E.)
141: (cf. show_ring, system_variable --- CurrentRing)
142: ( print_switch_status, switch_function)
143: (Example: [(x,y,z) ring_of_q_difference_operators (Qx,Qy) elimination_order 0] define_qring)
144: ( Qx,Qy, and Qz are corresponding q-difference operators to the )
145: ( space variables x, y and z ( Qx x = (q) x Q).)
146: ]
147: ] putUsages
148:
149:
150: [(define_ring)
151: [( [varlist ring_of_??? order characteristic options] define_ring)
152: ( Pointer to the ring.)
153: (Example: [(x,y,z) ring_of_polynomials [[(x) 100 (y) 10 (z) 1]] weight_vector)
154: ( 11] define_qring )
155: (Example: [(x,y) ring_of_polynomials [[(x) 1]] weight_vector 0 ] define_ring)
156: ( /R set)
157: (cf. define_qring, set_up_ring@ <coefficient ring>)
158: ( <<ring_of_???>> ring_of_polynomials, ring_of_differential_operators, )
159: ( ring_of_difference_operators)
160: ( <<order>> elimination_order, weight_vector)
161: ( ring_def,ring , << ,, >>)
162: ]
163: ] putUsages
164:
165:
166: [(.)
167: [(string . polynomial)
168: (Parse the string as a polynomial in the current ring and put it on the stack)
169: (Example ( (x+2)^3 ) .)
170: ]
171: ] putUsages
172:
173: [(evenQ)
174: [ (number evenQ bool)
175: ]
176: ] putUsages
177:
178: [(reverse)
179: [ (array reverse reversed_array)
180: ]
181: ] putUsages
182:
183: [(memberQ)
184: [(element array(list) memberQ bool)
185: ]
186: ] putUsages
187:
188: [(transpose)
189: [( matrix transpose transposed_matrix)
190: ]
191: ] putUsages
192:
193: [(timer)
194: [( { codes } timer )
195: (It outputs the execution time to execute << codes >>.)
196: (If you type in ctrl-C while you are executing this macro,)
197: (you need to type in set_timer after you type in ctrl-C to reset)
198: (the timer.)
199: ]] putUsages
200:
201: [(complement)
202: [( set universal_set complement complement_set)
203: (Example: [1 2] [3 4 1 2 5] complement ::)
204: ]
205: ] putUsages
206:
207: [(pushVariables)
208: [ (varlist pushVariables pushed-variables)
209: (The macro is used to define local variables in a macro.)
210: (Example : /foo { )
211: ( /arg1 set )
212: ( [/abc /cd] pushVariables )
213: ( [ /abc arg1 def )
214: ( /cd abc 1 add def )
215: ( /arg1 cd def )
216: ( ] pop )
217: ( popVariables)
218: ( arg1 )
219: ( } def )
220: ( 10 foo :: returns 11 )
221: ( In the example, abc and cd are local variables.)
222: ]
223: ] putUsages
224:
225:
226:
227: /@@@.global.usage1
228: [(@@@. is the prefix for the global control variables and global functions.)
229: (@@@.quiet : 1 ---> quiet mode, 0 ---> not. cf. sm1 -q)
230: (@@@.esymbol : (e_) is the standard value. It is used to express)
231: ( vectors internally. cf. fromVectors, toVectors)
232: (@@@.Dsymbol : (D) is the standard value for differential operator.)
233: ( cf. ring_of_differential_operators)
234: (@@@.diffEsymbol : (E) is the standard value for difference operator.)
235: ( cf. ring_of_difference_operators)
236: (@@@.Qsymbol : (Q) is the standard value for q-difference operator.)
237: ( cf. ring_of_qdifference_operators)
238: ]
239: def
240: [(@@@.quiet) @@@.global.usage1] putUsages
241: [(@@@.Dsymbol) @@@.global.usage1] putUsages
242: [(@@@.diffEsymbol) @@@.global.usage1] putUsages
243: [(@@@.Qsymbol) @@@.global.usage1] putUsages
244: [(@@@.esymbol) @@@.global.usage1] putUsages
245:
246: [(join)
247: [(list1 list2 join list3)
248: (Ex. [1 2] [3 [4 (ab)]] join [1 2 3 [4 (ab)]])
249: ]
250: ] putUsages
251:
252: [(not)
253: [(int not int)
254: (1 not 0)
255: (0 not 1)
256: ]
257: ] putUsages
258:
259: [(append)
260: [(list1 obj2 append list3)
261: (Ex. [1 2] 3 append [1 2 3])
262: ]
263: ] putUsages
264:
265: [(null)
266: [(<<null>> returns null object)]
267: ] putUsages
268:
269: [(oxasir)
270: [(ox_asir is an asir server which is complient to open xxx protocol.)
271: (This module is necessary for efficient execution factorization )
272: (of b-functions in annfs, deRham. cf. lib/oxasir.sm1)
273: (ox_asir has not yet been put on the ftp cite. 12/17, 1998.)
274: ]
275: ] putUsages
276:
277: [(toVectors)
278: [(obj toVectors vec)
279: (Convert the internal expression of vector into the array <<vec>>.)
280: (obj can be [n [g1 ... gm]] where n is the length of the vector.)
281: $Example 1: [(x) ring_of_polynomials 0] define_ring $
282: $ (e_ + 2). toVectors :: $
283: ( ---> [2 , 1] )
284: (Example 2: [3 (e_ +2).] toVectors ::)
285: ( ---> [2 , 1 , 0 ])
286: (Example 3: [(e_+2). (e_^2+1).] toVectors ::)
287: ( ---> [[2 , 1] [1 , 0 , 1]] )
288: (Example 4: [2 [(e x + 1). (x+1).]] toVectors )
289: ( ===> [ [1 , x] [x+1 , 0] ] )
290: ]] putUsages
291: [(toVectors2)
292: [(Remained for the compatibility. cf. toVectors)
293: ]] putUsages
294:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to usage.sm1 CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / OpenXM / src / kan96xx / Kan