summaryrefslogtreecommitdiff
path: root/numpy/_array_api/_manipulation_functions.py
blob: 5f7b0a4515b48d31e7a5f8f4175bc99b0c379cba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
from __future__ import annotations

from ._array_object import ndarray

from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from ._types import Optional, Tuple, Union, array

import numpy as np

# Note: the function name is different here
def concat(arrays: Tuple[array, ...], /, *, axis: Optional[int] = 0) -> array:
    """
    Array API compatible wrapper for :py:func:`np.concatenate <numpy.concatenate>`.

    See its docstring for more information.
    """
    arrays = tuple(a._array for a in arrays)
    return ndarray._new(np.concatenate(arrays, axis=axis))

def expand_dims(x: array, /, *, axis: int) -> array:
    """
    Array API compatible wrapper for :py:func:`np.expand_dims <numpy.expand_dims>`.

    See its docstring for more information.
    """
    return ndarray._new(np.expand_dims(x._array, axis))

def flip(x: array, /, *, axis: Optional[Union[int, Tuple[int, ...]]] = None) -> array:
    """
    Array API compatible wrapper for :py:func:`np.flip <numpy.flip>`.

    See its docstring for more information.
    """
    return ndarray._new(np.flip(x._array, axis=axis))

def reshape(x: array, /, shape: Tuple[int, ...]) -> array:
    """
    Array API compatible wrapper for :py:func:`np.reshape <numpy.reshape>`.

    See its docstring for more information.
    """
    return ndarray._new(np.reshape(x._array, shape))

def roll(x: array, /, shift: Union[int, Tuple[int, ...]], *, axis: Optional[Union[int, Tuple[int, ...]]] = None) -> array:
    """
    Array API compatible wrapper for :py:func:`np.roll <numpy.roll>`.

    See its docstring for more information.
    """
    return ndarray._new(np.roll(x._array, shift, axis=axis))

def squeeze(x: array, /, axis: Optional[Union[int, Tuple[int, ...]]] = None) -> array:
    """
    Array API compatible wrapper for :py:func:`np.squeeze <numpy.squeeze>`.

    See its docstring for more information.
    """
    return ndarray._new(np.squeeze(x._array, axis=axis))

def stack(arrays: Tuple[array, ...], /, *, axis: int = 0) -> array:
    """
    Array API compatible wrapper for :py:func:`np.stack <numpy.stack>`.

    See its docstring for more information.
    """
    arrays = tuple(a._array for a in arrays)
    return ndarray._new(np.stack(arrays, axis=axis))