Source code for plaid.types.common

"""Common types used across the PLAID library."""

# -*- coding: utf-8 -*-
#
# This file is subject to the terms and conditions defined in
# file 'LICENSE.txt', which is part of this source code package.
#
#

import sys
from typing import Union

if sys.version_info >= (3, 11):
    from typing import TypeAlias
else:  # pragma: no cover
    from typing_extensions import TypeAlias


import numpy as np
from numpy.typing import NDArray

# A generic float array type (float32 or float64)

[docs]
ArrayDType = Union[np.int32, np.int64, np.float32, np.float64]


[docs]
Array: TypeAlias = NDArray[ArrayDType]


# Types used in indexing operations

[docs]
IndexType = Union[list[int], NDArray[Union[np.int32, np.int64]], str]