Files
doris/be/src/vec/aggregate_functions/aggregate_function_sum.h

250 lines
10 KiB
C++

// 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.
// This file is copied from
// https://github.com/ClickHouse/ClickHouse/blob/master/src/AggregateFunctions/AggregateFunctionSum.h
// and modified by Doris
#pragma once
#include <stddef.h>
#include <memory>
#include <type_traits>
#include <vector>
#include "vec/aggregate_functions/aggregate_function.h"
#include "vec/columns/column.h"
#include "vec/common/assert_cast.h"
#include "vec/core/field.h"
#include "vec/core/types.h"
#include "vec/data_types/data_type.h"
#include "vec/data_types/data_type_decimal.h"
#include "vec/data_types/data_type_fixed_length_object.h"
#include "vec/io/io_helper.h"
namespace doris {
namespace vectorized {
class Arena;
class BufferReadable;
class BufferWritable;
template <typename T>
class ColumnDecimal;
template <typename T>
class DataTypeNumber;
template <typename>
class ColumnVector;
} // namespace vectorized
} // namespace doris
namespace doris::vectorized {
template <typename T>
struct AggregateFunctionSumData {
T sum {};
void add(T value) {
#ifdef __clang__
#pragma clang fp reassociate(on)
#endif
sum += value;
}
void merge(const AggregateFunctionSumData& rhs) { sum += rhs.sum; }
void write(BufferWritable& buf) const { write_binary(sum, buf); }
void read(BufferReadable& buf) { read_binary(sum, buf); }
T get() const { return sum; }
};
/// Counts the sum of the numbers.
template <typename T, typename TResult, typename Data>
class AggregateFunctionSum final
: public IAggregateFunctionDataHelper<Data, AggregateFunctionSum<T, TResult, Data>> {
public:
using ResultDataType = std::conditional_t<IsDecimalNumber<T>, DataTypeDecimal<TResult>,
DataTypeNumber<TResult>>;
using ColVecType = std::conditional_t<IsDecimalNumber<T>, ColumnDecimal<T>, ColumnVector<T>>;
using ColVecResult =
std::conditional_t<IsDecimalNumber<T>, ColumnDecimal<TResult>, ColumnVector<TResult>>;
String get_name() const override { return "sum"; }
AggregateFunctionSum(const DataTypes& argument_types_)
: IAggregateFunctionDataHelper<Data, AggregateFunctionSum<T, TResult, Data>>(
argument_types_),
scale(get_decimal_scale(*argument_types_[0])) {}
DataTypePtr get_return_type() const override {
if constexpr (IsDecimalNumber<T>) {
return std::make_shared<ResultDataType>(ResultDataType::max_precision(), scale);
} else {
return std::make_shared<ResultDataType>();
}
}
void add(AggregateDataPtr __restrict place, const IColumn** columns, ssize_t row_num,
Arena*) const override {
const auto& column = assert_cast<const ColVecType&>(*columns[0]);
this->data(place).add(TResult(column.get_data()[row_num]));
}
void reset(AggregateDataPtr place) const override { this->data(place).sum = {}; }
void merge(AggregateDataPtr __restrict place, ConstAggregateDataPtr rhs,
Arena*) const override {
this->data(place).merge(this->data(rhs));
}
void serialize(ConstAggregateDataPtr __restrict place, BufferWritable& buf) const override {
this->data(place).write(buf);
}
void deserialize(AggregateDataPtr __restrict place, BufferReadable& buf,
Arena*) const override {
this->data(place).read(buf);
}
void insert_result_into(ConstAggregateDataPtr __restrict place, IColumn& to) const override {
auto& column = assert_cast<ColVecResult&>(to);
column.get_data().push_back(this->data(place).get());
}
void deserialize_from_column(AggregateDataPtr places, const IColumn& column, Arena* arena,
size_t num_rows) const override {
auto& col = assert_cast<const ColumnFixedLengthObject&>(column);
auto* data = col.get_data().data();
memcpy(places, data, sizeof(Data) * num_rows);
}
void serialize_to_column(const std::vector<AggregateDataPtr>& places, size_t offset,
MutableColumnPtr& dst, const size_t num_rows) const override {
auto& col = assert_cast<ColumnFixedLengthObject&>(*dst);
DCHECK(col.item_size() == sizeof(Data))
<< "size is not equal: " << col.item_size() << " " << sizeof(Data);
col.resize(num_rows);
auto* data = col.get_data().data();
for (size_t i = 0; i != num_rows; ++i) {
*reinterpret_cast<Data*>(&data[sizeof(Data) * i]) =
*reinterpret_cast<Data*>(places[i] + offset);
}
}
void streaming_agg_serialize_to_column(const IColumn** columns, MutableColumnPtr& dst,
const size_t num_rows, Arena* arena) const override {
auto& col = assert_cast<ColumnFixedLengthObject&>(*dst);
auto& src = assert_cast<const ColVecType&>(*columns[0]);
DCHECK(col.item_size() == sizeof(Data))
<< "size is not equal: " << col.item_size() << " " << sizeof(Data);
col.resize(num_rows);
auto* src_data = src.get_data().data();
auto* dst_data = col.get_data().data();
for (size_t i = 0; i != num_rows; ++i) {
auto& state = *reinterpret_cast<Data*>(&dst_data[sizeof(Data) * i]);
state.sum = TResult(src_data[i]);
}
}
void deserialize_and_merge_from_column(AggregateDataPtr __restrict place, const IColumn& column,
Arena* arena) const override {
auto& col = assert_cast<const ColumnFixedLengthObject&>(column);
const size_t num_rows = column.size();
auto* data = reinterpret_cast<const Data*>(col.get_data().data());
for (size_t i = 0; i != num_rows; ++i) {
this->data(place).sum += data[i].sum;
}
}
void deserialize_and_merge_from_column_range(AggregateDataPtr __restrict place,
const IColumn& column, size_t begin, size_t end,
Arena* arena) const override {
DCHECK(end <= column.size() && begin <= end)
<< ", begin:" << begin << ", end:" << end << ", column.size():" << column.size();
auto& col = assert_cast<const ColumnFixedLengthObject&>(column);
auto* data = reinterpret_cast<const Data*>(col.get_data().data());
for (size_t i = begin; i <= end; ++i) {
this->data(place).sum += data[i].sum;
}
}
void deserialize_and_merge_vec(const AggregateDataPtr* places, size_t offset,
AggregateDataPtr rhs, const IColumn* column, Arena* arena,
const size_t num_rows) const override {
this->deserialize_from_column(rhs, *column, arena, num_rows);
DEFER({ this->destroy_vec(rhs, num_rows); });
this->merge_vec(places, offset, rhs, arena, num_rows);
}
void deserialize_and_merge_vec_selected(const AggregateDataPtr* places, size_t offset,
AggregateDataPtr rhs, const IColumn* column,
Arena* arena, const size_t num_rows) const override {
this->deserialize_from_column(rhs, *column, arena, num_rows);
DEFER({ this->destroy_vec(rhs, num_rows); });
this->merge_vec_selected(places, offset, rhs, arena, num_rows);
}
void serialize_without_key_to_column(ConstAggregateDataPtr __restrict place,
IColumn& to) const override {
auto& col = assert_cast<ColumnFixedLengthObject&>(to);
DCHECK(col.item_size() == sizeof(Data))
<< "size is not equal: " << col.item_size() << " " << sizeof(Data);
size_t old_size = col.size();
col.resize(old_size + 1);
(reinterpret_cast<Data*>(col.get_data().data()) + old_size)->sum = this->data(place).sum;
}
MutableColumnPtr create_serialize_column() const override {
return ColumnFixedLengthObject::create(sizeof(Data));
}
DataTypePtr get_serialized_type() const override {
return std::make_shared<DataTypeFixedLengthObject>();
}
private:
UInt32 scale;
};
template <typename T, bool level_up>
struct SumSimple {
/// @note It uses slow Decimal128 (cause we need such a variant). sumWithOverflow is faster for Decimal32/64
using ResultType = std::conditional_t<level_up, DisposeDecimal<T, NearestFieldType<T>>, T>;
using AggregateDataType = AggregateFunctionSumData<ResultType>;
using Function = AggregateFunctionSum<T, ResultType, AggregateDataType>;
};
template <typename T>
using AggregateFunctionSumSimple = typename SumSimple<T, true>::Function;
template <typename T, bool level_up>
struct SumSimpleDecimal256 {
/// @note It uses slow Decimal128 (cause we need such a variant). sumWithOverflow is faster for Decimal32/64
using ResultType = std::conditional_t<level_up, DisposeDecimal256<T, NearestFieldType<T>>, T>;
using AggregateDataType = AggregateFunctionSumData<ResultType>;
using Function = AggregateFunctionSum<T, ResultType, AggregateDataType>;
};
template <typename T>
using AggregateFunctionSumSimpleDecimal256 = typename SumSimpleDecimal256<T, true>::Function;
// do not level up return type for agg reader
template <typename T>
using AggregateFunctionSumSimpleReader = typename SumSimple<T, false>::Function;
} // namespace doris::vectorized