Bit class

Encapsulates a single (unsigned) bit, i.e. either 0 or 1.

Inheritance
Annotations
  • @sealed

Constructors

Bit(int value)
Wraps a value of either 0 or 1.
factory

Properties

bitsSet int
Returns the number of set bits in value.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isNegative bool
Returns true iff value represents a negative number, else false.
no setterinherited
isPositive bool
Returns true iff value represents a positive number, else false.
no setterinherited
msb bool
Returns whether the most-significant-bit in value is set.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
size int
Numbers of bits in this data type.
finalinherited
value int
Value wrapped by the Integral.
finalinherited

Methods

bitChunk(int left, int size) Bit
Returns a new instance with bits in left to size.
inherited
bitRange(int left, int right) Bit
Returns a new instance with bits left to right, inclusive.
inherited
clearBit(int n) Bit
Returns with the nth bit from value cleared.
inherited
compareTo(Integral<Integral> o) int
Compares this object to another object.
inherited
getBit(int n) int
Returns the nth bit from value.
inherited
isClear(int n) bool
Returns whether the nth bit from value is cleared.
inherited
isSet(int n) bool
Returns whether the nth bit from value is set.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
replaceBitRange(int left, int right, int bits) Bit
Returns a new instance with bits left to right, inclusive, replaced.
inherited
rotateRightShift(int number) Bit
Returns a bit-wise right rotation on value by number of bits.
inherited
setBit(int n) Bit
Returns with the nth bit from value set.
inherited
signedRightShift(int n) Bit
Returns value arithmetically right-shifted n bits.
inherited
signExtend(int startSize) Bit
Returns the current value BinaryInt.signExtend-ed to the full size.
inherited
toBinary() String
Returns value as a binary string representation.
inherited
toBinaryPadded() String
Returns value as a binary string representation, padded with 0's.
inherited
toDebugString() String
Returns a debug-friendly representation of toString.
override
toggleBit(int n, [bool? v]) Bit
Sets the nth bit if v is true, otherwise clears.
inherited
toString() String
A string representation of this object.
inherited
wrapSafeValue(int value) Bit
Implement to create an instance of self around value.
override

Operators

operator &(Bit other) Bit
Bitwise AND operator.
inherited
operator <(Bit other) bool
Less than comparison.
inherited
operator <<(Bit other) Bit
Left-shift operator.
inherited
operator <=(Bit other) bool
Less than or equal comparison.
inherited
operator ==(Object other) bool
The equality operator.
inherited
operator >(Bit other) bool
Greater than comparison.
inherited
operator >=(Bit other) bool
Greater than or equal comparison.
inherited
operator >>(Bit other) Bit
Right-shift operator.
inherited
operator ^(Bit other) Bit
Bitwise XOR operator.
inherited
operator |(Bit other) Bit
Bitwise OR operator.
inherited
operator ~() Bit
Bitwise NOT operator.
inherited

Static Methods

assertRange(int value) int
Returns value.
checkRange(int value) int
Returns value if in range, otherwise throws RangeError.

Constants

one → const Bit
A pre-computed instance of Bit(1).
zero → const Bit
A pre-computed instance of Bit(0).