"""Return the ceiling of the input, element-wise."""
from __future__ import annotations
from typing import Any, Optional
import numpy
import numpy.typing
from ..baseclass import ndpoly, PolyLike
from ..dispatch import implements, simple_dispatch
[docs]@implements(numpy.ceil)
def ceil(
q0: PolyLike,
out: Optional[ndpoly] = None,
where: numpy.typing.ArrayLike = True,
**kwargs: Any,
) -> ndpoly:
r"""
Return the ceiling of the input, element-wise.
The ceil of the scalar `x` is the smallest integer `i`, such that
`i >= x`. It is often denoted as :math:`\lceil x \rceil`.
Args:
x:
Input data.
out:
A location into which the result is stored. If provided, it must
have a shape that the inputs broadcast to. If not provided or
`None`, a freshly-allocated array is returned. A tuple (possible
only as a keyword argument) must have length equal to the number of
outputs.
where:
This condition is broadcast over the input. At locations where the
condition is True, the `out` array will be set to the ufunc result.
Elsewhere, the `out` array will retain its original value. Note
that if an uninitialized `out` array is created via the default
``out=None``, locations within it where the condition is False will
remain uninitialized.
kwargs:
Keyword args passed to numpy.ufunc.
Return:
The ceiling of each element in `x`, with `float` dtype.
This is a scalar if `x` is a scalar.
Example:
>>> q0 = numpoly.variable()
>>> numpoly.ceil([-1.7*q0, q0-1.5, -0.2,
... 3.2+1.5*q0, 1.7, 2.0])
polynomial([-q0, q0-1.0, 0.0, 2.0*q0+4.0, 2.0, 2.0])
"""
return simple_dispatch(
numpy_func=numpy.ceil,
inputs=(q0,),
out=None if out is None else (out,),
where=where,
**kwargs,
)