Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
LeonidPryadko committed Dec 15, 2023
1 parent 3087dae commit e9bffff
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 14 deletions.
4 changes: 2 additions & 2 deletions PackageInfo.g
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ SetPackageInfo(
rec(
PackageName := "QDistRnd",
Subtitle := "Calculate the distance of a q-ary quantum stabilizer code",
Version := "0.8.5",
Date := "21/03/2022",
Version := "0.8.6",
Date := "15/12/2023",
License := "GPL-2.0-or-later",
PackageWWWHome := "https://QEC-pages.github.io/QDistRnd",
SourceRepository :=
Expand Down
2 changes: 1 addition & 1 deletion lib/examples.g
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ DistRandCSS(GX,GZ,100,1,2:field:=GF(2));
#! As a final and hopefully somewhat useful example, the file
#! "lib/cyclic.g" contains a piece of
#! code searching for random one-generator cyclic codes of length
#! $n:=15$ over the field $\gf(8)$, and generator weight `wei:=6`.
#! $n:=15$ over the field $\mathop{\rm GF}(8)$, and generator weight `wei:=6`.
#! Note how the `mindist` parameter and the option `maxav` are used to
#! speed up the calculation.

Expand Down
16 changes: 8 additions & 8 deletions lib/qdistrnd.g
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ BindGlobal("QDR_DoProbOut",
#! for use in the function `WriteMTXE`.
#! If `F` is a prime Galois field, just specify it:
#! `% Field: GF(p)`
#! For an extension field $\gf(p^m)$ with $p$ prime and $m>1$, also give
#! 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`
#! See Chapter <Ref Chap="Chapter_FileFormat"/> for details.
Expand Down Expand Up @@ -159,8 +159,8 @@ BindGlobal("QDR_FieldHeaderStr",
#! while `field`, `polynomial`, and `format` **should not contain any spaces.**
#! Any additional records in this line will be silently ignored.
#!
#! The `field` option should specify a valid field, $\gf(q)$ or
#! $\gf(p^m)$, where $q>1$ should be a power of the prime $p$.
#! The `field` option should specify a valid field, $\mathop{\rm GF}(q)$ or
#! $\mathop{\rm GF}(p^m)$, where $q>1$ should be a power of the prime $p$.
#!
#! The `polynomial` should be a valid expanded monic
#! polynomial with integer coefficients, with a single independent
Expand Down Expand Up @@ -295,7 +295,7 @@ BindGlobal("QDR_ProcessFieldHeader",
#! to the Galois Field element as specified in the `fmt`.
#! * `str` is the string representing an integer.
#! * `fmt` is a list [Field, ConversionDegree, FormatIndex]
#! - `Field` is the Galois field $\gf(p^m)$ of the code
#! - `Field` is the Galois field $\mathop{\rm GF}(p^m)$ of the code
#! - `ConversionDegree` $c$ : every element $x$ read is replaces with
#! $x^c$. This may be needed if a non-standard primitive
#! polynomial is used to define the field.
Expand Down Expand Up @@ -361,7 +361,7 @@ BindGlobal("QDR_ProcEntry",
#! $ (a_1, a_2, \ldots, a_n\; b_1, b_2,\ldots, b_n) $
#! * `pair=3` this is the only option for `type=complex` with elements
#! specified as "complex" pairs
#! * `field` (Options stack): Galois field, default: $\gf(2)$.
#! * `field` (Options stack): Galois field, default: $\mathop{\rm GF}(2)$.
#! **Must** match that given in the file (if any).
#! __Notice__: with `pair`=1 and `pair`=2, the number of matrix columns
#! specified in the file must be even, twice the block length of the
Expand All @@ -387,7 +387,7 @@ BindGlobal("QDR_ProcEntry",
#! @InsertCode LineTwoB
#!
#! Any additional entries in the second line are silently ignored. By
#! default, $\gf(2)$ is assumed;
#! default, $\mathop{\rm GF}(2)$ is assumed;
#! the default can be overriden
#! by the optional `field` argument. If the field is specified both
#! in the file and by the optional argument, the corresponding values
Expand Down Expand Up @@ -746,7 +746,7 @@ BindGlobal("QDR_MakeH",
#! * 2 (1st bit set) : check orthogonality of matrices and of the final vector
#! * 4 (2nd bit set) : show occasional progress update
#! * 8 (3rd bit set) : maintain cw count and estimate the success probability
#! * `field` (Options stack): Galois field, default: $\gf(2)$.
#! * `field` (Options stack): Galois field, default: $\mathop{\rm GF}(2)$.
#! * `maxav` (Options stack): if set, terminate when $\langle n\rangle$&gt;`maxav`,
#! see Section <Ref Sect="Section_Empirical"/>. Not set by default.
BindGlobal("DistRandCSS",
Expand Down Expand Up @@ -901,7 +901,7 @@ BindGlobal("DistRandCSS",
#! * 2 (1st bit set) : check orthogonality of matrices and of the final vector
#! * 4 (2nd bit set) : show occasional progress update
#! * 8 (3rd bit set) : maintain cw count and estimate the success probability
#! * `field` (Options stack): Galois field, default: $\gf(2)$.
#! * `field` (Options stack): Galois field, default: $\mathop{\rm GF}(2)$.
#! * `maxav` (Options stack): if set, terminate when $\langle n\rangle$&gt;`maxav`,
#! see Section <Ref Sect="Section_Empirical"/>. Not set by default.
BindGlobal("DistRandStab",
Expand Down
3 changes: 0 additions & 3 deletions makedoc.g
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ AutoDoc( rec( scaffold := true,
rec(
EarlyExtraPreamble :=
"""
\newcommand{\rank}{\mathop{\rm rank}}
\newcommand{\wgt}{\mathop{\rm wgt}}
\newcommand{\gf}{\mathop{\rm GF}}
"""
)
),
Expand Down

0 comments on commit e9bffff

Please sign in to comment.