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