testbed/TileDB-Inc__TileDB-Py/tiledb/ndrectangle.py

from typing import Tuple, Union

import tiledb.cc as lt

from .ctx import Ctx, CtxMixin
from .domain import Domain


class NDRectangle(CtxMixin, lt.NDRectangle):
    """
    Represents a TileDB N-Dimensional Rectangle.
    """

    def __init__(self, ctx: Ctx, domain: Domain):
        """Class representing an N-Dimensional Rectangle of a TileDB Domain.

        :param ctx: A TileDB Context
        :param domain: A TileDB Domain
        :raises tiledb.TileDBError:
        """
        super().__init__(ctx, domain)
        self._set_domain(domain)

    def __str__(self) -> str:
        dimensions_str = ", ".join(
            f"{self._domain.dim(i).name}: {self.range(i)}"
            for i in range(self._domain.ndim)
        )
        return f"NDRectangle({dimensions_str})"

    def _set_domain(self, domain: Domain):
        self._domain = domain

    def _get_domain(self) -> Domain:
        return self._domain

    def set_range(
        self,
        dim: Union[str, int],
        start: Union[int, float, str],
        end: Union[int, float, str],
    ):
        """Sets a range for the given dimension.

        :param dim: Dimension name or index
        :param start: Range start value
        :param end: Range end value
        :raises tiledb.TileDBError:
        """
        self._set_range(dim, start, end)

    def range(
        self, dim: Union[str, int]
    ) -> Union[Tuple[int, int], Tuple[float, float], Tuple[str, str]]:
        """Gets the range for the given dimension.

        :param dim: Dimension name or index
        :return: Range as a tuple (start, end)
        :raises tiledb.TileDBError:
        """
        return self._range(dim, self._domain.dim(dim).dtype)