Pushdown hyperbolic functions (#78)

Signed-off-by: Ahmet Gedemenli <[email protected]>

Author: sfc-gh-agedemenli

duckdb_pglake/src/duckdb_pglake_extension.cpp

@@ -75,6 +75,37 @@ inline void ThrowInternalError(DataChunk &args, ExpressionState &state, Vector &
 	throw InternalException(str);
 }
 
+
+inline void AcoshPG(DataChunk &args, ExpressionState &state, Vector &result)
+{
+	auto &input_vector = args.data[0];
+
+	UnaryExecutor::Execute<double, double>(
+		input_vector, result, args.size(),
+		[&](double value) {
+			if (value < 1.0) {
+				throw InvalidInputException("input is out of range");
+			}
+			return std::acosh(value);
+		});
+}
+
+
+inline void AtanhPG(DataChunk &args, ExpressionState &state, Vector &result)
+{
+	auto &input_vector = args.data[0];
+
+	UnaryExecutor::Execute<double, double>(
+		input_vector, result, args.size(),
+		[&](double value) {
+			if (value < -1.0 || value > 1.0) {
+				throw InvalidInputException("input is out of range");
+			}
+			return std::atanh(value);
+		});
+}
+
+
 /*
 * Postgres and DuckDB have different behavior for the SUBSTRING function when
 * the length or offset is negative. This function implements the Postgres
@@ -236,6 +267,12 @@ static void LoadInternal(DatabaseInstance &instance) {
     auto to_date_function = ScalarFunction("to_date", {LogicalType::DOUBLE}, LogicalType::DATE, ToDateScalarFun);
     ExtensionUtil::RegisterFunction(instance, to_date_function);
 
+    auto acosh_function = ScalarFunction("acosh_pg", {LogicalType::DOUBLE}, LogicalType::DOUBLE, AcoshPG);
+    ExtensionUtil::RegisterFunction(instance, acosh_function);
+
+	auto atanh_function = ScalarFunction("atanh_pg", {LogicalType::DOUBLE}, LogicalType::DOUBLE, AtanhPG);
+	ExtensionUtil::RegisterFunction(instance, atanh_function);
+
 	auto nullify_any_type = ScalarFunction("nullify_any_type", {LogicalType::ANY}, LogicalType::SQLNULL, NullifyAnyType);
 	ExtensionUtil::RegisterFunction(instance, nullify_any_type);
 

pg_lake_engine/pg_lake_engine--3.0--3.1.sql

@@ -16,6 +16,18 @@ CREATE FUNCTION __lake__internal__nsp__.to_hex(bytea)
  IMMUTABLE PARALLEL SAFE STRICT
 AS 'MODULE_PATHNAME', $function$pg_lake_internal_dummy_function$function$;
 
+CREATE FUNCTION __lake__internal__nsp__.acosh_pg(double precision)
+ RETURNS double precision
+ LANGUAGE C
+ IMMUTABLE PARALLEL SAFE STRICT
+AS 'MODULE_PATHNAME', $function$pg_lake_internal_dummy_function$function$;
+
+CREATE FUNCTION __lake__internal__nsp__.atanh_pg(double precision)
+ RETURNS double precision
+ LANGUAGE C
+ IMMUTABLE PARALLEL SAFE STRICT
+AS 'MODULE_PATHNAME', $function$pg_lake_internal_dummy_function$function$;
+
 CREATE FUNCTION __lake__internal__nsp__.from_hex(text)
  RETURNS bytea
  LANGUAGE C

pg_lake_engine/src/pgduck/rewrite_query.c

@@ -163,6 +163,7 @@ static Node *RewriteFuncExprArrayLength(Node *node, void *context);
 static Node *RewriteFuncExprPostgisBytea(Node *node, void *context);
 static Node *RewriteFuncExprTrigonometry(Node *node, void *context);
 static Node *RewriteFuncExprInverseTrigonometry(Node *node, void *context);
+static Node *RewriteFuncExprHyperbolic(Node *node, void *context);
 static Node *RewriteFuncExprJsonbArrayLength(Node *node, void *context);
 static Node *RewriteFuncExprEncode(Node *node, void *context);
 static Node *RewriteFuncExprDecode(Node *node, void *context);
@@ -283,6 +284,14 @@ static FunctionCallRewriteRuleByName BuiltinFunctionCallRewriteRulesByName[] =
 		"pg_catalog", "tand", RewriteFuncExprTrigonometry, 0
 	},
 
+	/* hyperbolic functions */
+	{
+		"pg_catalog", "acosh", RewriteFuncExprHyperbolic, 0
+	},
+	{
+		"pg_catalog", "atanh", RewriteFuncExprHyperbolic, 0
+	},
+
 	/* explicit calls to cast functions */
 	{
 		"pg_catalog", "bool", RewriteFuncExprCast, 0
@@ -2187,6 +2196,38 @@ RewriteFuncExprInverseTrigonometry(Node *node, void *context)
 }
 
 
+/*
+ * RewriteFuncExprHyperbolic rewrites acosh(..) and atanh(...) function calls
+ * into acosh_pg(..) and atanh_pg(..) function calls.
+ */
+static Node *
+RewriteFuncExprHyperbolic(Node *node, void *context)
+{
+	FuncExpr   *funcExpr = castNode(FuncExpr, node);
+	List *funcName;
+
+	switch (funcExpr->funcid)
+	{
+		case F_ACOSH:
+			funcName = list_make2(makeString(PG_LAKE_INTERNAL_NSP), makeString("acosh_pg"));
+			break;
+		
+		case F_ATANH:
+			funcName = list_make2(makeString(PG_LAKE_INTERNAL_NSP), makeString("atanh_pg"));
+			break;
+
+		default:
+			elog(ERROR, "unexpected function ID in rewrite %d", funcExpr->funcid);
+	}
+
+	Oid argTypes[] = {FLOAT8OID};
+	int argCount = 1;
+	funcExpr->funcid = LookupFuncName(funcName, argCount, argTypes, false);
+
+	return (Node *) funcExpr;
+}
+
+
 /*
  * RewriteFuncExprPostgisBytea rewrites bytea(geometry) function calls into
  * ST_AsWKB(..) function calls to push down (implicit) casts.

pg_lake_engine/src/pgduck/shippable_builtin_functions.c

@@ -346,6 +346,11 @@ static const PGDuckShippableFunction ShippableBuiltinProcs[] =
 	{"tan", 'f', 1, {"float8"}, NULL},
 	{"tand", 'f', 1, {"float8"}, NULL},
 
+	/* Hyperbolic functions */
+	{"asinh", 'f', 1, {"float8"}, NULL},
+	{"acosh", 'f', 1, {"float8"}, NULL},
+	{"atanh", 'f', 1, {"float8"}, NULL},
+
 	/* array functions */
 	{"array_append", 'f', 2, {"anycompatiblearray", "anycompatible"}, NULL},
 	{"array_cat", 'f', 2, {"anycompatiblearray", "anycompatiblearray"}, NULL},

pg_lake_spatial/tests/pytests/test_internal_schema.py

@@ -21,6 +21,6 @@ def test_internal_schema(
     """,
         pg_conn,
     )[0][0]
-    assert result == 61
+    assert result == 63
 
     pg_conn.rollback()

pg_lake_table/tests/pytests/test_mathematical_functions_pushdown.py

@@ -145,6 +145,24 @@
         "tan(radians(",
         True,
     ),
+    (
+        "asinh",
+        "WHERE col_double > 1 and abs(asinh(col_double) - 0.9503469) < 0.001",
+        "asinh(",
+        True,
+    ),
+    (
+        "acosh",
+        "WHERE col_double > 1 and abs(acosh(col_double) - 0.4435682) < 0.001",
+        "acosh_pg(",
+        True,
+    ),
+    (
+        "atanh",
+        "WHERE abs(col_double)<1 and abs(atanh(col_double) - 0.6183813) < 0.001",
+        "atanh_pg(",
+        True,
+    ),
 ]