mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-17 05:20:37 +00:00
91 lines
10 KiB
HTML
91 lines
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/function/src/scalars/math.rs`."><title>math.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="common_function" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">common_function/scalars/</div>math.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
|
|
<a href=#2 id=2 data-nosnippet>2</a>//
|
|
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
|
|
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
|
|
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
|
|
<a href=#6 id=6 data-nosnippet>6</a>//
|
|
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
|
|
<a href=#8 id=8 data-nosnippet>8</a>//
|
|
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
|
|
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
|
|
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
|
|
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub mod </span>clamp;
|
|
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">mod </span>modulo;
|
|
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">mod </span>rate;
|
|
<a href=#18 id=18 data-nosnippet>18</a>
|
|
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::fmt;
|
|
<a href=#20 id=20 data-nosnippet>20</a>
|
|
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">pub use </span>clamp::{ClampFunction, ClampMaxFunction, ClampMinFunction};
|
|
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>datafusion::arrow::datatypes::DataType;
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>datafusion::error::DataFusionError;
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>datafusion::logical_expr::ColumnarValue;
|
|
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>datafusion_common::internal_err;
|
|
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>datafusion_expr::{ScalarFunctionArgs, Signature, Volatility};
|
|
<a href=#27 id=27 data-nosnippet>27</a>
|
|
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span><span class="kw">crate</span>::function::Function;
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::function_registry::FunctionRegistry;
|
|
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::scalars::math::modulo::ModuloFunction;
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span><span class="kw">crate</span>::scalars::math::rate::RateFunction;
|
|
<a href=#32 id=32 data-nosnippet>32</a>
|
|
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>MathFunction;
|
|
<a href=#34 id=34 data-nosnippet>34</a>
|
|
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">impl </span>MathFunction {
|
|
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">pub fn </span>register(registry: <span class="kw-2">&</span>FunctionRegistry) {
|
|
<a href=#37 id=37 data-nosnippet>37</a> registry.register_scalar(ModuloFunction::default());
|
|
<a href=#38 id=38 data-nosnippet>38</a> registry.register_scalar(RateFunction::default());
|
|
<a href=#39 id=39 data-nosnippet>39</a> registry.register_scalar(RangeFunction::default());
|
|
<a href=#40 id=40 data-nosnippet>40</a> registry.register_scalar(ClampFunction::default());
|
|
<a href=#41 id=41 data-nosnippet>41</a> registry.register_scalar(ClampMinFunction::default());
|
|
<a href=#42 id=42 data-nosnippet>42</a> registry.register_scalar(ClampMaxFunction::default());
|
|
<a href=#43 id=43 data-nosnippet>43</a> }
|
|
<a href=#44 id=44 data-nosnippet>44</a>}
|
|
<a href=#45 id=45 data-nosnippet>45</a>
|
|
<a href=#46 id=46 data-nosnippet>46</a><span class="doccomment">/// `RangeFunction` will never be used as a normal function,
|
|
<a href=#47 id=47 data-nosnippet>47</a>/// just for datafusion to generate logical plan for RangeSelect
|
|
<a href=#48 id=48 data-nosnippet>48</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#49 id=49 data-nosnippet>49</a></span><span class="kw">struct </span>RangeFunction {
|
|
<a href=#50 id=50 data-nosnippet>50</a> signature: Signature,
|
|
<a href=#51 id=51 data-nosnippet>51</a>}
|
|
<a href=#52 id=52 data-nosnippet>52</a>
|
|
<a href=#53 id=53 data-nosnippet>53</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>RangeFunction {
|
|
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#55 id=55 data-nosnippet>55</a> <span class="macro">write!</span>(f, <span class="string">"RANGE_FN"</span>)
|
|
<a href=#56 id=56 data-nosnippet>56</a> }
|
|
<a href=#57 id=57 data-nosnippet>57</a>}
|
|
<a href=#58 id=58 data-nosnippet>58</a>
|
|
<a href=#59 id=59 data-nosnippet>59</a><span class="kw">impl </span>Default <span class="kw">for </span>RangeFunction {
|
|
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#61 id=61 data-nosnippet>61</a> <span class="self">Self </span>{
|
|
<a href=#62 id=62 data-nosnippet>62</a> signature: Signature::variadic_any(Volatility::Immutable),
|
|
<a href=#63 id=63 data-nosnippet>63</a> }
|
|
<a href=#64 id=64 data-nosnippet>64</a> }
|
|
<a href=#65 id=65 data-nosnippet>65</a>}
|
|
<a href=#66 id=66 data-nosnippet>66</a>
|
|
<a href=#67 id=67 data-nosnippet>67</a><span class="kw">impl </span>Function <span class="kw">for </span>RangeFunction {
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="string">"range_fn"
|
|
<a href=#70 id=70 data-nosnippet>70</a> </span>}
|
|
<a href=#71 id=71 data-nosnippet>71</a>
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="comment">// The first argument to range_fn is the expression to be evaluated
|
|
<a href=#73 id=73 data-nosnippet>73</a> </span><span class="kw">fn </span>return_type(<span class="kw-2">&</span><span class="self">self</span>, input_types: <span class="kw-2">&</span>[DataType]) -> datafusion_common::Result<DataType> {
|
|
<a href=#74 id=74 data-nosnippet>74</a> input_types
|
|
<a href=#75 id=75 data-nosnippet>75</a> .first()
|
|
<a href=#76 id=76 data-nosnippet>76</a> .cloned()
|
|
<a href=#77 id=77 data-nosnippet>77</a> .ok_or(DataFusionError::Internal(
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="string">"No expr found in range_fn"</span>.into(),
|
|
<a href=#79 id=79 data-nosnippet>79</a> ))
|
|
<a href=#80 id=80 data-nosnippet>80</a> }
|
|
<a href=#81 id=81 data-nosnippet>81</a>
|
|
<a href=#82 id=82 data-nosnippet>82</a> <span class="doccomment">/// `range_fn` will never been used. As long as a legal signature is returned, the specific content of the signature does not matter.
|
|
<a href=#83 id=83 data-nosnippet>83</a> /// In fact, the arguments loaded by `range_fn` are very complicated, and it is difficult to use `Signature` to describe
|
|
<a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">fn </span>signature(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Signature {
|
|
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw-2">&</span><span class="self">self</span>.signature
|
|
<a href=#86 id=86 data-nosnippet>86</a> }
|
|
<a href=#87 id=87 data-nosnippet>87</a>
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">fn </span>invoke_with_args(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: ScalarFunctionArgs) -> datafusion_common::Result<ColumnarValue> {
|
|
<a href=#89 id=89 data-nosnippet>89</a> <span class="macro">internal_err!</span>(<span class="string">"not expected to invoke 'range_fn' directly"</span>)
|
|
<a href=#90 id=90 data-nosnippet>90</a> }
|
|
<a href=#91 id=91 data-nosnippet>91</a>}</code></pre></div></section></main></body></html> |