lib/python3.12/site-packages/cupy/_io/formatting.py

from __future__ import annotations

import cupy
import numpy


def array_repr(arr, max_line_width=None, precision=None, suppress_small=None):
    """Returns the string representation of an array.

    Args:
        arr (array_like): Input array. It should be able to feed to
            :func:`cupy.asnumpy`.
        max_line_width (int): The maximum number of line lengths.
        precision (int): Floating point precision. It uses the current printing
            precision of NumPy.
        suppress_small (bool): If ``True``, very small numbers are printed as
            zeros

    Returns:
        str: The string representation of ``arr``.

    .. seealso:: :func:`numpy.array_repr`

    """
    return numpy.array_repr(cupy.asnumpy(arr), max_line_width, precision,
                            suppress_small)


def array_str(arr, max_line_width=None, precision=None, suppress_small=None):
    """Returns the string representation of the content of an array.

    Args:
        arr (array_like): Input array. It should be able to feed to
            :func:`cupy.asnumpy`.
        max_line_width (int): The maximum number of line lengths.
        precision (int): Floating point precision. It uses the current printing
            precision of NumPy.
        suppress_small (bool): If ``True``, very small number are printed as
            zeros.

    .. seealso:: :func:`numpy.array_str`

    """
    return numpy.array_str(cupy.asnumpy(arr), max_line_width, precision,
                           suppress_small)


def array2string(a, *args, **kwargs):
    """Return a string representation of an array.


    .. seealso:: :func:`numpy.array2string`

    """
    return numpy.array2string(cupy.asnumpy(a), *args, **kwargs)


def format_float_positional(x, *args, **kwargs):
    """Format a floating-point scalar as a decimal string in positional notation.

    See :func:`numpy.format_float_positional` for the list of arguments.

    .. seealso:: :func:`numpy.format_float_positional`

    """  # NOQA
    return numpy.format_float_positional(cupy.asnumpy(x), *args, **kwargs)


def format_float_scientific(x, *args, **kwargs):
    """Format a floating-point scalar as a decimal string in scientific notation.

    See :func:`numpy.format_float_scientific` for the list of arguments.

    .. seealso:: :func:`numpy.format_float_scientific`

    """  # NOQA
    return numpy.format_float_scientific(cupy.asnumpy(x), *args, **kwargs)