PBR helpers

This page contains the documentation for various helper functions for manipulating PBRs.

This page contains the documentation for the pbr subpackage, that contains helper functions for the PBR class.

pbr.one(*args, **kwargs)

Overloaded function.

pbr.one(x: PBR) → PBR

Returns the identity PBR with degree x.degree().

This member function returns a new PBR with degree equal to the PBR.degree of x, where every value is adjacent to its negative. Equivalently, i is adjacent i + n and vice versa for every i less than the degree n.

Parameters:

x (PBR) – A PBR.

Returns:

The identity.

Return type:

PBR

pbr.one(n: int) → PBR

Returns the identity PBR with specified degree.

This function returns a new PBR with degree equal to n where every value is adjacent to its negative. Equivalently, i is adjacent i + n and vice versa for every i less than the degree n.

Parameters:

n (int) – the degree.

Returns:

The identity.

Return type:

PBR