summaryrefslogtreecommitdiff
path: root/numpy/_array_api/_manipulation_functions.py
blob: e312b18c51dba4bbd69d03e14814453a5f4962d0 (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
from __future__ import annotations

from ._types import Optional, Tuple, Union, array

import numpy as np

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.
    """
    # Note: the function name is different here
    return 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 np.expand_dims._implementation(x, 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 np.flip._implementation(x, 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 np.reshape._implementation(x, 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 np.roll._implementation(x, 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 np.squeeze._implementation(x, 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.
    """
    return np.stack._implementation(arrays, axis=axis)