Skip to content

Add cbrt function to the PPL #1097

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.

Sign up for GitHub

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

Merged
Yury-Fridlyand merged 3 commits into from
Nov 28, 2022
Merged

Add cbrt function to the PPL #1097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d363f60
Add cbrt function to the PPL (#171)
margarit-h Nov 23, 2022
b60195c
Address PR review feedback
margarit-h Nov 24, 2022
77de5e5
Address PR review comments
margarit-h Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/user/dql/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,7 @@ Argument type: INTEGER/LONG/FLOAT/DOUBLE

Return type: DOUBLE

(Non-negative) INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE
(Negative) INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE
INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE

Example::

Expand Down
24 changes: 24 additions & 0 deletions docs/user/ppl/functions/math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,3 +662,27 @@ Example::
| 2.0 | 2.1 |
+-----------+--------------+

CBRT
----

Description
>>>>>>>>>>>

Usage: Calculates the cube root of a number

Argument type: INTEGER/LONG/FLOAT/DOUBLE

Return type DOUBLE:

INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE

Example::

opensearchsql> source=location | eval `CBRT(8)` = CBRT(8), `CBRT(9.261)` = CBRT(9.261), `CBRT(-27)` = CBRT(-27) | fields `CBRT(8)`, `CBRT(9.261)`, `CBRT(-27)`;
fetched rows / total rows = 2/2
+-----------+---------------+-------------+
| CBRT(8) | CBRT(9.261) | CBRT(-27) |
|-----------+---------------+-------------|
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
+-----------+---------------+-------------+
18 changes: 18 additions & 0 deletions integ-test/src/test/java/org/opensearch/sql/ppl/MathematicalFunctionIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package org.opensearch.sql.ppl;

import static org.opensearch.sql.legacy.TestsConstants.TEST_INDEX_BANK;
import static org.opensearch.sql.legacy.TestsConstants.TEST_INDEX_CALCS;
import static org.opensearch.sql.util.MatcherUtils.closeTo;
import static org.opensearch.sql.util.MatcherUtils.rows;
import static org.opensearch.sql.util.MatcherUtils.schema;
Expand All @@ -24,6 +25,7 @@ public class MathematicalFunctionIT extends PPLIntegTestCase {
public void init() throws IOException {
loadIndex(Index.BANK);
loadIndex(Index.BANK_WITH_NULL_VALUES);
loadIndex(Index.CALCS);
}

@Test
Expand Down Expand Up @@ -262,6 +264,22 @@ public void testSqrt() throws IOException {
rows(5.830951894845301));
}

@Test
public void testCbrt() throws IOException {
JSONObject result =
executeQuery(
String.format(
"source=%s | eval f = cbrt(num3) | fields f", TEST_INDEX_CALCS));
verifySchema(result, schema("f", null, "double"));
verifyDataRows(result,
closeTo(Math.cbrt(-11.52)), closeTo(Math.cbrt(-9.31)), closeTo(Math.cbrt(-12.17)),
closeTo(Math.cbrt(-7.25)), closeTo(Math.cbrt(12.93)), closeTo(Math.cbrt(-19.96)),
closeTo(Math.cbrt(10.93)), closeTo(Math.cbrt(3.64)), closeTo(Math.cbrt(-13.38)),
closeTo(Math.cbrt(-10.56)), closeTo(Math.cbrt(-4.79)), closeTo(Math.cbrt(-10.81)),
closeTo(Math.cbrt(-6.62)), closeTo(Math.cbrt(-18.43)), closeTo(Math.cbrt(6.84)),
closeTo(Math.cbrt(-10.98)), closeTo(Math.cbrt(-2.6)));
}

@Test
public void testTruncate() throws IOException {
JSONObject result =
Expand Down
1 change: 1 addition & 0 deletions ppl/src/main/antlr/OpenSearchPPLLexer.g4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ DC: 'DC';

// BASIC FUNCTIONS
ABS: 'ABS';
CBRT: 'CBRT';
CEIL: 'CEIL';
CEILING: 'CEILING';
CONV: 'CONV';
Expand Down
2 changes: 1 addition & 1 deletion ppl/src/main/antlr/OpenSearchPPLParser.g4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ relevanceArgValue
;

mathematicalFunctionBase
: ABS | CEIL | CEILING | CONV | CRC32 | E | EXP | FLOOR | LN | LOG | LOG10 | LOG2 | MOD | PI |POW | POWER
: ABS | CBRT | CEIL | CEILING | CONV | CRC32 | E | EXP | FLOOR | LN | LOG | LOG10 | LOG2 | MOD | PI |POW | POWER
| RAND | ROUND | SIGN | SQRT | TRUNCATE
| trigonometricFunctionName
;
Expand Down