galois.typing.ShapeLike

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([ 84, 198, 217, 107], 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([[ 22, 204,  60],
        [  6, 176, 216]], order=3^5)
    
    In [5]: x.shape
    Out[5]: (2, 3)
    
    In [6]: x = GF.Random([2, 3, 4]); x
    Out[6]: 
    GF([[[236, 230, 240,  92],
         [177, 229,  86, 110],
         [120, 145, 143, 170]],
    
        [[ 66,  12,  54, 232],
         [146, 169, 168, 179],
         [ 64,  92, 107,  70]]], order=3^5)
    
    In [7]: x.shape
    Out[7]: (2, 3, 4)
    
    In [8]: x = GF.Random(()); x
    Out[8]: GF(118, order=3^5)
    
    In [9]: x.shape
    Out[9]: ()
    

Alias

alias of Union[int, Sequence[int]]


Last update: May 17, 2022