From 709828d59e3defe4f81f6d6e89383fc15b4c6b4e Mon Sep 17 00:00:00 2001
From: LeonidPryadko <63686094+LeonidPryadko@users.noreply.github.com>
Date: Fri, 12 Jan 2024 16:50:54 -0800
Subject: [PATCH] MTXE file parsing modified (#34)
* File parsing modified
* additional checks before calling
---
examples/examples.g | 18 ++
lib/qdistrnd.g | 488 ++++++++++++++++++++++++--------------------
tst/qdistrnd02.tst | 20 +-
3 files changed, 306 insertions(+), 220 deletions(-)
diff --git a/examples/examples.g b/examples/examples.g
index 67a8fff..8171e11 100644
--- a/examples/examples.g
+++ b/examples/examples.g
@@ -162,6 +162,7 @@ DistRandStab(H,100,0,2 : field:=F);
#! 2
#! @EndExample
+#! @Chapter AllFunctions
#! @Section HelperFunctions
#! @Subsection Examples
#! @BeginExample
@@ -182,3 +183,20 @@ Display(mat);
#! . . . . . . . . 1 2
#! @EndExample
+#! These examples illustrate the allowed format of field definitions in the header of an `MTXE` file:
+#! @BeginExample
+QDR_ParseFieldStr("Z(5)");
+#! Z(5)
+QDR_ParseFieldStr("Z(17)");
+#! Z(17)
+QDR_ParseFieldStr("GF(5^2)");
+#! GF(5^2)
+QDR_ParseFieldStr("GF(25)");
+#! GF(5^2)
+QDR_ParseFieldStr("GF(125^2)");
+#! GF(5^6)
+#! @EndExample
+#! @BeginExample
+QDR_ParsePolyStr(GF(25),"x^2+1");
+#! x^2+Z(5)^0
+#! @EndExample
diff --git a/lib/qdistrnd.g b/lib/qdistrnd.g
index 411ba69..f8c71d1 100644
--- a/lib/qdistrnd.g
+++ b/lib/qdistrnd.g
@@ -15,8 +15,8 @@
#! @Description Calculate the average of the components of a numerical `vector`
#! @Arguments vector
-DeclareGlobalFunction("QDR_AverageCalc");
-InstallGlobalFunction("QDR_AverageCalc",
+#DeclareGlobalFunction("QDR_AverageCalc");
+BindGlobal("QDR_AverageCalc",
function(mult)
return 1.0*Sum(mult)/Length(mult);
end
@@ -34,8 +34,8 @@ InstallGlobalFunction("QDR_AverageCalc",
#! **Note: the parity of vector `length` and the format are not verified!!!**
#! @Returns symplectic weight of a vector
#! @Arguments vector, field
-DeclareGlobalFunction("QDR_SymplVecWeight");
-InstallGlobalFunction("QDR_SymplVecWeight",
+#DeclareGlobalFunction("QDR_SymplVecWeight");
+BindGlobal("QDR_SymplVecWeight",
function(vec, F)
local wgt, i, len;
# local variables: wgt - the weight, i - for "for" loop, len - length of vec
@@ -100,18 +100,94 @@ InstallGlobalFunction("QDR_DoProbOut",
end
);
+#! @Description Parse a string describing a Galois field
+#! Supported formats: `Z(p)`, `GF(q)`, and `GF(q^m)`,
+#! where `p` must be a prime, `q` a prime or a power of a prime, and `m` a natural integer.
+#! No spaces are allowed.
+#! @Returns the corresponding Galois field
+#! @Arguments str
+#DeclareGlobalFunction("QDR_ParseFieldStr");
+BindGlobal("QDR_ParseFieldStr",
+ function(str)
+ local body, q;
+ if EndsWith(str,")") then
+ if StartsWith(str,"Z(") then
+ body := str{[3..Length(str)-1]};
+ q := Int(body);
+ if IsInt(q) and IsPrimeInt(q) then
+ return Z(q);
+ else
+ Print("\n Argument of ",str,"should be prime\n");
+ fi;
+ elif StartsWith(str,"GF(") then
+ body := str{[4..Length(str)-1]};
+ q := Int(body);
+ if IsInt(q) then
+ if IsPrimePowerInt(q) then
+ return GF(q);
+ fi;
+ else
+ q := SplitString(body,"^");
+ if Length(q) = 2 then
+ if IsInt(Int(q[1])) and
+ IsInt(Int(q[2])) and
+ IsPrimePowerInt(Int(q[1])^Int(q[2]))
+ then
+ return GF(Int(q[1])^Int(q[2]));
+ fi;
+ fi;
+ fi;
+ Print("\n Argument of ",str,"should be a prime power\n");
+ fi;
+ fi;
+ Error("\n QDR_ParseFieldStr: Invalid argument format str=",str,
+ "\n valid format: 'GF(p)', 'Z(p)', 'GF(p^m)', 'GF(q)'",
+ "\n with 'p' prime, 'm' positive integer, and 'q' a prime power\n");
+ end
+ );
+
+#! @Description Parse string `str` as a polynomial over the field `F`.
+#! Only characters in "0123456789*+-^x" are allowed in the string.
+#! In particular, no spaces are allowed.
+#! @Returns the corresponding polynomial
+#! @Arguments F, str
+#DeclareGlobalFunction("QDR_ParsePolyStr");
+BindGlobal("QDR_ParsePolyStr",
+ function(F, str)
+ local func, new_str;
+ # make sure `str` only contains these characters
+ new_str := String(str); # copy
+ RemoveCharacters(new_str,"0123456789x*+-^");
+ if (Length(new_str) > 0) then
+ ERROR("QDR_ParsePolyStr: invalid character(s) [",new_str,"] in polynomial ",str);
+ fi;
+
+ func := EvalString(Concatenation("""
+ function(F)
+ local x;
+ x := Indeterminate(F,"x");
+ return """, str, """;
+ end
+ """));
+ return func(F);
+ end);
+
#! @Description Create a header string describing the field `F`
#! for use in the function `WriteMTXE`.
#! If `F` is a prime Galois field, just specify it:
-#! `% Field: GF(p)`
+#! @BeginCode
+#! % Field: GF(p)
+#! @EndCode
#! For an extension field $\mathop{\rm GF}(p^m)$ with $p$ prime and $m>1$, also give
#! the primitive polynomial **which should not contain any spaces**. For example,
-#! `% Field: GF(7^4) PrimitiveP(x): x^4-2*x^2-3*x+3`
+#! @BeginCode
+#! % Field: GF(7^4) PrimitiveP(x): x^4-2*x^2-3*x+3
+#! @EndCode
#! See Chapter