galois.typing.ShapeLike

A Union representing objects that can be coerced into a NumPy shape tuple.

Union

  • int: The size of a 1-D array.

    In [1]: GF = galois.GF(3**5)
    
    In [2]: x = GF.Random(4); x
    Out[2]: GF([ 36, 162,  42,  45], order=3^5)
    
    In [3]: x.shape
    Out[3]: (4,)
    
  • Sequence [ int ]: An iterable of integer dimensions. Tuples or lists are allowed. An empty iterable, () or [], represents a 0-D array (scalar).

    In [4]: x = GF.Random((2, 3)); x
    Out[4]: 
    GF([[115, 242,  99],
        [ 24, 216, 227]], order=3^5)
    
    In [5]: x.shape
    Out[5]: (2, 3)
    
    In [6]: x = GF.Random([2, 3, 4]); x
    Out[6]: 
    GF([[[138,  83, 136,  31],
         [ 93, 120, 182, 200],
         [ 88, 133, 127,  33]],
    
        [[137, 131,  73, 149],
         [106, 134, 154, 187],
         [ 45, 170, 137,  68]]], order=3^5)
    
    In [7]: x.shape
    Out[7]: (2, 3, 4)
    
    In [8]: x = GF.Random(()); x
    Out[8]: GF(59, order=3^5)
    
    In [9]: x.shape
    Out[9]: ()
    

Alias

alias of Union[int, Sequence[int]]