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 <Columns/ColumnsNumber.h>
|
|
|
|
#include <DataTypes/DataTypesNumber.h>
|
|
|
|
#include <Functions/FunctionFactory.h>
|
|
|
|
#include <Functions/IFunction.h>
|
|
|
|
#include <IO/WriteHelpers.h>
|
|
|
|
#include <Common/typeid_cast.h>
|
2021-10-02 07:13:14 +00:00
|
|
|
#include <base/range.h>
|
2020-06-19 10:06:42 +00:00
|
|
|
|
|
|
|
#include <constants.h>
|
|
|
|
#include <h3api.h>
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
namespace DB
|
|
|
|
{
|
2020-01-31 20:16:46 +00:00
|
|
|
namespace ErrorCodes
|
|
|
|
{
|
2020-02-25 18:02:41 +00:00
|
|
|
extern const int ILLEGAL_TYPE_OF_ARGUMENT;
|
2020-01-31 20:16:46 +00:00
|
|
|
extern const int ARGUMENT_OUT_OF_BOUND;
|
|
|
|
}
|
|
|
|
|
2020-09-07 18:00:37 +00:00
|
|
|
namespace
|
|
|
|
{
|
|
|
|
|
2019-12-05 13:42:37 +00:00
|
|
|
// Average metric edge length of H3 hexagon. The edge length `e` for given resolution `res` can
|
|
|
|
// be used for converting metric search radius `radius` to hexagon search ring size `k` that is
|
|
|
|
// used by `H3kRing` function. For small enough search area simple flat approximation can be used,
|
|
|
|
// i.e. the smallest `k` that satisfies relation `3 k^2 - 3 k + 1 >= (radius / e)^2` should be
|
|
|
|
// chosen
|
|
|
|
class FunctionH3EdgeLengthM : public IFunction
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static constexpr auto name = "h3EdgeLengthM";
|
|
|
|
|
2021-06-01 12:20:52 +00:00
|
|
|
static FunctionPtr create(ContextPtr) { return std::make_shared<FunctionH3EdgeLengthM>(); }
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
std::string getName() const override { return name; }
|
|
|
|
|
|
|
|
size_t getNumberOfArguments() const override { return 1; }
|
|
|
|
bool useDefaultImplementationForConstants() const override { return true; }
|
2021-06-22 16:21:23 +00:00
|
|
|
bool isSuitableForShortCircuitArgumentsExecution(const DataTypesWithConstInfo & /*arguments*/) const override { return false; }
|
2019-12-05 13:42:37 +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 13:42:37 +00:00
|
|
|
if (!WhichDataType(arg).isUInt8())
|
|
|
|
throw Exception(
|
2021-07-13 12:54:00 +00:00
|
|
|
ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT,
|
|
|
|
"Illegal type {} of argument {} of function {}. Must be UInt8",
|
|
|
|
arg->getName(), 1, getName());
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
return std::make_shared<DataTypeFloat64>();
|
|
|
|
}
|
|
|
|
|
2020-11-17 13:24:45 +00:00
|
|
|
ColumnPtr executeImpl(const ColumnsWithTypeAndName & arguments, const DataTypePtr &, size_t input_rows_count) const override
|
2019-12-05 13:42:37 +00:00
|
|
|
{
|
2020-10-19 13:42:14 +00:00
|
|
|
const auto * col_hindex = arguments[0].column.get();
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
auto dst = ColumnVector<Float64>::create();
|
|
|
|
auto & dst_data = dst->getData();
|
|
|
|
dst_data.resize(input_rows_count);
|
|
|
|
|
2021-06-15 19:55:21 +00:00
|
|
|
for (const auto row : collections::range(0, input_rows_count))
|
2019-12-05 13:42:37 +00:00
|
|
|
{
|
2020-01-31 20:16:46 +00:00
|
|
|
const UInt64 resolution = col_hindex->getUInt(row);
|
|
|
|
if (resolution > MAX_H3_RES)
|
2021-07-13 12:54:00 +00:00
|
|
|
throw Exception(
|
|
|
|
ErrorCodes::ARGUMENT_OUT_OF_BOUND,
|
|
|
|
"The argument 'resolution' ({}) of function {} is out of bounds because the maximum resolution in H3 library is ",
|
|
|
|
resolution, getName(), MAX_H3_RES);
|
2019-12-05 13:42:37 +00:00
|
|
|
|
2021-06-22 09:23:27 +00:00
|
|
|
Float64 res = getHexagonEdgeLengthAvgM(resolution);
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
dst_data[row] = res;
|
|
|
|
}
|
|
|
|
|
2020-10-19 13:42:14 +00:00
|
|
|
return dst;
|
2019-12-05 13:42:37 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2020-09-07 18:00:37 +00:00
|
|
|
}
|
2019-12-05 13:42:37 +00:00
|
|
|
|
|
|
|
void registerFunctionH3EdgeLengthM(FunctionFactory & factory)
|
|
|
|
{
|
|
|
|
factory.registerFunction<FunctionH3EdgeLengthM>();
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
2020-11-04 14:51:41 +00:00
|
|
|
|
|
|
|
#endif
|