Skip to content
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

[Docs]Batch04 - Bitwise numeric functions #16805

Merged
merged 7 commits into from
Jul 30, 2024
Merged
Changes from 5 commits
Commits
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
169 changes: 145 additions & 24 deletions docs/querying/sql-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,68 +336,189 @@ Performs a bitwise XOR operation on all input values.

## BITWISE_AND

`BITWISE_AND(expr1, expr2)`
Returns the bitwise AND between two expressions, that is, `expr1 & expr2`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Returns the bitwise AND between two expressions, that is, `expr1 & expr2`.
Returns the bitwise AND between two expressions: `expr1 & expr2`.

I don't think we need the "that is" in these descriptions. Just the code following a colon is fine.

Copy link
Contributor Author

@edgar2020 edgar2020 Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

applied it manually, as well as to all other instances


**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:** `BITWISE_AND(expr1, expr2)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example performs the bitwise AND operation `12 & 10`.

```sql
SELECT BITWISE_AND(12, 10) AS "bitwise_and"
```
Returns the following:

Returns the bitwise AND between the two expressions, that is, `expr1 & expr2`.
| `bitwise_and` |
| -- |
| 8 |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_COMPLEMENT

`BITWISE_COMPLEMENT(expr)`
Returns the bitwise complement (bitwise not) for the expression, that is, `~expr`.

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:** `BITWISE_COMPLEMENT(expr)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example performs the bitwise complement operation `~12`.

```sql
SELECT BITWISE_COMPLEMENT(12) AS "bitwise_complement"
```
Returns the following:

Returns the bitwise NOT for the expression, that is, `~expr`.
| `bitwise_complement` |
| -- |
| -13 |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_CONVERT_DOUBLE_TO_LONG_BITS

`BITWISE_CONVERT_DOUBLE_TO_LONG_BITS(expr)`
Converts the bits of an IEEE 754 floating-point double value to long.

edgar2020 marked this conversation as resolved.
Show resolved Hide resolved
**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:**`BITWISE_CONVERT_DOUBLE_TO_LONG_BITS(expr)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example returns the IEEE 754 floating-point double representation of `255` as a long.

```sql
SELECT BITWISE_CONVERT_DOUBLE_TO_LONG_BITS(255) AS "ieee_754_double_to_long"
```
Returns the following:

| `ieee_754_double_to_long` |
| -- |
| `4643176031446892544` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

Converts the bits of an IEEE 754 floating-point double value to a long.

## BITWISE_CONVERT_LONG_BITS_TO_DOUBLE

`BITWISE_CONVERT_LONG_BITS_TO_DOUBLE(expr)`
Converts the bits of a long value to IEEE 754 floating-point double.

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:**`BITWISE_CONVERT_LONG_BITS_TO_DOUBLE(expr)`
* **Function type:** Scalar, numeric

Converts a long to the IEEE 754 floating-point double specified by the bits stored in the long.
<details><summary>Example</summary>

## BITWISE_OR
The following example returns the long representation of `4643176031446892544` as an IEEE 754 floating-point double.
asdf2014 marked this conversation as resolved.
Show resolved Hide resolved

`BITWISE_OR(expr1, expr2)`
```sql
SELECT BITWISE_CONVERT_LONG_BITS_TO_DOUBLE(4643176031446892544) AS "long_to_ieee_754_double"
```
Returns the following:

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
| `long_to_ieee_754_double` |
| -- |
| `255` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_OR

Returns the bitwise OR between the two expressions, that is, `expr1 | expr2`.

* **Syntax:** `BITWISE_OR(expr1, expr2)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example performs the bitwise OR operation `12 | 10`.

```sql
SELECT BITWISE_OR(12, 10) AS "bitwise_or"
```
Returns the following:

| `bitwise_or` |
| -- |
| `14` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_SHIFT_LEFT

`BITWISE_SHIFT_LEFT(expr1, expr2)`
Returns the bitwise left shift by x positions of an expr, that is, `expr << x`.

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:** `BITWISE_SHIFT_LEFT(expr, x)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example performs the bitwise SHIFT operation `2 << 3`.

edgar2020 marked this conversation as resolved.
Show resolved Hide resolved
Returns a bitwise left shift of expr1, that is, `expr1 << expr2`.
```sql
SELECT BITWISE_SHIFT_LEFT(2, 3) AS "bitwise_shift_left"
```
Returns the following:

| `bitwise_shift_left` |
| -- |
| `16` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_SHIFT_RIGHT

`BITWISE_SHIFT_RIGHT(expr1, expr2)`
Returns the bitwise right shift by x positions of an expr, that is, `expr >> x`.

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
* **Syntax:** `BITWISE_SHIFT_RIGHT(expr, x)`
* **Function type:** Scalar, numeric

Returns a bitwise right shift of expr1, that is, `expr1 >> expr2`.
<details><summary>Example</summary>

## BITWISE_XOR
The following example performs the bitwise SHIFT operation `16 >> 3`.

`BITWISE_XOR(expr1, expr2)`
```sql
SELECT BITWISE_SHIFT_RIGHT(16, 3) AS "bitwise_shift_right"
```
Returns the following:

**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions)
| `bitwise_shift_right` |
| -- |
| `2` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BITWISE_XOR

Returns the bitwise exclusive OR between the two expressions, that is, `expr1 ^ expr2`.

* **Syntax:** `BITWISE_XOR(expr1, expr2)`
* **Function type:** Scalar, numeric

<details><summary>Example</summary>

The following example performs the bitwise XOR operation `12 ^ 10`.

```sql
SELECT BITWISE_XOR(12, 10) AS "bitwise_xor"
```
Returns the following:

| `bitwise_xor` |
| -- |
| `6` |
</details>

[Learn more](sql-scalar.md#numeric-functions)

## BLOOM_FILTER

`BLOOM_FILTER(expr, <NUMERIC>)`
Expand Down
Loading