galois.primitive_root(n: int, start: int = 1, stop: = None, method: 'min' | 'max' | 'random' = 'min') int

Finds a primitive root modulo $$n$$ in the range $$[\textrm{start}, \textrm{stop})$$.

Parameters:
n: int

A positive integer.

start: int = 1

Starting value (inclusive) in the search for a primitive root.

stop: = None

Stopping value (exclusive) in the search for a primitive root. The default is None which corresponds to $$n$$.

method: 'min' | 'max' | 'random' = 'min'

The search method for finding the primitive root.

Returns:

A primitive root modulo $$n$$ in the specified range.

Raises:

RuntimeError – If no primitive roots exist in the specified range.

The integer $$g$$ is a primitive root modulo $$n$$ if the totatives of $$n$$ can be generated by the powers of $$g$$. The totatives of $$n$$ are the positive integers in $$[1, n)$$ that are coprime with $$n$$.

Alternatively said, $$g$$ is a primitive root modulo $$n$$ if and only if $$g$$ is a generator of the multiplicative group of integers modulo $$n$$ $$(\mathbb{Z}/n\mathbb{Z}){^\times} = \{1, g, g^2, \dots, g^{\phi(n)-1}\}$$, where $$\phi(n)$$ is the order of the group.

If $$(\mathbb{Z}/n\mathbb{Z}){^\times}$$ is cyclic, the number of primitive roots modulo $$n$$ is given by $$\phi(\phi(n))$$.

Examples

The elements of $$(\mathbb{Z}/14\mathbb{Z}){^\times} = \{1, 3, 5, 9, 11, 13\}$$ are the totatives of 14.

In : n = 14

In : Znx = galois.totatives(n); Znx
Out: [1, 3, 5, 9, 11, 13]


The Euler totient $$\phi(n)$$ function counts the totatives of $$n$$, which is equivalent to the order of $$(\mathbb{Z}/n\mathbb{Z}){^\times}$$.

In : phi = galois.euler_phi(n); phi
Out: 6

In : len(Znx) == phi
Out: True


Since 14 is of the form $$2p^k$$, the multiplicative group $$(\mathbb{Z}/14\mathbb{Z}){^\times}$$ is cyclic, meaning there exists at least one element that generates the group by its powers.

In : galois.is_cyclic(n)
Out: True


Find the smallest primitive root modulo 14. Observe that the powers of $$g$$ uniquely represent each element in $$(\mathbb{Z}/14\mathbb{Z}){^\times}$$.

In : g = galois.primitive_root(n); g
Out: 3

In : [pow(g, i, n) for i in range(0, phi)]
Out: [1, 3, 9, 13, 11, 5]


Find the largest primitive root modulo 14. Observe that the powers of $$g$$ also uniquely represent each element in $$(\mathbb{Z}/14\mathbb{Z}){^\times}$$, although in a different order.

In : g = galois.primitive_root(n, method="max"); g
Out: 5

In : [pow(g, i, n) for i in range(0, phi)]
Out: [1, 5, 11, 13, 9, 3]


A non-cyclic group is $$(\mathbb{Z}/15\mathbb{Z}){^\times} = \{1, 2, 4, 7, 8, 11, 13, 14\}$$.

In : n = 15

In : Znx = galois.totatives(n); Znx
Out: [1, 2, 4, 7, 8, 11, 13, 14]

In : phi = galois.euler_phi(n); phi
Out: 8


Since 15 is not of the form 2, 4, $$p^k$$, or $$2p^k$$, the multiplicative group $$(\mathbb{Z}/15\mathbb{Z}){^\times}$$ is not cyclic, meaning no elements exist whose powers generate the group.

In : galois.is_cyclic(n)
Out: False


Below, every element is tested to see if it spans the group.

In : for a in Znx:
....:     span = set([pow(a, i, n) for i in range(0, phi)])
....:     primitive_root = span == set(Znx)
....:     print("Element: {:2d}, Span: {:<13}, Primitive root: {}".format(a, str(span), primitive_root))
....:
Element:  1, Span: {1}          , Primitive root: False
Element:  2, Span: {8, 1, 2, 4} , Primitive root: False
Element:  4, Span: {1, 4}       , Primitive root: False
Element:  7, Span: {1, 4, 13, 7}, Primitive root: False
Element:  8, Span: {8, 1, 2, 4} , Primitive root: False
Element: 11, Span: {1, 11}      , Primitive root: False
Element: 13, Span: {1, 4, 13, 7}, Primitive root: False
Element: 14, Span: {1, 14}      , Primitive root: False


The Carmichael $$\lambda(n)$$ function finds the maximum multiplicative order of any element, which is 4 and not 8.

In : galois.carmichael_lambda(n)
Out: 4


Observe that no primitive roots modulo 15 exist and a RuntimeError is raised.

In : galois.primitive_root(n)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
File ~/checkouts/readthedocs.org/user_builds/galois/envs/stable/lib/python3.8/site-packages/galois/_modular.py:560, in primitive_root(n, start, stop, method)
559 if method == "min":
--> 560     root = next(primitive_roots(n, start, stop=stop))
561 elif method == "max":

StopIteration:

The above exception was the direct cause of the following exception:

RuntimeError                              Traceback (most recent call last)
Cell In, line 1
----> 1 galois.primitive_root(n)

File ~/checkouts/readthedocs.org/user_builds/galois/envs/stable/lib/python3.8/site-packages/galois/_modular.py:567, in primitive_root(n, start, stop, method)
565     return root
566 except StopIteration as e:
--> 567     raise RuntimeError(f"No primitive roots modulo {n} exist in the range [{start}, {stop}).") from e

RuntimeError: No primitive roots modulo 15 exist in the range [1, 15).


The algorithm is also efficient for very large $$n$$.

In : n = 1000000000000000035000061

In : phi = galois.euler_phi(n); phi
Out: 1000000000000000035000060


Find the smallest, the largest, and a random primitive root modulo $$n$$.

In : galois.primitive_root(n)
Out: 7

In : galois.primitive_root(n, method="max")
Out: 1000000000000000035000054

In : galois.primitive_root(n, method="random")
Out: 94647170212410661816998