=================================================================== RCS file: /home/cvs/OpenXM/src/kan96xx/Kan/usage.c,v retrieving revision 1.20 retrieving revision 1.31 diff -u -p -r1.20 -r1.31 --- OpenXM/src/kan96xx/Kan/usage.c 2003/08/24 05:19:43 1.20 +++ OpenXM/src/kan96xx/Kan/usage.c 2004/09/05 07:42:43 1.31 @@ -1,4 +1,4 @@ -/* $OpenXM: OpenXM/src/kan96xx/Kan/usage.c,v 1.19 2003/08/23 02:28:39 takayama Exp $ */ +/* $OpenXM: OpenXM/src/kan96xx/Kan/usage.c,v 1.30 2004/09/04 11:25:58 takayama Exp $ */ #include #include "datatype.h" #include "stackm.h" @@ -68,6 +68,7 @@ void Kusage2(fp,s) }else if (strcmp(s,"closefile")==0) { fppp(fp,"<< fd closefile >>\n"); fppp(fp,"file fd;\n"); + fppp(fp,"cf. file (open a file)\n"); }else if (strcmp(s,"coefficients")==0 || strcmp(s,"coeff")==0) { fppp(fp,"<< f v coeff [exponents coefficients] >>\n"); fppp(fp,"poly f,v; list of integers exponents; list of poly coefficients;\n"); @@ -98,6 +99,8 @@ void Kusage2(fp,s) fppp(fp," map, orderMatrix, error, \n"); fppp(fp," or [(class) (class-name)].\n"); fppp(fp,"The primitive reports and converts the data type of obj.\n"); + fppp(fp,"Special combinations of obj and keyword.\n"); + fppp(fp," ring (oxRingStructure) data_conversion list\n"); fppp(fp,"Example: (2) (integer) data_conversion ===> 2\n"); }else if (strcmp(s,"def")==0 || strcmp(s,"set")==0) { fppp(fp,"<< /name object def >> or << object /name set >>\n"); @@ -152,10 +155,14 @@ void Kusage2(fp,s) fppp(fp," [(getchild)] extension listOfPid (generated by forkExec)\n"); fppp(fp," [(keywords) ] extension array-of-names-of-primitives \n"); fppp(fp," [(nobody) ] extension null \n"); + fppp(fp," [(newMatrix) m n] extension mat \n"); + fppp(fp," [(newVector) m ] extension vec \n"); fppp(fp," [(getUniqueFileName) path] extension newName \n"); fppp(fp," [(outputObjectToFile) path obj] extension null \n"); fppp(fp," [(ostype)] extension list \n"); fppp(fp," [(regionMatches) string stringArray] extension list \n"); + fppp(fp," [(traceClearStack)] extension null \n"); + fppp(fp," [(traceShowStack)] extension str \n"); /* fppp(fp," [(asir0) string] extension result-object \n"); */ fppp(fp,"See also plugin-* in ??. \n"); }else if (strcmp(s,"file")==0) { @@ -164,6 +171,7 @@ void Kusage2(fp,s) fppp(fp,"It opens the <> with the <>. <> is the\n"); fppp(fp,"file descripter and is used in writestring and closefile.\n"); fppp(fp,"If filename part is an integer, it calls fdopen() and returns the file descripter.\n"); + fppp(fp,"cf. closefile, writestring, pushfile \n"); }else if (strcmp(s,"for")==0) { fppp(fp,"<>\n"); fppp(fp,"integer init inc limit;\n"); @@ -174,28 +182,33 @@ void Kusage2(fp,s) fppp(fp,"array of objects obj1;"); fppp(fp,"The first element of the obj1 should be the key word tag.\n"); fppp(fp,"<< gbext >> is used to call auxiliary functions for g-basis computation. \n"); + fppp(fp," [(divByN) poly1 n(universalNumber)] gbext [qpoly rpoly] \n"); + fppp(fp," where poly1 = n*qpoly+rpoly.\n"); + fppp(fp," (see also cancelCoeff) \n"); + fppp(fp," [(exponents) poly type ] gbext array \n"); + fppp(fp," example: type == 0 x,y,Dx,Dy\n"); + fppp(fp," type == 1 x,y,Dx,Dy,h,H\n"); + fppp(fp," type == 2 x,y,Dx,Dy,h --- default.\n"); + fppp(fp," [(grade) poly1 ] gbext integer \n"); + fppp(fp," [(isConstant) poly] gbext bool \n"); + fppp(fp," [(isConstantAll) poly] gbext bool \n"); + fppp(fp," [(isOrdered) poly] gbext poly \n"); fppp(fp," [(isReducible) poly1 poly2 ] gbext integer \n"); fppp(fp," [(lcm) poly1 poly2] gbext poly \n"); - fppp(fp," [(grade) poly1 ] gbext integer \n"); - fppp(fp," [(ord_ws_all) fv wv] gbext integer \n"); + fppp(fp," [(lcoeff) poly] gbext poly \n"); + fppp(fp," [(lmonom) poly] gbext poly \n"); fppp(fp," [(mod) poly1 universalNumber] gbext poly \n"); fppp(fp," poly = poly1 mod universalNumber where char=0 and \n"); fppp(fp," poly and poly2 belong to a same ring.\n"); + fppp(fp," [(ord_ws_all) fv wv] gbext integer \n"); + fppp(fp," [(reduceContent) poly] gbext [poly c] \n"); fppp(fp," [(tomodp) poly1 ring] gbext poly, char(ring)>0. \n"); fppp(fp," poly = poly1 mod char(ring) where poly belongs to ring.\n"); fppp(fp," [(tomod0) poly1 ring] gbext poly, char(ring)=0. \n"); - fppp(fp," [(divByN) poly1 n(universalNumber)] gbext [qpoly rpoly] \n"); - fppp(fp," where poly1 = n*qpoly+rpoly.\n"); - fppp(fp," (see also cancelCoeff) \n"); - fppp(fp," [(isConstant) poly] gbext bool \n"); - fppp(fp," [(lcoeff) poly] gbext poly \n"); - fppp(fp," [(lmonom) poly] gbext poly \n"); fppp(fp," [(schreyerSkelton) array_of_poly] gbext array \n"); fppp(fp," [(toes) array_of_poly] gbext poly \n"); fppp(fp," [(toe_) poly] gbext poly \n"); fppp(fp," [(toe_) array_of_poly] gbext poly cf. toVectors \n"); - fppp(fp," [(isOrdered) poly] gbext poly \n"); - fppp(fp," [(reduceContent) poly] gbext [poly c] \n"); }else if (strcmp(s,"get")==0) { fppp(fp,"<< [f0 f1 ... fn] k get fk >>\n"); fppp(fp,"integer k;"); @@ -249,6 +262,9 @@ void Kusage2(fp,s) fppp(fp," [(degreeShift) (value)] homogenize ::\n"); fppp(fp,"Note. min of ord (-1,1)[0,1] is min {-1,1, 1+1,1+0} = -1 =m \n"); fppp(fp," Degree of H is b-a+v(i)-m where v=[0,1]\n"); + fppp(fp,"Side effects: It changes h-degree shift vector and s-degree shift vector\n"); + fppp(fp," in homogenizeObject_go(), which is called from ecart division codes\n"); + fppp(fp," as well as the function homogenize.\n"); fppp(fp,"DegreeShift is automatically reset when set_up_ring is called.\n"); }else if (strcmp(s,"idiv") == 0) { fppp(fp,"<< a b idiv a/b >>\n"); @@ -317,6 +333,10 @@ void Kusage2(fp,s) }else if (strcmp(s,"newstack") == 0) { fppp(fp,"<< size newstack class.OperandStack >>\n"); /*:*/ fppp(fp,"cf. setstack, stdstack.\n"); + }else if (strcmp(s,"oxshell") == 0) { + fppp(fp,"<< cmds oxshell result >>\n"); /*:*/ + fppp(fp,"cmds is an array of strings.\n"); + KoxShellHelp((char *)NULL,fp); }else if (strcmp(s,"pop")==0) { fppp(fp,"<< obj pop >> \n"); /*:*/ fppp(fp,"It removes the obj from the stack.\n"); @@ -480,7 +500,7 @@ void Kusage2(fp,s) fppp(fp,"ReduceLowerTerms, CheckHomogenization, Homogenize, Sugar, Homogenize_vec,\n"); fppp(fp,"Statistics, StackPointer, StandardOperandStack,\n"); fppp(fp,"ErrorStack, ErrorMessageMode, WarningMessageMode,\n"); - fppp(fp,"CatchCtrlC, Strict, CurrentContextp, NullContextp, Strict2,\n"); + fppp(fp,"CatchCtrlC, Strict, CurrentContextp, NullContextp, Strict2, QuoteMode\n"); fppp(fp,"SigIgn, KSPushEnvMode, PrimitiveContextp, KanGBmessage,\n"); fppp(fp,"orderMatrix, gbListTower, Schreyer, \n"); fppp(fp,"outputOrder, multSymbol, variableNames, Version,\n"); @@ -497,6 +517,7 @@ void Kusage2(fp,s) fppp(fp," Set the global variable PrintDollar to 0\n"); fppp(fp,"DebugReductionEcart (bit): (2) *% (1) find_reducer,in(r) \n"); fppp(fp," (any) cont (4) #+[rat division, + ecartd] \n"); + fppp(fp," (8) check the order. \n"); fppp(fp,"DoCancel (bit): (2) always_reduce_content (1) Noro_strategy \n"); fppp(fp," (4) DoCancel_in_reduction1 \n"); }else if (strcmp(s,"tlimit")==0) {