Completed
Push — master ( c5c112...117b26 )
by Ramon
14s queued 10s
created

nptyping.array   A

Complexity

Total Complexity 0

Size/Duplication

Total Lines 10
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 4
dl 0
loc 10
rs 10
c 0
b 0
f 0
wmc 0
1
"""
2
The array module: support for typing Numpy ndarrays.
3
"""
4
import numpy as np
5
from nptyping._array_meta import _Array
6
7
8
class Array(_Array, np.ndarray):
9
    """
10
    A representation of the `numpy.ndarray`.
11
12
    Example of an array with an undefined generic type and shape:
13
        `Array`
14
15
    Example of an array with a defined generic type:
16
        `Array[int]`
17
18
    Example of an array with a defined generic type and shape (rows):
19
        `Array[int, 3]`
20
        `Array[int, 3, ...]`
21
        `Array[int, 3, None]`
22
23
    Examples of an array with a defined generic type and shape (cols):
24
        `Array[int, None, 2]`
25
        `Array[int, ..., 2]`
26
27
    Example of an array with a defined generic type and shape (rows and cols):
28
        `Array[int, 3, 2]`
29
30
    """
31