Class BitwiseHandler

Provides bitwise operation functions for use in HotMesh mapping rules. Although inspired by JavaScript, they have been adapted to follow a functional approach. Each transformation is a function that expects one or more input parameters from the prior row in the @pipe structure.

Remarks

Invoked in mapping rules using {@bitwise.<method>} syntax.

Index

Constructors

constructor

Methods

and leftShift or rightShift unsignedRightShift xor

Constructors

constructor

new BitwiseHandler(): BitwiseHandler
Returns BitwiseHandler

Methods

and

and(a, b): number
Performs a bitwise AND operation on two numbers.
Parameters
- a: number
  The first operand
- b: number
  The second operand
Returns number
The result of a & b
Example
```
bitwise_and_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.b}"]
    - ["{@bitwise.and}"]
```
- Defined in services/pipe/functions/bitwise.ts:25

leftShift

leftShift(a, b): number
Performs a bitwise left shift operation on a number.
Parameters
- a: number
  The number to shift
- b: number
  The number of positions to shift left
Returns number
The result of a << b
Example
```
bitwise_left_shift_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.shift}"]
    - ["{@bitwise.leftShift}"]
```
- Defined in services/pipe/functions/bitwise.ts:79

or

or(a, b): number
Performs a bitwise OR operation on two numbers.
Parameters
- a: number
  The first operand
- b: number
  The second operand
Returns number
The result of a | b
Example
```
bitwise_or_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.b}"]
    - ["{@bitwise.or}"]
```
- Defined in services/pipe/functions/bitwise.ts:43

rightShift

rightShift(a, b): number
Performs a bitwise right shift operation on a number, preserving the sign bit.
Parameters
- a: number
  The number to shift
- b: number
  The number of positions to shift right
Returns number
The result of a >> b
Example
```
bitwise_right_shift_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.shift}"]
    - ["{@bitwise.rightShift}"]
```
- Defined in services/pipe/functions/bitwise.ts:98

unsignedRightShift

unsignedRightShift(a, b): number
Performs a bitwise unsigned right shift operation on a number.
Parameters
- a: number
  The number to shift
- b: number
  The number of positions to shift right
Returns number
The result of a >>> b
Example
```
bitwise_unsigned_right_shift_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.shift}"]
    - ["{@bitwise.unsignedRightShift}"]
```
- Defined in services/pipe/functions/bitwise.ts:116

xor

xor(a, b): number
Performs a bitwise XOR operation on two numbers.
Parameters
- a: number
  The first operand
- b: number
  The second operand
Returns number
The result of a ^ b
Example
```
bitwise_xor_result:
  "@pipe":
    - ["{a.numbers.a}", "{a.numbers.b}"]
    - ["{@bitwise.xor}"]
```
- Defined in services/pipe/functions/bitwise.ts:61

Class BitwiseHandler

Remarks

Index

Constructors

Methods

Constructors

constructor

Returns BitwiseHandler

Methods

and

Parameters

Returns number

Example

leftShift

Parameters

Returns number

Example

or

Parameters

Returns number

Example

rightShift

Parameters

Returns number

Example

unsignedRightShift

Parameters

Returns number

Example

xor

Parameters

Returns number

Example

Settings

On This Page