Interface Combinator<T>

An abstract interface over a set of primitive bitwise operations for a given numeric type T.

interface Combinator<T extends Bit> {
    zero: T;
    and(a: T, b: T): T;
    andNot(a: T, b: T): T;
    not(a: T): T;
    or(a: T, b: T): T;
    popcount(a: T): number;
    shiftL(value: T, shift: number): T;
    xor(a: T, b: T): T;
}

Type Parameters

T extends Bit
The numeric type over which bitwise operations are performed. Must be either number or bigint (i.e. Bit).

Implemented by

Index

Properties

Methods

and andNot not or popcount shiftL xor

Properties

`Readonly`zero

zero: T

The identity element for or — a value with no bits set (0 or 0n).

Methods

and

and(a: T, b: T): T
Returns the bitwise AND of a and b.
Parameters
- a: T
  First operand.
- b: T
  Second operand.
Returns T
a & b.
- Defined in core/combinator/types/Combinator.interface.ts:40

andNot

andNot(a: T, b: T): T
Returns the bitwise AND of a and ~b. Same as combinator.and(a, combinator.not(b))
Parameters
- a: T
  First operand.
- b: T
  Second operand.
Returns T
a & ~b
- Defined in core/combinator/types/Combinator.interface.ts:50

not

not(a: T): T
Returns the bitwise NOT of a (one's complement inversion).
Parameters
- a: T
  Value to invert.
Returns T
~a.
- Defined in core/combinator/types/Combinator.interface.ts:67

or

or(a: T, b: T): T
Returns the bitwise OR of a and b.
Parameters
- a: T
  First operand.
- b: T
  Second operand.
Returns T
a | b.
- Defined in core/combinator/types/Combinator.interface.ts:31

popcount

popcount(a: T): number
Counts the number of bits set to 1 in a (population count).
Parameters
- a: T
  Value whose set bits are counted.
Returns number
The number of 1 bits in a.
- Defined in core/combinator/types/Combinator.interface.ts:22

shiftL

shiftL(value: T, shift: number): T
Shifts value left by shift bit positions.
Parameters
- value: T
  Value to shift.
- shift: number
  Number of positions to shift left.
Returns T
value << shift.
- Defined in core/combinator/types/Combinator.interface.ts:76

xor

xor(a: T, b: T): T
Returns the bitwise XOR of a and b.
Parameters
- a: T
  First operand.
- b: T
  Second operand.
Returns T
a ^ b.
- Defined in core/combinator/types/Combinator.interface.ts:59