feat(frontend): Hyperbolic trigonometric functions #8918

CAJan93 · 2023-03-31T08:41:13Z

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Implement the following functions:

sinh / cosh / tanh / asinh / acosh / atanh

There is no atan2h AFAIK.

tracking issue: #8806 #9675

Checklist For Contributors

I have written necessary rustdoc comments
I have added necessary unit tests and integration tests
I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
I have demonstrated that backward compatibility is not broken by breaking changes and created issues to track deprecated features to be removed in the future. (Please refer to the issue)
All checks passed in ./risedev check (or alias, ./risedev c)

Checklist For Reviewers

I have requested macro/micro-benchmarks as this PR can affect performance substantially, and the results are shown.

Documentation

Documents are here: #9675

Types of user-facing changes

Please keep the types that apply to your changes, and remove the others.

SQL commands, functions, and operators

Release note

Implement hyperbolic trigonometric functions.

xiangjinwu

btw we can remove the leading --@ of the following tests now:

risingwave/src/tests/regress/data/sql/float8.sql

Lines 200 to 219 in 3091f16

    
           -- test Inf/NaN cases for hyperbolic functions 
        
           --@ SELECT sinh(double precision 'infinity'); 
        
           --@ SELECT sinh(double precision '-infinity'); 
        
           --@ SELECT sinh(double precision 'nan'); 
        
           --@ SELECT cosh(double precision 'infinity'); 
        
           --@ SELECT cosh(double precision '-infinity'); 
        
           --@ SELECT cosh(double precision 'nan'); 
        
           --@ SELECT tanh(double precision 'infinity'); 
        
           --@ SELECT tanh(double precision '-infinity'); 
        
           --@ SELECT tanh(double precision 'nan'); 
        
           --@ SELECT asinh(double precision 'infinity'); 
        
           --@ SELECT asinh(double precision '-infinity'); 
        
           --@ SELECT asinh(double precision 'nan'); 
        
           -- acosh(Inf) should be Inf, but some mingw versions produce NaN, so skip test 
        
           -- SELECT acosh(double precision 'infinity'); 
        
           --@ SELECT acosh(double precision '-infinity'); 
        
           --@ SELECT acosh(double precision 'nan'); 
        
           --@ SELECT atanh(double precision 'infinity'); 
        
           --@ SELECT atanh(double precision '-infinity'); 
        
           --@ SELECT atanh(double precision 'nan');

xiangjinwu · 2023-04-06T04:04:10Z

proto/expr.proto

+    SINH = 261;
+    COSH = 262;
+    TANH = 263;
+    COTH = 264;


No coth either
https://www.postgresql.org/docs/current/functions-math.html#FUNCTIONS-MATH-HYP-TABLE

xiangjinwu · 2023-04-06T04:21:52Z

e2e_test/batch/functions/trigonometric_funcs.slt.part

 t

+query R
+SELECT abs(sinh(1) - 1.1752011936438014) < 0.000000000000001


Equality of imprecise float is inherently hard 😢 FYI postgres regress test only test for 15 significant decimal digits for double precision, using the extra_float_digits config we do not support yet.

risingwave/src/tests/regress/data/expected/float8.out

Lines 640 to 647 in 3091f16

-- hyperbolic functions

-- we run these with extra_float_digits = 0 too, since different platforms

-- tend to produce results that vary in the last place.

SELECT sinh(double precision '1');

sinh

-----------------

1.1752011936438

(1 row)

But we can manually adjust the precision requirement here, and we have no intention to do better than rust builtin f64::sinh...

What about

SELECT abs(sinh(1) - 1.17520119364380) < 1e-15; -- or even 1e-14 if the ci machine is less capable

btw it is also a bit clearer to use the 1e-15 syntax rather than counting the zeros.

…o trig_h_funcs

CAJan93 · 2023-05-10T13:32:47Z

Sorry for not coming back to this earlier. I updated the PR according to your suggestions. Thank you very much for your comments @xiangjinwu.

codecov · 2023-05-10T13:59:06Z

Codecov Report

Merging #8918 (9bd5a5d) into main (9de9d69) will increase coverage by 0.00%.
The diff coverage is 93.58%.

@@           Coverage Diff           @@
##             main    #8918   +/-   ##
=======================================
  Coverage   71.12%   71.12%           
=======================================
  Files        1250     1250           
  Lines      209294   209371   +77     
=======================================
+ Hits       148850   148924   +74     
- Misses      60444    60447    +3

Flag	Coverage Δ
rust	`71.12% <93.58%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/frontend/src/expr/pure.rs	`95.00% <ø> (ø)`
src/expr/src/vector_op/trigonometric.rs	`96.35% <92.95%> (-0.62%)`	⬇️
src/frontend/src/binder/expr/function.rs	`88.26% <100.00%> (+0.12%)`	⬆️

... and 7 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

xiangjinwu

As mentioned in earlier comments, could you turn on the applicable regress tests?

xiangjinwu · 2023-05-11T01:12:24Z

proto/expr.proto

+    SINH = 253;
+    COSH = 254;
+    TANH = 255;
+    COTH = 256;
+    ASINH = 257;
+    ACOSH = 258;
+    ATANH = 259;


FYI it would not be backward compatible when we change the mapping of an existing enum value.

…o trig_h_funcs

src/tests/regress/data/sql/float8.sql

…o trig_h_funcs

CAJan93 added 3 commits March 31, 2023 09:19

add hyperbolic functions

a58a202

implement unit-tests

b0c3f8a

add sqllogictests

a45a3b7

github-actions bot added the type/feature Type: New feature. label Mar 31, 2023

remove comment

26da005

neverchanje requested review from st1page and xiangjinwu April 6, 2023 03:15

xiangjinwu reviewed Apr 6, 2023

View reviewed changes

neverchanje added the user-facing-changes Contains changes that are visible to users label May 9, 2023

neverchanje linked an issue May 9, 2023 that may be closed by this pull request

Implement functions: sinh / cosh / tanh / asinh / acosh / atanh #9675

Closed

CAJan93 closed this May 9, 2023

CAJan93 reopened this May 9, 2023

CAJan93 added 6 commits May 10, 2023 11:59

merge main trigonometric_funcs.slt.part

7fffbfc

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

75537e6

…o trig_h_funcs

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

f876b80

…o trig_h_funcs

change precision

e42b091

fix tests

09eae89

risedev c

d607891

xiangjinwu reviewed May 11, 2023

View reviewed changes

neverchanje requested a review from xxchan May 11, 2023 03:34

CAJan93 added 4 commits May 11, 2023 10:30

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

a19f311

…o trig_h_funcs

turn on regress test

7c2bc57

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

01f2e7a

…o trig_h_funcs

change oder in expr.proto

fd131cd

xiangjinwu reviewed May 11, 2023

View reviewed changes

src/tests/regress/data/sql/float8.sql Show resolved Hide resolved

CAJan93 added 3 commits May 12, 2023 07:16

change file

9272998

change tests

72f4bea

change float8 test

89bd477

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

0e40efd

…o trig_h_funcs

xiangjinwu approved these changes May 12, 2023

View reviewed changes

CAJan93 requested a review from xiangjinwu May 12, 2023 08:41

xiangjinwu approved these changes May 12, 2023

View reviewed changes

xiangjinwu mentioned this pull request May 12, 2023

feat(frontend): Asind function #9741

Merged

7 tasks

CAJan93 enabled auto-merge May 12, 2023 09:45

CAJan93 disabled auto-merge May 12, 2023 09:47

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

6a4bd7a

…o trig_h_funcs

CAJan93 enabled auto-merge May 12, 2023 09:54

CAJan93 added 2 commits May 18, 2023 11:56

Merge branch 'main' of ssh://github.com/risingwavelabs/risingwave int…

cf5d8d9

…o trig_h_funcs

remove empty line

9bd5a5d

CAJan93 added this pull request to the merge queue May 18, 2023

Merged via the queue into main with commit ed2b900 May 18, 2023

CAJan93 deleted the trig_h_funcs branch May 18, 2023 11:47

CharlieSYH mentioned this pull request May 29, 2023

Document trigonometric functions risingwavelabs/risingwave-docs-legacy#854

Closed

CharlieSYH added the 📖✓ Covered or will be covered in the user docs. label May 29, 2023

bernscode mentioned this pull request May 30, 2023

Add trigonometric functions risingwavelabs/risingwave-docs-legacy#935

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(frontend): Hyperbolic trigonometric functions #8918

feat(frontend): Hyperbolic trigonometric functions #8918

Uh oh!

CAJan93 commented Mar 31, 2023 •

edited

Loading

Uh oh!

xiangjinwu left a comment

Uh oh!

xiangjinwu Apr 6, 2023

Uh oh!

xiangjinwu Apr 6, 2023

Uh oh!

CAJan93 commented May 10, 2023

Uh oh!

codecov bot commented May 10, 2023 •

edited

Loading

Uh oh!

xiangjinwu left a comment

Uh oh!

xiangjinwu May 11, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	-- test Inf/NaN cases for hyperbolic functions
	--@ SELECT sinh(double precision 'infinity');
	--@ SELECT sinh(double precision '-infinity');
	--@ SELECT sinh(double precision 'nan');
	--@ SELECT cosh(double precision 'infinity');
	--@ SELECT cosh(double precision '-infinity');
	--@ SELECT cosh(double precision 'nan');
	--@ SELECT tanh(double precision 'infinity');
	--@ SELECT tanh(double precision '-infinity');
	--@ SELECT tanh(double precision 'nan');
	--@ SELECT asinh(double precision 'infinity');
	--@ SELECT asinh(double precision '-infinity');
	--@ SELECT asinh(double precision 'nan');
	-- acosh(Inf) should be Inf, but some mingw versions produce NaN, so skip test
	-- SELECT acosh(double precision 'infinity');
	--@ SELECT acosh(double precision '-infinity');
	--@ SELECT acosh(double precision 'nan');
	--@ SELECT atanh(double precision 'infinity');
	--@ SELECT atanh(double precision '-infinity');
	--@ SELECT atanh(double precision 'nan');

	-- hyperbolic functions
	-- we run these with extra_float_digits = 0 too, since different platforms
	-- tend to produce results that vary in the last place.
	SELECT sinh(double precision '1');
	sinh
	-----------------
	1.1752011936438
	(1 row)

feat(frontend): Hyperbolic trigonometric functions #8918

feat(frontend): Hyperbolic trigonometric functions #8918

Uh oh!

Conversation

CAJan93 commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's changed and what's your intention?

Checklist For Contributors

Checklist For Reviewers

Documentation

Types of user-facing changes

Release note

Uh oh!

xiangjinwu left a comment

Choose a reason for hiding this comment

Uh oh!

xiangjinwu Apr 6, 2023

Choose a reason for hiding this comment

Uh oh!

xiangjinwu Apr 6, 2023

Choose a reason for hiding this comment

Uh oh!

CAJan93 commented May 10, 2023

Uh oh!

codecov bot commented May 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

xiangjinwu left a comment

Choose a reason for hiding this comment

Uh oh!

xiangjinwu May 11, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CAJan93 commented Mar 31, 2023 •

edited

Loading

codecov bot commented May 10, 2023 •

edited

Loading