ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cloudlinux / venv / lib / python3.11 / site-packages / numpy / core

from collections.abc import Sequence
from typing import TypeVar, Any, overload, Union, Literal

from numpy import (
    ndarray,
    dtype,
    bool_,
    number,
    _OrderKACF,
)
from numpy._typing import (
    _ArrayLikeBool_co,
    _ArrayLikeUInt_co,
    _ArrayLikeInt_co,
    _ArrayLikeFloat_co,
    _ArrayLikeComplex_co,
    _ArrayLikeObject_co,
    _DTypeLikeBool,
    _DTypeLikeUInt,
    _DTypeLikeInt,
    _DTypeLikeFloat,
    _DTypeLikeComplex,
    _DTypeLikeComplex_co,
    _DTypeLikeObject,
)

_ArrayType = TypeVar(
    "_ArrayType",
    bound=ndarray[Any, dtype[Union[bool_, number[Any]]]],
)

_OptimizeKind = None | bool | Literal["greedy", "optimal"] | Sequence[Any]
_CastingSafe = Literal["no", "equiv", "safe", "same_kind"]
_CastingUnsafe = Literal["unsafe"]

__all__: list[str]

# TODO: Properly handle the `casting`-based combinatorics
# TODO: We need to evaluate the content `__subscripts` in order
# to identify whether or an array or scalar is returned. At a cursory
# glance this seems like something that can quite easily be done with
# a mypy plugin.
# Something like `is_scalar = bool(__subscripts.partition("->")[-1])`
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeBool_co,
    out: None = ...,
    dtype: None | _DTypeLikeBool = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeUInt_co,
    out: None = ...,
    dtype: None | _DTypeLikeUInt = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeInt_co,
    out: None = ...,
    dtype: None | _DTypeLikeInt = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeFloat_co,
    out: None = ...,
    dtype: None | _DTypeLikeFloat = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeComplex_co,
    out: None = ...,
    dtype: None | _DTypeLikeComplex = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: Any,
    casting: _CastingUnsafe,
    dtype: None | _DTypeLikeComplex_co = ...,
    out: None = ...,
    order: _OrderKACF = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeComplex_co,
    out: _ArrayType,
    dtype: None | _DTypeLikeComplex_co = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> _ArrayType: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: Any,
    out: _ArrayType,
    casting: _CastingUnsafe,
    dtype: None | _DTypeLikeComplex_co = ...,
    order: _OrderKACF = ...,
    optimize: _OptimizeKind = ...,
) -> _ArrayType: ...

@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeObject_co,
    out: None = ...,
    dtype: None | _DTypeLikeObject = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: Any,
    casting: _CastingUnsafe,
    dtype: None | _DTypeLikeObject = ...,
    out: None = ...,
    order: _OrderKACF = ...,
    optimize: _OptimizeKind = ...,
) -> Any: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeObject_co,
    out: _ArrayType,
    dtype: None | _DTypeLikeObject = ...,
    order: _OrderKACF = ...,
    casting: _CastingSafe = ...,
    optimize: _OptimizeKind = ...,
) -> _ArrayType: ...
@overload
def einsum(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: Any,
    out: _ArrayType,
    casting: _CastingUnsafe,
    dtype: None | _DTypeLikeObject = ...,
    order: _OrderKACF = ...,
    optimize: _OptimizeKind = ...,
) -> _ArrayType: ...

# NOTE: `einsum_call` is a hidden kwarg unavailable for public use.
# It is therefore excluded from the signatures below.
# NOTE: In practice the list consists of a `str` (first element)
# and a variable number of integer tuples.
def einsum_path(
    subscripts: str | _ArrayLikeInt_co,
    /,
    *operands: _ArrayLikeComplex_co | _DTypeLikeObject,
    optimize: _OptimizeKind = ...,
) -> tuple[list[Any], str]: ...

[-] _string_helpers.py [open]
[+] ..
[-] numerictypes.pyi [open]
[-] _type_aliases.py [open]
[-] multiarray.py [open]
[-] _asarray.py [open]
[-] arrayprint.py [open]
[+] __pycache__
[+] tests
[-] _add_newdocs_scalars.py [open]
[-] setup_common.py [open]
[-] memmap.pyi [open]
[-] fromnumeric.py [open]
[-] overrides.py [open]
[-] _machar.py [open]
[-] _operand_flag_tests.cpython-311-x86_64-linux-gnu.so [open]
[-] _methods.py [open]
[-] _add_newdocs.py [open]
[-] _asarray.pyi [open]
[-] einsumfunc.py [open]
[-] defchararray.pyi [open]
[-] getlimits.py [open]
[-] generate_numpy_api.py [open]
[-] _ufunc_config.pyi [open]
[-] shape_base.py [open]
[-] _dtype_ctypes.py [open]
[-] numerictypes.py [open]
[-] memmap.py [open]
[-] _rational_tests.cpython-311-x86_64-linux-gnu.so [open]
[-] einsumfunc.pyi [open]
[-] _internal.pyi [open]
[-] __init__.pyi [open]
[-] records.pyi [open]
[-] _multiarray_tests.cpython-311-x86_64-linux-gnu.so [open]
[-] _multiarray_umath.cpython-311-x86_64-linux-gnu.so [open]
[-] _umath_tests.cpython-311-x86_64-linux-gnu.so [open]
[-] _type_aliases.pyi [open]
[-] _simd.cpython-311-x86_64-linux-gnu.so [open]
[-] umath_tests.py [open]
[-] _internal.py [open]
[-] fromnumeric.pyi [open]
[-] function_base.pyi [open]
[-] numeric.pyi [open]
[-] defchararray.py [open]
[-] numeric.py [open]
[+] lib
[-] function_base.py [open]
[-] multiarray.pyi [open]
[-] _struct_ufunc_tests.cpython-311-x86_64-linux-gnu.so [open]
[-] __init__.py [open]
[-] _exceptions.py [open]
[-] umath.py [open]
[-] setup.py [open]
[-] _dtype.py [open]
[+] include
[-] arrayprint.pyi [open]
[-] getlimits.pyi [open]
[-] _ufunc_config.py [open]
[-] cversions.py [open]
[-] shape_base.pyi [open]
[-] records.py [open]