-
Notifications
You must be signed in to change notification settings - Fork 4k
[feature](function) Support gamma scalar function #68029
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
RH211-sys
wants to merge
3
commits into
apache:master
Choose a base branch
from
RH211-sys:feat-gamma-function
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
...core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/Gamma.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // 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. | ||
|
|
||
| package org.apache.doris.nereids.trees.expressions.functions.scalar; | ||
|
|
||
| import org.apache.doris.catalog.FunctionSignature; | ||
| import org.apache.doris.nereids.trees.expressions.Expression; | ||
| import org.apache.doris.nereids.trees.expressions.functions.AlwaysNullable; | ||
| import org.apache.doris.nereids.trees.expressions.functions.ExplicitlyCastableSignature; | ||
| import org.apache.doris.nereids.trees.expressions.functions.PropagateNullLiteral; | ||
| import org.apache.doris.nereids.trees.expressions.shape.UnaryExpression; | ||
| import org.apache.doris.nereids.trees.expressions.visitor.ExpressionVisitor; | ||
| import org.apache.doris.nereids.types.DoubleType; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableList; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * ScalarFunction 'gamma'. This class is generated by GenerateFunction. | ||
| * | ||
| * <p>Gamma(x) generalises the factorial to real numbers, so gamma(n) is (n - 1)! for a | ||
| * positive integer n. It has a pole at zero and at every negative integer, where this | ||
| * function returns NULL instead of the NaN that the mathematical definition would produce. | ||
| */ | ||
| public class Gamma extends ScalarFunction | ||
| implements UnaryExpression, ExplicitlyCastableSignature, AlwaysNullable, PropagateNullLiteral { | ||
|
|
||
| public static final List<FunctionSignature> SIGNATURES = ImmutableList.of( | ||
| FunctionSignature.ret(DoubleType.INSTANCE).args(DoubleType.INSTANCE) | ||
| ); | ||
|
|
||
| /** | ||
| * constructor with 1 argument. | ||
| */ | ||
| public Gamma(Expression arg) { | ||
| super("gamma", arg); | ||
| } | ||
|
|
||
| /** constructor for withChildren and reuse signature */ | ||
| private Gamma(ScalarFunctionParams functionParams) { | ||
| super(functionParams); | ||
| } | ||
|
|
||
| /** | ||
| * withChildren. | ||
| */ | ||
| @Override | ||
| public Gamma withChildren(List<Expression> children) { | ||
| Preconditions.checkArgument(children.size() == 1); | ||
| return new Gamma(getFunctionParams(children)); | ||
| } | ||
|
|
||
| @Override | ||
| public List<FunctionSignature> getSignatures() { | ||
| return SIGNATURES; | ||
| } | ||
|
|
||
| @Override | ||
| public <R, C> R accept(ExpressionVisitor<R, C> visitor, C context) { | ||
| return visitor.visitGamma(this, context); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
.../src/test/java/org/apache/doris/nereids/trees/expressions/functions/scalar/GammaTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // 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. | ||
|
|
||
| package org.apache.doris.nereids.trees.expressions.functions.scalar; | ||
|
|
||
| import org.apache.doris.catalog.FunctionSignature; | ||
| import org.apache.doris.nereids.rules.expression.ExpressionRewriteTestHelper; | ||
| import org.apache.doris.nereids.trees.expressions.Expression; | ||
| import org.apache.doris.nereids.trees.expressions.literal.DoubleLiteral; | ||
| import org.apache.doris.nereids.trees.expressions.visitor.DefaultExpressionRewriter; | ||
| import org.apache.doris.nereids.types.DoubleType; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class GammaTest extends ExpressionRewriteTestHelper { | ||
|
|
||
| @Test | ||
| public void testSignatureAndNullability() { | ||
| Gamma gamma = new Gamma(new DoubleLiteral(2.5)); | ||
|
|
||
| Assertions.assertEquals(DoubleType.INSTANCE, gamma.getDataType()); | ||
| Assertions.assertEquals(1, gamma.getSignatures().size()); | ||
| FunctionSignature signature = gamma.getSignatures().get(0); | ||
| Assertions.assertEquals(DoubleType.INSTANCE, signature.returnType); | ||
| Assertions.assertEquals(ImmutableList.of(DoubleType.INSTANCE), signature.argumentsTypes); | ||
| // gamma has poles at zero and at every negative integer, so the result stays nullable | ||
| // however non-nullable the argument is | ||
| Assertions.assertTrue(gamma.nullable()); | ||
| Assertions.assertEquals("gamma(2.5)", gamma.toSql()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testAnalyzedArgumentIsCastToDouble() { | ||
| Expression analyzed = typeCoercion(PARSER.parseExpression("gamma(5)")); | ||
|
|
||
| Assertions.assertTrue(analyzed instanceof Gamma); | ||
| Assertions.assertEquals(DoubleType.INSTANCE, analyzed.getDataType()); | ||
| Assertions.assertEquals(DoubleType.INSTANCE, analyzed.child(0).getDataType()); | ||
| Assertions.assertTrue(analyzed.nullable()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testAcceptRebuildsThroughWithChildren() { | ||
| Gamma gamma = new Gamma(new DoubleLiteral(2.5)); | ||
|
|
||
| Expression rewritten = gamma.accept(new DefaultExpressionRewriter<Void>() { | ||
| @Override | ||
| public Expression visitDoubleLiteral(DoubleLiteral doubleLiteral, Void context) { | ||
| return new DoubleLiteral(doubleLiteral.getValue() + 1.0); | ||
| } | ||
| }, null); | ||
|
|
||
| Assertions.assertEquals(new Gamma(new DoubleLiteral(3.5)), rewritten); | ||
| Assertions.assertEquals(DoubleType.INSTANCE, rewritten.getDataType()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testWithChildrenRejectsWrongArity() { | ||
| Gamma gamma = new Gamma(new DoubleLiteral(2.5)); | ||
|
|
||
| // The arity guard is the only branch in this class, so the failing direction has to be | ||
| // exercised as well: a partially covered line counts as uncovered for the increment | ||
| // coverage gate. | ||
| Assertions.assertThrows(IllegalArgumentException.class, | ||
| () -> gamma.withChildren(ImmutableList.of(new DoubleLiteral(1.0), new DoubleLiteral(2.0)))); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These exact expected values are from the FE
exp(logGamma)route, not the registered BE call. On this runnerstd::tgamma(5)is24.0,tgamma(10)is362880.0,tgamma(-1.5)is2.363271801207355,tgamma(-2.5)is-0.9453087204829419, andtgamma(171)is7.257415615307999e306, while this test expects different doubles.check_functioncomparesColumnFloat64values exactly, so the unit test (and the generated regression fixture) is platform-dependent and can fail. Please regenerate expectations from the BE implementation or use a documented tolerance/portable oracle.