## Expand description

Computation kernels on Arrow Arrays

## Re-exports§

`pub use self::kernels::comparison::*;`

## Modules§

- Computation kernels on Arrow Arrays

## Structs§

- CastOptions provides a way to override the default cast behaviors
- A builder to construct
`FilterPredicate`

- A filtering predicate that can be applied to an
`Array`

- A lexicographical comparator that wraps given array data (columns) and can lexicographically compare data at given two indices. The lifetime is the same at the data wrapped.
- A computed set of partitions, see
`partition`

- An iterator of
`(usize, usize)`

each representing an interval`[start, end)`

whose slots of a bitmap Buffer are true. Each interval corresponds to a contiguous region of memory to be “taken” from an array to be filtered. - One column to be used in lexicographical sort
- Options that define the sort order of a given column
- Options that define how
`take`

should behave

## Enums§

- Valid parts to extract from date/time/timestamp arrays.

## Functions§

- Performs
`AND`

operation on two arrays. If either left or right value is null then the result is also null. - Logical ‘and’ boolean values with Kleene logic
- Performs
`AND_NOT`

operation on two arrays. If either left or right value is null then the result is also null. - Allies a binary infallable function to two
`PrimitiveArray`

s, producing a new`PrimitiveArray`

- Applies a binary and infallible function to values in two arrays, replacing the values in the first array in place.
- Returns the bitwise and of all non-null input values.
- Returns the bitwise or of all non-null input values.
- Returns the bitwise xor of all non-null input values.
- Returns true if all non-null input values are true, otherwise false.
- Returns true if any non-null input value is true, otherwise false.
- build_
filter Deprecated Returns a prepared function optimized to filter multiple arrays. Creating this function requires time, but using it is faster than filter when the same filter needs to be applied to multiple arrays (e.g. a multi-column`RecordBatch`

). WARNING: the nulls of`filter`

are ignored and the value on its slot is considered. Therefore, it is considered undefined behavior to pass`filter`

with null values. - Return true if a value of type
`from_type`

can be cast into a value of`to_type`

. - Cast
`array`

to the provided data type and return a new Array with type`to_type`

, if possible. - Try to cast
`array`

to`to_type`

if possible. - Concatenates
`batches`

together into a single`RecordBatch`

. - Given an array, return a new array with the extracted
`DatePart`

as signed 32-bit integer values. - day
Deprecated Extracts the day of a given temporal primitive array as an array of integers - day_dyn
Deprecated Extracts the day of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - doy
Deprecated Extracts the day of year of a given temporal primitive array as an array of integers The day of year that ranges from 1 to 366 - doy_dyn
Deprecated Extracts the day of year of a given temporal array as an array of integers The day of year that ranges from 1 to 366. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Filters an Array, returning elements matching the filter (i.e. where the values are true).
- Returns a new RecordBatch with arrays containing only values matching the filter.
- hour
Deprecated Extracts the hours of a given temporal primitive array as an array of integers within the range of [0, 23]. - hour_
dyn Deprecated Extracts the hours of a given array as an array of integers within the range of [0, 23]. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Returns a non-null BooleanArray with whether each value of the array is not null.
- Returns a non-null BooleanArray with whether each value of the array is null.
- lexicographical_
partition_ ranges Deprecated Use`partition`

instead. Given a list of already sorted columns, find partition ranges that would partition lexicographically equal values across columns. - Sort a list of
`ArrayRef`

using`SortOptions`

provided for each array. - Sort elements lexicographically from a list of
`ArrayRef`

into an unsigned integer (`UInt32Array`

) of indices. - Returns the maximum value in the array, according to the natural order. For floating point arrays any NaN values are considered to be greater than any other non-null value
- Returns the max of values in the array of
`ArrowNumericType`

type, or dictionary array with value of`ArrowNumericType`

type. - Returns the maximum value in the binary array, according to the natural order.
- Returns the maximum value in the binary view array, according to the natural order.
- Returns the maximum value in the boolean array
- Returns the maximum value in the string array, according to the natural order.
- Returns the maximum value in the string view array, according to the natural order.
- microsecond
Deprecated Extracts the microseconds of a given temporal primitive array as an array of integers - microsecond_
dyn Deprecated Extracts the microseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - millisecond
Deprecated Extracts the milliseconds of a given temporal primitive array as an array of integers - millisecond_
dyn Deprecated Extracts the milliseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Returns the minimum value in the array, according to the natural order. For floating point arrays any NaN values are considered to be greater than any other non-null value
- Returns the min of values in the array of
`ArrowNumericType`

type, or dictionary array with value of`ArrowNumericType`

type. - Returns the minimum value in the binary array, according to the natural order.
- Returns the minimum value in the binary view array, according to the natural order.
- Returns the minimum value in the boolean array.
- Returns the minimum value in the string array, according to the natural order.
- Returns the minimum value in the string view array, according to the natural order.
- minute
Deprecated Extracts the minutes of a given temporal primitive array as an array of integers - minute_
dyn Deprecated Extracts the minutes of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - month
Deprecated Extracts the month of a given temporal primitive array as an array of integers within the range of [1, 12]. - month_
dyn Deprecated Extracts the month of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Perform
`left * right`

operation on two decimal arrays. If either left or right value is null then the result is also null. - Perform
`left * right`

operation on two decimal arrays. If either left or right value is null then the result is also null. - Perform
`left * right`

operation on two decimal arrays. If either left or right value is null then the result is also null. - nanosecond
Deprecated Extracts the nanoseconds of a given temporal primitive array as an array of integers - nanosecond_
dyn Deprecated Extracts the nanoseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Performs unary
`NOT`

operation on an arrays. If value is null then the result is also null. - Copies original array, setting validity bit to false if a secondary comparison boolean array is set to true
- num_
days_ from_ monday Deprecated Extracts the day of week of a given temporal primitive array as an array of integers. - num_
days_ from_ monday_ dyn Deprecated Extracts the day of week of a given temporal array as an array of integers. - num_
days_ from_ sunday Deprecated Extracts the day of week of a given temporal primitive array as an array of integers, starting at Sunday. - num_
days_ from_ sunday_ dyn Deprecated Extracts the day of week of a given temporal array as an array of integers, starting at Sunday. - Performs
`OR`

operation on two arrays. If either left or right value is null then the result is also null. - Logical ‘or’ boolean values with Kleene logic
- It’s unstable_sort, may not preserve the order of equal elements
- Given a list of lexicographically sorted columns, computes the
`Partitions`

, where a partition consists of the set of consecutive rows with equal values - Remove null values by do a bitmask AND operation with null bits and the boolean bits.
- quarter
Deprecated Extracts the quarter of a given temporal primitive array as an array of integers within the range of [1, 4]. - quarter_
dyn Deprecated Extracts the quarter of a given temporal array as an array of integersa within the range of [1, 4]. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Assigns a rank to each value in
`array`

based on its position in the sorted order - Perform SQL
`array ~ regex_array`

operation on`StringArray`

/`LargeStringArray`

. If`regex_array`

element has an empty value, the corresponding result value is always true. - Extract all groups matched by a regular expression for a given String array.
- second
Deprecated Extracts the seconds of a given temporal primitive array as an array of integers - second_
dyn Deprecated Extracts the seconds of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - Shifts array by defined number of items (to left or right) A positive value for
`offset`

shifts the array to the right a negative value shifts the array to the left. - Sort the
`ArrayRef`

using`SortOptions`

. - Sort the
`ArrayRef`

partially. - Sort elements from
`ArrayRef`

into an unsigned integer (`UInt32Array`

) of indices. Floats are sorted using IEEE 754 totalOrder.`limit`

is an option for partial_sort. - Returns the sum of values in the primitive array.
- Returns the sum of values in the array.
- Returns the sum of values in the array.
- Returns the sum of values in the primitive array.
- Take rows by index from
`RecordBatch`

and returns a new`RecordBatch`

from those indexes. - Applies the provided fallible binary operation across
`a`

and`b`

, returning any error, and collecting the results into a`PrimitiveArray`

. If any index is null in either`a`

or`b`

, the corresponding index in the result will also be null - Applies the provided fallible binary operation across
`a`

and`b`

by mutating the mutable`PrimitiveArray`

`a`

with the results, returning any error. If any index is null in either`a`

or`b`

, the corresponding index in the result will also be null - try_
unary_ dyn Deprecated Applies a fallible unary function to an array with primitive values. - unary_
dyn Deprecated Applies an infallible unary function to an array with primitive values. - using_
chrono_ tz_ and_ utc_ naive_ date_ time Deprecated Parse the given string into a string representing fixed-offset that is correct as of the given UTC NaiveDateTime. Note that the offset is function of time and can vary depending on whether daylight savings is in effect or not. e.g. Australia/Sydney is +10:00 or +11:00 depending on DST. - week
Deprecated Extracts the week of a given temporal primitive array as an array of integers - week_
dyn Deprecated Extracts the week of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned. - year
Deprecated Extracts the years of a given temporal primitive array as an array of integers - year_
dyn Deprecated Extracts the years of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an`Err`

will be returned.

## Type Aliases§

- Filter
Deprecated Function that can filter arbitrary arrays