pyarrow.compute.RoundToMultipleOptions#

class pyarrow.compute.RoundToMultipleOptions(multiple=1.0, round_mode='half_to_even')#

Bases: _RoundToMultipleOptions

Options for rounding numbers to a multiple.

Parameters:
multiplenumeric scalar, default 1.0

Multiple to round to. Should be a scalar of a type compatible with the argument to be rounded.

round_modestr, default “half_to_even”

Rounding and tie-breaking mode. Accepted values are “down”, “up”, “towards_zero”, “towards_infinity”, “half_down”, “half_up”, “half_towards_zero”, “half_towards_infinity”, “half_to_even”, “half_to_odd”.

__init__(self, multiple=1.0, round_mode='half_to_even')#

Methods

__init__(self[, multiple, round_mode])

deserialize(buf)

Deserialize options for a function.

serialize(self)

static deserialize(buf)#

Deserialize options for a function.

Parameters:
bufBuffer

The buffer containing the data to deserialize.

serialize(self)#