ClickHouse/src/Functions/h3kRing.cpp

122 lines
3.8 KiB
C++
Raw Normal View History

2020-11-04 14:51:41 +00:00
#if !defined(ARCADIA_BUILD)
# include "config_functions.h"
#endif
#if USE_H3
2020-06-19 10:06:42 +00:00
#include <vector>
#include <Columns/ColumnArray.h>
#include <Columns/ColumnsNumber.h>
#include <DataTypes/DataTypeArray.h>
#include <DataTypes/DataTypesNumber.h>
#include <DataTypes/IDataType.h>
#include <Functions/FunctionFactory.h>
#include <Functions/IFunction.h>
#include <Common/typeid_cast.h>
2021-06-15 19:55:21 +00:00
#include <common/range.h>
2020-06-19 10:06:42 +00:00
#include <h3api.h>
2019-12-05 09:42:11 +00:00
namespace DB
{
2020-08-15 08:49:54 +00:00
2020-02-25 18:10:48 +00:00
namespace ErrorCodes
{
extern const int ILLEGAL_TYPE_OF_ARGUMENT;
2020-08-15 08:49:54 +00:00
extern const int PARAMETER_OUT_OF_BOUND;
2020-02-25 18:10:48 +00:00
}
2020-08-15 08:49:54 +00:00
2020-09-07 18:00:37 +00:00
namespace
{
2019-12-05 09:42:11 +00:00
class FunctionH3KRing : public IFunction
{
public:
static constexpr auto name = "h3kRing";
2021-06-01 12:20:52 +00:00
static FunctionPtr create(ContextPtr) { return std::make_shared<FunctionH3KRing>(); }
2019-12-05 09:42:11 +00:00
std::string getName() const override { return name; }
size_t getNumberOfArguments() const override { return 2; }
bool useDefaultImplementationForConstants() const override { return true; }
2021-06-22 16:21:23 +00:00
bool isSuitableForShortCircuitArgumentsExecution(const DataTypesWithConstInfo & /*arguments*/) const override { return true; }
2019-12-05 09:42:11 +00:00
DataTypePtr getReturnTypeImpl(const DataTypes & arguments) const override
{
2020-04-22 08:31:10 +00:00
const auto * arg = arguments[0].get();
2019-12-05 09:42:11 +00:00
if (!WhichDataType(arg).isUInt64())
throw Exception(
2021-07-13 12:54:00 +00:00
ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT,
"Illegal type {} of argument {} of function {}. Must be UInt64",
arg->getName(), 1, getName());
2019-12-05 09:42:11 +00:00
arg = arguments[1].get();
if (!isInteger(arg))
throw Exception(
2021-07-13 12:54:00 +00:00
ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT,
"Illegal type {} of argument {} of function {}. Must be integer",
arg->getName(), 2, getName());
2019-12-05 09:42:11 +00:00
return std::make_shared<DataTypeArray>(std::make_shared<DataTypeUInt64>());
}
ColumnPtr executeImpl(const ColumnsWithTypeAndName & arguments, const DataTypePtr &, size_t input_rows_count) const override
2019-12-05 09:42:11 +00:00
{
2020-10-19 13:42:14 +00:00
const auto * col_hindex = arguments[0].column.get();
const auto * col_k = arguments[1].column.get();
2019-12-05 09:42:11 +00:00
auto dst = ColumnArray::create(ColumnUInt64::create());
auto & dst_data = dst->getData();
auto & dst_offsets = dst->getOffsets();
dst_offsets.resize(input_rows_count);
auto current_offset = 0;
std::vector<H3Index> hindex_vec;
2021-06-15 19:55:21 +00:00
for (const auto row : collections::range(0, input_rows_count))
2019-12-05 09:42:11 +00:00
{
const H3Index origin_hindex = col_hindex->getUInt(row);
const int k = col_k->getInt(row);
2021-06-22 09:23:27 +00:00
/// Overflow is possible. The function maxGridDiskSize does not check for overflow.
2020-08-15 08:49:54 +00:00
/// The calculation is similar to square of k but several times more.
/// Let's use huge underestimation as the safe bound. We should not allow to generate too large arrays nevertheless.
constexpr auto max_k = 10000;
if (k > max_k)
throw Exception(ErrorCodes::PARAMETER_OUT_OF_BOUND, "Too large 'k' argument for {} function, maximum {}", getName(), max_k);
if (k < 0)
throw Exception(ErrorCodes::PARAMETER_OUT_OF_BOUND, "Argument 'k' for {} function must be non negative", getName());
2021-06-22 09:23:27 +00:00
const auto vec_size = maxGridDiskSize(k);
2019-12-05 09:42:11 +00:00
hindex_vec.resize(vec_size);
2021-06-22 09:23:27 +00:00
gridDisk(origin_hindex, k, hindex_vec.data());
2019-12-05 09:42:11 +00:00
dst_data.reserve(dst_data.size() + vec_size);
for (auto hindex : hindex_vec)
{
if (hindex != 0)
{
2019-12-16 18:34:51 +00:00
++current_offset;
2019-12-05 09:42:11 +00:00
dst_data.insert(hindex);
}
}
dst_offsets[row] = current_offset;
}
2020-10-19 13:42:14 +00:00
return dst;
2019-12-05 09:42:11 +00:00
}
};
2020-09-07 18:00:37 +00:00
}
2019-12-05 09:42:11 +00:00
void registerFunctionH3KRing(FunctionFactory & factory)
{
factory.registerFunction<FunctionH3KRing>();
}
}
2020-11-04 14:51:41 +00:00
#endif