galois.GF

class galois.GF

Bases: object

An abstract base class for all Galois field array classes.

Note

This is an abstract base class for all Galois fields. It cannot be instantiated directly. Galois field array classes are created using galois.GF_factory.

classmethod Elements(dtype=None)

Create a Galois field array of the field’s elements \(\{0, \dots, p^m-1\}\).

Parameters

dtype (numpy.dtype, optional) – The numpy.dtype of the array elements. The default is None which represents the smallest valid dtype for this field class, i.e. cls.dtypes[0].

classmethod Ones(shape, dtype=None)

Create a Galois field array with all ones.

Parameters

• shape (tuple) – A numpy-compliant shape tuple, see numpy.ndarray.shape. An empty tuple () represents a scalar. A single integer or 1-tuple, e.g. N or (N,), represents the size of a 1-dim array. An n-tuple, e.g. (M,N), represents an n-dim array with each element indicating the size in each dimension.

• dtype (numpy.dtype, optional) – The numpy.dtype of the array elements. The default is None which represents the smallest valid dtype for this field class, i.e. cls.dtypes[0].

classmethod Random(shape=(), low=0, high=None, dtype=None)

Create a Galois field array with random field elements.

Parameters

• shape (tuple) – A numpy-compliant shape tuple, see numpy.ndarray.shape. An empty tuple () represents a scalar. A single integer or 1-tuple, e.g. N or (N,), represents the size of a 1-dim array. An n-tuple, e.g. (M,N), represents an n-dim array with each element indicating the size in each dimension.

• low (int, optional) – The lowest value (inclusive) of a random field element. The default is 0.

• high (int, optional) – The highest value (exclusive) of a random field element. The default is None which represents the field’s order \(p^m\).

• dtype (numpy.dtype, optional) – The numpy.dtype of the array elements. The default is None which represents the smallest valid dtype for this field class, i.e. cls.dtypes[0].

classmethod Zeros(shape, dtype=None)

Create a Galois field array with all zeros.

Parameters

• shape (tuple) – A numpy-compliant shape tuple, see numpy.ndarray.shape. An empty tuple () represents a scalar. A single integer or 1-tuple, e.g. N or (N,), represents the size of a 1-dim array. An n-tuple, e.g. (M,N), represents an n-dim array with each element indicating the size in each dimension.

• dtype (numpy.dtype, optional) – The numpy.dtype of the array elements. The default is None which represents the smallest valid dtype for this field class, i.e. cls.dtypes[0].

classmethod display(mode='int', poly_var='x')

Sets the printing mode for arrays.

Parameters

• mode (str, optional) – The field element display mode, either "int" (default) or "poly".

• poly_var (str, optional) – The polynomial representation’s variable. The default is "x".

Examples

In [5]: GF = galois.GF_factory(2, 3)

In [6]: a = GF.Random(4); a
Out[6]: GF([6, 4, 4, 5], order=2^3)

In [7]: GF.display("poly"); a
Out[7]: GF([x^2 + x, x^2, x^2, x^2 + 1], order=2^3)

In [8]: GF.display("poly", "r"); a
Out[8]: GF([r^2 + r, r^2, r^2, r^2 + 1], order=2^3)

# Reset the print mode
In [9]: GF.display(); a
Out[9]: GF([6, 4, 4, 5], order=2^3)

alpha = None

The primitive element of the Galois field \(\mathrm{GF}(p^m)\). The primitive element is a root of the primitive polynomial \(p(x)\), such that \(p(\alpha) = 0\). The primitive element is also a multiplicative generator of the field, such that \(\mathrm{GF}(p^m) = \{0, 1, \alpha^1, \alpha^2, \dots, \alpha^{p^m - 2}\}\).

Type

int

characteristic = None

The prime characteristic \(p\) of the Galois field \(\mathrm{GF}(p^m)\). Adding \(p\) copies of any element will always result in \(0\).

Type

int

degree = None

The prime characteristic’s degree \(m\) of the Galois field \(\mathrm{GF}(p^m)\). The degree is a positive integer.

Type

int

dtypes = []

List of valid integer numpy.dtype objects that are compatible with this Galois field array class. Valid data types are signed and unsinged integers that can represent decimal values in \([0, p^m)\).

Type

list

order = None

The order \(p^m\) of the Galois field \(\mathrm{GF}(p^m)\). The order of the field is also equal to the field’s size.

Type

int

prim_poly = None

The primitive polynomial \(p(x)\) of the Galois field \(\mathrm{GF}(p^m)\). The primitive polynomial is of degree \(m\) in \(\mathrm{GF}(p)[x]\).

Type

galois.Poly

ufunc_mode = None

The mode for ufunc compilation, either "lookup" or "calculate".

Type

str

ufunc_target = None

The numba target for the JIT-compiled ufuncs, either "cpu", "parallel", or "cuda".

Type

str