docs-v2/content/flux/v0/stdlib/bitwise/sxor.md

131 lines
3.2 KiB
Markdown

---
title: bitwise.sxor() function
description: >
`bitwise.sxor()` performs the bitwise operation, `a XOR b`, with integers.
menu:
flux_v0_ref:
name: bitwise.sxor
parent: bitwise
identifier: bitwise/sxor
weight: 101
---
<!------------------------------------------------------------------------------
IMPORTANT: This page was generated from comments in the Flux source code. Any
edits made directly to this page will be overwritten the next time the
documentation is generated.
To make updates to this documentation, update the function comments above the
function definition in the Flux source code:
https://github.com/influxdata/flux/blob/master/stdlib/bitwise/bitwise.flux#L310-L310
Contributing to Flux: https://github.com/influxdata/flux#contributing
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
------------------------------------------------------------------------------->
`bitwise.sxor()` performs the bitwise operation, `a XOR b`, with integers.
##### Function type signature
```js
(a: int, b: int) => int
```
{{% caption %}}
For more information, see [Function type signatures](/flux/v0/function-type-signatures/).
{{% /caption %}}
## Parameters
### a
({{< req >}})
Left hand operand.
### b
({{< req >}})
Right hand operand.
## Examples
- [Perform a bitwise XOR operation](#perform-a-bitwise-xor-operation)
- [Perform a bitwise XOR operation on a stream of tables](#perform-a-bitwise-xor-operation-on-a-stream-of-tables)
### Perform a bitwise XOR operation
```js
import "bitwise"
bitwise.sxor(a: 1234, b: 4567)// Returns 5381
```
### Perform a bitwise XOR operation on a stream of tables
```js
import "bitwise"
import "sampledata"
sampledata.int()
|> map(fn: (r) => ({r with _value: bitwise.sxor(a: r._value, b: 3)}))
```
{{< expand-wrapper >}}
{{% expand "View example input and output" %}}
#### Input data
| _time | _value | *tag |
| -------------------- | ------- | ---- |
| 2021-01-01T00:00:00Z | -2 | t1 |
| 2021-01-01T00:00:10Z | 10 | t1 |
| 2021-01-01T00:00:20Z | 7 | t1 |
| 2021-01-01T00:00:30Z | 17 | t1 |
| 2021-01-01T00:00:40Z | 15 | t1 |
| 2021-01-01T00:00:50Z | 4 | t1 |
| _time | _value | *tag |
| -------------------- | ------- | ---- |
| 2021-01-01T00:00:00Z | 19 | t2 |
| 2021-01-01T00:00:10Z | 4 | t2 |
| 2021-01-01T00:00:20Z | -3 | t2 |
| 2021-01-01T00:00:30Z | 19 | t2 |
| 2021-01-01T00:00:40Z | 13 | t2 |
| 2021-01-01T00:00:50Z | 1 | t2 |
#### Output data
| _time | _value | *tag |
| -------------------- | ------- | ---- |
| 2021-01-01T00:00:00Z | -3 | t1 |
| 2021-01-01T00:00:10Z | 9 | t1 |
| 2021-01-01T00:00:20Z | 4 | t1 |
| 2021-01-01T00:00:30Z | 18 | t1 |
| 2021-01-01T00:00:40Z | 12 | t1 |
| 2021-01-01T00:00:50Z | 7 | t1 |
| _time | _value | *tag |
| -------------------- | ------- | ---- |
| 2021-01-01T00:00:00Z | 16 | t2 |
| 2021-01-01T00:00:10Z | 7 | t2 |
| 2021-01-01T00:00:20Z | -2 | t2 |
| 2021-01-01T00:00:30Z | 16 | t2 |
| 2021-01-01T00:00:40Z | 14 | t2 |
| 2021-01-01T00:00:50Z | 2 | t2 |
{{% /expand %}}
{{< /expand-wrapper >}}