Method GetBits
GetBits(int, int)
Returns a ulong which has bits copied from this array.
Declaration
public readonly ulong GetBits(int pos, int numBits = 1)
Parameters
Type | Name | Description |
---|---|---|
int | pos | Index of the first bit to get. |
int | numBits | Number of bits to get (must be between 1 and 64). |
Returns
Type | Description |
---|---|
ulong | A ulong which has bits copied from this array. |
Remarks
The source bits in this array run from index pos
up to (but not including) pos + numBits
.
No exception is thrown if pos + numBits
exceeds the length.
The first source bit is copied to the lowest bit of the ulong; the second source bit is copied to the second-lowest bit of the ulong; and so forth. Any remaining bits in the ulong will be 0.
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if pos is out of bounds or if numBits is not between 1 and 64. |