arro3.compute

arro3.compute

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.

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.