Module filter

Source
Expand description

Defines filter kernels

Structsยง

FilterBuilder
A builder to construct FilterPredicate
FilterBytes ๐Ÿ”’
FilterBytes is created from a source [GenericByteArray] and can be used to build a new [GenericByteArray] by copying values from the source
FilterPredicate
A filtering predicate that can be applied to an [Array]
IndexIterator ๐Ÿ”’
An iterator of usize whose index in [BooleanArray] is true
SlicesIterator
An iterator of (usize, usize) each representing an interval [start, end) whose slots of a bitmap [Buffer] are true.

Enumsยง

IterationStrategy ๐Ÿ”’
The iteration strategy used to evaluate FilterPredicate

Constantsยง

FILTER_SLICES_SELECTIVITY_THRESHOLD ๐Ÿ”’
If the filter selects more than this fraction of rows, use SlicesIterator to copy ranges of values. Otherwise iterate over individual rows using IndexIterator

Functionsยง

build_filterDeprecated
Returns a prepared function optimized to filter multiple arrays.
filter
Returns a filtered values [Array] where the corresponding elements of predicate are true.
filter_array ๐Ÿ”’
filter_bits ๐Ÿ”’
Filter the packed bitmask buffer, with predicate starting at bit offset offset
filter_boolean ๐Ÿ”’
filter implementation for boolean buffers
filter_byte_view ๐Ÿ”’
filter implementation for byte view arrays.
filter_bytes ๐Ÿ”’
filter implementation for byte arrays
filter_count ๐Ÿ”’
Counts the number of set bits in filter
filter_dict ๐Ÿ”’
filter implementation for dictionaries
filter_fixed_size_binary ๐Ÿ”’
filter_native ๐Ÿ”’
filter_null_mask ๐Ÿ”’
Computes a new null mask for data based on predicate
filter_primitive ๐Ÿ”’
filter implementation for primitive arrays
filter_record_batch
Returns a filtered [RecordBatch] where the corresponding elements of predicate are true.
filter_run_end_array ๐Ÿ”’
Filter any supported [RunArray] based on a FilterPredicate
filter_sparse_union ๐Ÿ”’
filter implementation for sparse unions
filter_struct ๐Ÿ”’
filter implementation for structs
multiple_arrays ๐Ÿ”’
prep_null_mask_filter
Remove null values by do a bitmask AND operation with null bits and the boolean bits.

Type Aliasesยง

FilterDeprecated
Function that can filter arbitrary arrays