common_function/scalars/math/
modulo.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
// Copyright 2023 Greptime Team
//
// Licensed 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.

use std::fmt;
use std::fmt::Display;

use common_query::error;
use common_query::error::{ArrowComputeSnafu, InvalidFuncArgsSnafu, Result};
use common_query::prelude::{Signature, Volatility};
use datatypes::arrow::compute;
use datatypes::arrow::compute::kernels::numeric;
use datatypes::arrow::datatypes::DataType as ArrowDataType;
use datatypes::prelude::ConcreteDataType;
use datatypes::vectors::{Helper, VectorRef};
use snafu::{ensure, ResultExt};

use crate::function::{Function, FunctionContext};

const NAME: &str = "mod";

/// The function to find remainders
#[derive(Clone, Debug, Default)]
pub struct ModuloFunction;

impl Display for ModuloFunction {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", NAME.to_ascii_uppercase())
    }
}

impl Function for ModuloFunction {
    fn name(&self) -> &str {
        NAME
    }

    fn return_type(&self, input_types: &[ConcreteDataType]) -> Result<ConcreteDataType> {
        if input_types.iter().all(ConcreteDataType::is_signed) {
            Ok(ConcreteDataType::int64_datatype())
        } else if input_types.iter().all(ConcreteDataType::is_unsigned) {
            Ok(ConcreteDataType::uint64_datatype())
        } else {
            Ok(ConcreteDataType::float64_datatype())
        }
    }

    fn signature(&self) -> Signature {
        Signature::uniform(2, ConcreteDataType::numerics(), Volatility::Immutable)
    }

    fn eval(&self, _func_ctx: &FunctionContext, columns: &[VectorRef]) -> Result<VectorRef> {
        ensure!(
            columns.len() == 2,
            InvalidFuncArgsSnafu {
                err_msg: format!(
                    "The length of the args is not correct, expect exactly two, have: {}",
                    columns.len()
                ),
            }
        );
        let nums = &columns[0];
        let divs = &columns[1];
        let nums_arrow_array = &nums.to_arrow_array();
        let divs_arrow_array = &divs.to_arrow_array();
        let array = numeric::rem(nums_arrow_array, divs_arrow_array).context(ArrowComputeSnafu)?;

        let result = match nums.data_type() {
            ConcreteDataType::Int8(_)
            | ConcreteDataType::Int16(_)
            | ConcreteDataType::Int32(_)
            | ConcreteDataType::Int64(_) => compute::cast(&array, &ArrowDataType::Int64),
            ConcreteDataType::UInt8(_)
            | ConcreteDataType::UInt16(_)
            | ConcreteDataType::UInt32(_)
            | ConcreteDataType::UInt64(_) => compute::cast(&array, &ArrowDataType::UInt64),
            ConcreteDataType::Float32(_) | ConcreteDataType::Float64(_) => {
                compute::cast(&array, &ArrowDataType::Float64)
            }
            _ => unreachable!("unexpected datatype: {:?}", nums.data_type()),
        }
        .context(ArrowComputeSnafu)?;
        Helper::try_into_vector(&result).context(error::FromArrowArraySnafu)
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use common_error::ext::ErrorExt;
    use datatypes::value::Value;
    use datatypes::vectors::{Float64Vector, Int32Vector, StringVector, UInt32Vector};

    use super::*;
    #[test]
    fn test_mod_function_signed() {
        let function = ModuloFunction;
        assert_eq!("mod", function.name());
        assert_eq!(
            ConcreteDataType::int64_datatype(),
            function
                .return_type(&[ConcreteDataType::int64_datatype()])
                .unwrap()
        );
        assert_eq!(
            ConcreteDataType::int64_datatype(),
            function
                .return_type(&[ConcreteDataType::int32_datatype()])
                .unwrap()
        );

        let nums = vec![18, -17, 5, -6];
        let divs = vec![4, 8, -5, -5];

        let args: Vec<VectorRef> = vec![
            Arc::new(Int32Vector::from_vec(nums.clone())),
            Arc::new(Int32Vector::from_vec(divs.clone())),
        ];
        let result = function.eval(&FunctionContext::default(), &args).unwrap();
        assert_eq!(result.len(), 4);
        for i in 0..4 {
            let p: i64 = (nums[i] % divs[i]) as i64;
            assert!(matches!(result.get(i), Value::Int64(v) if v == p));
        }
    }

    #[test]
    fn test_mod_function_unsigned() {
        let function = ModuloFunction;
        assert_eq!("mod", function.name());
        assert_eq!(
            ConcreteDataType::uint64_datatype(),
            function
                .return_type(&[ConcreteDataType::uint64_datatype()])
                .unwrap()
        );
        assert_eq!(
            ConcreteDataType::uint64_datatype(),
            function
                .return_type(&[ConcreteDataType::uint32_datatype()])
                .unwrap()
        );

        let nums: Vec<u32> = vec![18, 17, 5, 6];
        let divs: Vec<u32> = vec![4, 8, 5, 5];

        let args: Vec<VectorRef> = vec![
            Arc::new(UInt32Vector::from_vec(nums.clone())),
            Arc::new(UInt32Vector::from_vec(divs.clone())),
        ];
        let result = function.eval(&FunctionContext::default(), &args).unwrap();
        assert_eq!(result.len(), 4);
        for i in 0..4 {
            let p: u64 = (nums[i] % divs[i]) as u64;
            assert!(matches!(result.get(i), Value::UInt64(v) if v == p));
        }
    }

    #[test]
    fn test_mod_function_float() {
        let function = ModuloFunction;
        assert_eq!("mod", function.name());
        assert_eq!(
            ConcreteDataType::float64_datatype(),
            function
                .return_type(&[ConcreteDataType::float64_datatype()])
                .unwrap()
        );
        assert_eq!(
            ConcreteDataType::float64_datatype(),
            function
                .return_type(&[ConcreteDataType::float32_datatype()])
                .unwrap()
        );

        let nums = vec![18.0, 17.0, 5.0, 6.0];
        let divs = vec![4.0, 8.0, 5.0, 5.0];

        let args: Vec<VectorRef> = vec![
            Arc::new(Float64Vector::from_vec(nums.clone())),
            Arc::new(Float64Vector::from_vec(divs.clone())),
        ];
        let result = function.eval(&FunctionContext::default(), &args).unwrap();
        assert_eq!(result.len(), 4);
        for i in 0..4 {
            let p: f64 = nums[i] % divs[i];
            assert!(matches!(result.get(i), Value::Float64(v) if v == p));
        }
    }

    #[test]
    fn test_mod_function_errors() {
        let function = ModuloFunction;
        assert_eq!("mod", function.name());
        let nums = vec![27];
        let divs = vec![0];

        let args: Vec<VectorRef> = vec![
            Arc::new(Int32Vector::from_vec(nums.clone())),
            Arc::new(Int32Vector::from_vec(divs.clone())),
        ];
        let result = function.eval(&FunctionContext::default(), &args);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().output_msg();
        assert_eq!(
            err_msg,
            "Failed to perform compute operation on arrow arrays: Divide by zero error"
        );

        let nums = vec![27];

        let args: Vec<VectorRef> = vec![Arc::new(Int32Vector::from_vec(nums.clone()))];
        let result = function.eval(&FunctionContext::default(), &args);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().output_msg();
        assert!(
            err_msg.contains("The length of the args is not correct, expect exactly two, have: 1")
        );

        let nums = vec!["27"];
        let divs = vec!["4"];
        let args: Vec<VectorRef> = vec![
            Arc::new(StringVector::from(nums.clone())),
            Arc::new(StringVector::from(divs.clone())),
        ];
        let result = function.eval(&FunctionContext::default(), &args);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().output_msg();
        assert!(err_msg.contains("Invalid arithmetic operation"));
    }
}