-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
partition_evaluator.rs
107 lines (96 loc) · 4 KB
/
partition_evaluator.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
//! partition evaluation module
use crate::window::window_expr::BuiltinWindowState;
use crate::window::WindowAggState;
use arrow::array::ArrayRef;
use datafusion_common::Result;
use datafusion_common::{DataFusionError, ScalarValue};
use std::fmt::Debug;
use std::ops::Range;
/// Partition evaluator
pub trait PartitionEvaluator: Debug + Send {
/// Whether the evaluator should be evaluated with rank
fn include_rank(&self) -> bool {
false
}
/// Returns state of the Built-in Window Function
fn state(&self) -> Result<BuiltinWindowState> {
// If we do not use state we just return Default
Ok(BuiltinWindowState::Default)
}
/// Updates the internal state for Built-in window function
// state is useful to update internal state for Built-in window function.
// idx is the index of last row for which result is calculated.
// range_columns is the result of order by column values. It is used to calculate rank boundaries
// sort_partition_points is the boundaries of each rank in the range_column. It is used to update rank.
fn update_state(
&mut self,
_state: &WindowAggState,
_idx: usize,
_range_columns: &[ArrayRef],
_sort_partition_points: &[Range<usize>],
) -> Result<()> {
// If we do not use state, update_state does nothing
Ok(())
}
fn set_state(&mut self, _state: &BuiltinWindowState) -> Result<()> {
Err(DataFusionError::NotImplemented(
"set_state is not implemented for this window function".to_string(),
))
}
/// Gets the range where Built-in window function result is calculated.
// idx is the index of last row for which result is calculated.
// n_rows is the number of rows of the input record batch (Used during bound check)
fn get_range(&self, _idx: usize, _n_rows: usize) -> Result<Range<usize>> {
Err(DataFusionError::NotImplemented(
"get_range is not implemented for this window function".to_string(),
))
}
/// Evaluate the partition evaluator against the partition
fn evaluate(&self, _values: &[ArrayRef], _num_rows: usize) -> Result<ArrayRef> {
Err(DataFusionError::NotImplemented(
"evaluate is not implemented by default".into(),
))
}
/// Evaluate window function result inside given range
fn evaluate_stateful(&mut self, _values: &[ArrayRef]) -> Result<ScalarValue> {
Err(DataFusionError::NotImplemented(
"evaluate_stateful is not implemented by default".into(),
))
}
/// evaluate the partition evaluator against the partition but with rank
fn evaluate_with_rank(
&self,
_num_rows: usize,
_ranks_in_partition: &[Range<usize>],
) -> Result<ArrayRef> {
Err(DataFusionError::NotImplemented(
"evaluate_partition_with_rank is not implemented by default".into(),
))
}
/// evaluate window function result inside given range
fn evaluate_inside_range(
&self,
_values: &[ArrayRef],
_range: &Range<usize>,
) -> Result<ScalarValue> {
Err(DataFusionError::NotImplemented(
"evaluate_inside_range is not implemented by default".into(),
))
}
}