INPUT_CURRENT__MATRIX

myogen.utils.types.INPUT_CURRENT__MATRIX

Alias of: Annotated[npt.NDArray[np.floating], Is[lambda x: x.ndim == 2]]

Type Definition

This type alias is defined using beartype validators:

from typing import Annotated
import numpy.typing as npt
from beartype.vale import Is

INPUT_CURRENT__MATRIX = Annotated[
    npt.NDArray[np.floating],  # or np.bool_ for boolean arrays
    Is[lambda x: x.ndim == N], # where N is the required dimensions
]

Runtime Type Checking

Use with beartype for automatic validation:

from myogen.utils.types import INPUT_CURRENT__MATRIX
from beartype import beartype

@beartype
def process_input_data(data: INPUT_CURRENT__MATRIX) -> INPUT_CURRENT__MATRIX:
    """Process data with automatic shape validation."""
    # beartype automatically validates array dimensions
    return data

Tip

🐻 Beartype Integration: This type uses beartype validators to ensure arrays have the correct number of dimensions at runtime.

Note

📐 Array Validation: The Is[lambda x: x.ndim == N] validator automatically checks that your NumPy arrays have the expected shape for MyoGen operations.