Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix documentation
  • Loading branch information
alamb committed Aug 11, 2024
commit 149406bb6f45a79112b844d8f69f5c0937a3a6d7
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,33 @@ fn filter_to_nulls(filter: &BooleanArray) -> Option<NullBuffer> {
/// Subsequent applications of aggregate functions that ignore NULLs (most of
/// them) will thus ignore the filtered rows as well.
///
/// # Output element is `true`
/// * A `true` in the output represents non null output for all values that were both:
/// # Output element is `true` (and thus output is non-null)
///
/// A `true` in the output represents non null output for all values that were *both*:
///
/// * `true` in any `opt_filter` (aka values that passed the filter)
///
/// * `non null` in `input`
///
/// # Output element is `false`
/// * is false (null) for all values that were false in the filter or null in the input
/// # Output element is `false` (and thus output is null)
///
/// A `false` in the output represents an input that was *either*:
///
/// * `null`
///
/// * filtered (aka the value was `false` or `null` in the filter)
///
/// # Example
///
/// ```text
/// ┌─────┐ ┌─────┐ ┌─────┐
/// │true │ │NULL │ │NULL
/// │true │ │NULL │ │false
/// │true │ │ │true │ │true │
/// │true │ ───┼─── │false│ ────────▶ │false│ filtered_nulls
/// │false│ │ │NULL │ │NULL
/// │false│ │true │ │true
/// │false│ │ │NULL │ │false
/// │false│ │true │ │false
/// └─────┘ └─────┘ └─────┘
/// array opt_filter output nulls
/// array opt_filter output
/// .nulls()
///
/// false = NULL true = pass false = NULL Meanings
Expand Down