arro3.compute

arro3.compute

add

add(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs + rhs, returning an error on overflow

add_wrapping

add_wrapping(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs + rhs, wrapping on overflow for integer data types.

can_cast_types

can_cast_types(
    from_type: ArrowSchemaExportable, to_type: ArrowSchemaExportable
) -> bool

Return true if a value of type from_type can be cast into a value of to_type.

Parameters:

• from_type (ArrowSchemaExportable) –

  Source type

• to_type (ArrowSchemaExportable) –

  Destination type

Returns:

• bool –

  True if can be casted.

cast

cast(
    input: ArrowArrayExportable | ArrowStreamExportable,
    to_type: ArrowSchemaExportable,
) -> Array | ArrayReader

Cast input to the provided data type and return a new Array with type to_type, if possible.

If input is an Array, an Array will be returned. If input is a ChunkedArray or ArrayReader, an ArrayReader will be returned.

Parameters:

• input (ArrowArrayExportable | ArrowStreamExportable) –

  Input data to cast.

• to_type (ArrowSchemaExportable) –

  The target data type to cast to. You may pass in a Field here if you wish to include Arrow extension metadata on the output array.

Returns:

• Array | ArrayReader –

  The casted Arrow data.

dictionary_encode

dictionary_encode(
    array: ArrowArrayExportable | ArrowStreamExportable,
) -> Array | ArrayReader

Dictionary-encode array.

Return a dictionary-encoded version of the input array. This function does nothing if the input is already a dictionary array.

Note: for stream input, each output array will not necessarily have the same dictionary.

Parameters:

• array (ArrowArrayExportable | ArrowStreamExportable) –

  Argument to compute function.

Returns:

• Array | ArrayReader –

  The dictionary-encoded array.

div

div(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs / rhs

filter

filter(
    values: ArrowArrayExportable | ArrowStreamExportable,
    predicate: ArrowArrayExportable | ArrowStreamExportable,
) -> Array | ArrayReader

Returns a filtered values array where the corresponding elements of predicate are true.

If input is an Array, an Array will be returned. If input is a ChunkedArray or ArrayReader, an ArrayReader will be returned.

is_not_null

is_not_null(
    input: ArrowArrayExportable | ArrowStreamExportable,
) -> Array | ArrayReader

Returns a non-null boolean-typed array with whether each value of the array is not null.

If input is an Array, an Array will be returned. If input is a ChunkedArray or ArrayReader, an ArrayReader will be returned.

Parameters:

• input (ArrowArrayExportable | ArrowStreamExportable) –

  Input data

Returns:

• Array | ArrayReader –

  Output

is_null

is_null(
    input: ArrowArrayExportable | ArrowStreamExportable,
) -> Array | ArrayReader

Returns a non-null boolean-typed array with whether each value of the array is null.

If input is an Array, an Array will be returned. If input is a ChunkedArray or ArrayReader, an ArrayReader will be returned.

Parameters:

• input (ArrowArrayExportable | ArrowStreamExportable) –

  Input data

Returns:

• Array | ArrayReader –

  Output

max

max(input: ArrowArrayExportable | ArrowStreamExportable) -> Scalar

Returns the max of values in the array.

min

min(input: ArrowArrayExportable | ArrowStreamExportable) -> Scalar

Returns the min of values in the array.

mul

mul(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs * rhs, returning an error on overflow

mul_wrapping

mul_wrapping(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs * rhs, wrapping on overflow for integer data types.

neg

neg(array: ArrowArrayExportable) -> Array

Negates each element of array, returning an error on overflow

neg_wrapping

neg_wrapping(array: ArrowArrayExportable) -> Array

Negates each element of array, wrapping on overflow for integer data types.

rem

rem(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs % rhs

sub

sub(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs - rhs, returning an error on overflow

sub_wrapping

sub_wrapping(lhs: ArrowArrayExportable, rhs: ArrowArrayExportable) -> Array

Perform lhs - rhs, wrapping on overflow for integer data types.

sum

sum(input: ArrowArrayExportable | ArrowStreamExportable) -> Scalar

Returns the sum of values in the array.

take

take(values: ArrowArrayExportable, indices: ArrowArrayExportable) -> Array

Take elements by index from Array, creating a new Array from those indexes.

┌─────────────────┐      ┌─────────┐                              ┌─────────────────┐
│        A        │      │    0    │                              │        A        │
├─────────────────┤      ├─────────┤                              ├─────────────────┤
│        D        │      │    2    │                              │        B        │
├─────────────────┤      ├─────────┤   take(values, indices)      ├─────────────────┤
│        B        │      │    3    │ ─────────────────────────▶   │        C        │
├─────────────────┤      ├─────────┤                              ├─────────────────┤
│        C        │      │    1    │                              │        D        │
├─────────────────┤      └─────────┘                              └─────────────────┘
│        E        │
└─────────────────┘
values array             indices array                            result

Parameters:

• values (ArrowArrayExportable) –

  The input Arrow data to select from.

• indices (ArrowArrayExportable) –

  The indices within values to take. This must be a numeric array.

Returns:

• Array –

  The selected arrow data.