nums.numpy.trunc

nums.numpy.trunc(x, out=None, where=True, **kwargs)

Return the truncated value of the input, element-wise.

This docstring was copied from numpy.trunc.

Some inconsistencies with the NumS version may exist.

The truncated value of the scalar x is the nearest integer i which is closer to zero than x is. In short, the fractional part of the signed number x is discarded.

Parameters

• x (BlockArray) – Input data.

• out (BlockArray, None, or optional) – 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 (BlockArray, optional) – 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 – For other keyword-only arguments, see the ufunc docs.

Returns

y – The truncated value of each element in x.

Return type

BlockArray

See also

ceil, floor, rint

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> a = nps.array([-1.7, -1.5, -0.2, 0.2, 1.5, 1.7, 2.0])  
>>> nps.trunc(a).get()  
array([-1., -1., -0.,  0.,  1.,  1.,  2.])