BitVector

Companion object BitVector

sealed abstract class BitVector extends BitwiseOperations[BitVector, Long] with Ordered[BitVector] with Serializable

Persistent vector of bits, stored as bytes.

Bits are numbered left to right, starting at 0.

Source: BitVector.scala

Linear Supertypes

Serializable, Ordered[BitVector], Comparable[BitVector], BitwiseOperations[BitVector, Long], AnyRef, Any

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

BitVector
Serializable
Ordered
Comparable
BitwiseOperations
AnyRef
Any

Implicitly

by GroupedOp
by orderingToOrdered
by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def align: Bytes
Produce a single flat Bytes by interpreting any non-byte-aligned appends or drops.
Produce a single flat Bytes by interpreting any non-byte-aligned appends or drops. Unlike compact, the underlying ByteVector is not necessarily copied.
abstract def drop(n: Long): BitVector
Returns a vector of all bits in this vector except the first n bits.
Returns a vector of all bits in this vector except the first n bits.
The resulting vector's size is 0 max (size - n).
abstract def get(n: Long): Boolean
Returns true if the nth bit is high, false otherwise.
Returns true if the nth bit is high, false otherwise.
Exceptions thrown
NoSuchElementException if n >= size
abstract def getByte(n: Long): Byte
Returns the nth byte, 0-indexed.
Returns the nth byte, 0-indexed.
Exceptions thrown
NoSuchElementException if n >= bytes.size
abstract def size: Long
Returns number of bits in this vector.
abstract def sizeLessThan(n: Long): Boolean
Returns true if the size of this BitVector is less than n.
Returns true if the size of this BitVector is less than n. Unlike size, this forces this BitVector from left to right, halting as soon as it has a definite answer.
abstract def take(n: Long): BitVector
Returns a vector of the first n bits of this vector.
Returns a vector of the first n bits of this vector.
The resulting vector's size is n min size.
Note: if an n-bit vector is required, use the acquire method instead.
See also
acquire
abstract def update(n: Long, high: Boolean): BitVector
Returns a new bit vector with the nth bit high if high is true or low if high is false.

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def &(other: BitVector): BitVector
Returns a bitwise AND of this value with the specified value.
Returns a bitwise AND of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
def +(other: String): String
Implicit
This member is added by an implicit conversion from BitVector toany2stringadd[BitVector] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ++(b2: BitVector): BitVector
Returns a new bit vector representing this vector's contents followed by the specified vector's contents.
final def +:(b: Boolean): BitVector
Returns a new vector with the specified bit prepended.
def ->[B](y: B): (BitVector, B)
Implicit
This member is added by an implicit conversion from BitVector toArrowAssoc[BitVector] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def :+(b: Boolean): BitVector
Returns a new vector with the specified bit appended.
def <(that: BitVector): Boolean
Definition Classes
Ordered
final def <<(n: Long): BitVector
Returns a value of the same size with each bit shifted to the left n bits.
Returns a value of the same size with each bit shifted to the left n bits.
Definition Classes
BitwiseOperations
def <=(that: BitVector): Boolean
Definition Classes
Ordered
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ===(other: BitVector): Boolean
Returns true if the specified BitVector has the same contents as this vector.
def >(that: BitVector): Boolean
Definition Classes
Ordered
def >=(that: BitVector): Boolean
Definition Classes
Ordered
final def >>(n: Long): BitVector
Returns a value of the same size with each bit shifted to the right n bits where the n left-most bits are sign extended.
Returns a value of the same size with each bit shifted to the right n bits where the n left-most bits are sign extended.
Definition Classes
BitwiseOperations
final def >>>(n: Long): BitVector
Returns a value of the same size with each bit shifted to the right n bits where the n left-most bits are low.
Returns a value of the same size with each bit shifted to the right n bits where the n left-most bits are low.
Definition Classes
BitwiseOperations
final def ^(other: BitVector): BitVector
Returns a bitwise XOR of this value with the specified value.
Returns a bitwise XOR of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
def acquire(n: Long): Either[String, BitVector]
Returns a vector whose contents are the results of taking the first n bits of this vector.
Returns a vector whose contents are the results of taking the first n bits of this vector.
If this vector does not contain at least n bits, an error message is returned.
See also
take
final def acquireThen[R](n: Long)(err: (String) => R, f: (BitVector) => R): R
Like aquire, but immediately consumes the Either via the pair of functions err and f.
Like aquire, but immediately consumes the Either via the pair of functions err and f.
See also
acquire
final def and(other: BitVector): BitVector
Returns a bitwise AND of this bit vector with the specified bit vector.
Returns a bitwise AND of this bit vector with the specified bit vector.
The resulting bit vector's size is the minimum of this bit vector's size and the specified bit vector's size.
Definition Classes
BitVector → BitwiseOperations
final def apply(n: Long): Boolean
Alias for get.
Alias for get.
See also
get(Long)
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def bytes: ByteVector
Alias for toByteVector.
final def checkBounds(n: Long): Unit
Attributes
protected
final def clear(n: Long): BitVector
Returns a new bit vector with the nth bit low (and all other bits unmodified).
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def compact: Bytes
Return a BitVector with the same contents as this, but based off a single ByteVector.
Return a BitVector with the same contents as this, but based off a single ByteVector.
This may involve copying data to a fresh ByteVector, but has the advantage that lookups index directly into a single ByteVector rather than traversing a logarithmic number of nodes in this tree.
Calling this method on an already compacted vector is a no-op.
def compare(that: BitVector): Int
Definition Classes
BitVector → Ordered
def compareTo(that: BitVector): Int
Definition Classes
Ordered → Comparable
final def consume[A](n: Long)(decode: (BitVector) => Either[String, A]): Either[String, (BitVector, A)]
Consumes the first n bits of this vector and decodes them with the specified function, resulting in a vector of the remaining bits and the decoded value.
Consumes the first n bits of this vector and decodes them with the specified function, resulting in a vector of the remaining bits and the decoded value. If this vector does not have n bits or an error occurs while decoding, an error is returned instead.
final def consumeThen[R](n: Long)(err: (String) => R, f: (BitVector, BitVector) => R): R
If this vector has at least n bits, returns f(take(n),drop(n)), otherwise calls err with a meaningful error message.
If this vector has at least n bits, returns f(take(n),drop(n)), otherwise calls err with a meaningful error message. This function can be used to avoid intermediate allocations of Either objects when using acquire or consume directly.
See also
acquireThen
final def containsSlice(slice: BitVector): Boolean
Determines if the specified slice is in this vector.
final def copy: Bytes
Return a BitVector with the same contents as this, but based off a single flat ByteVector.
Return a BitVector with the same contents as this, but based off a single flat ByteVector. This function is guaranteed to copy all the bytes in this BitVector, unlike compact, which may no-op if this BitVector already consists of a single ByteVector chunk.
final def decodeAscii: Either[CharacterCodingException, String]
Decodes this vector as a string using the US-ASCII charset.
final def decodeString(implicit charset: Charset): Either[CharacterCodingException, String]
Decodes this vector as a string using the implicitly available charset.
final def decodeUtf8: Either[CharacterCodingException, String]
Decodes this vector as a string using the UTF-8 charset.
final def decrypt(ci: Cipher, key: Key, aparams: Option[AlgorithmParameters] = None)(implicit sr: SecureRandom): Either[GeneralSecurityException, BitVector]
Decrypts this bit vector using the specified cipher and key.
Decrypts this bit vector using the specified cipher and key.
The last byte is zero padded if the size is not evenly divisible by 8.
ci
cipher to use for decryption
key
key to decrypt with
aparams
optional algorithm paramaters used for decryption (e.g., initialization vector)
sr
secure random
final def deflate(level: Int = Deflater.DEFAULT_COMPRESSION, strategy: Int = Deflater.DEFAULT_STRATEGY, nowrap: Boolean = false, chunkSize: Int = 4096): BitVector
Compresses this vector using ZLIB.
Compresses this vector using ZLIB.
The last byte is zero padded if the size is not evenly divisible by 8.
level
compression level, 0-9, with 0 disabling compression and 9 being highest level of compression -- see java.util.zip.Deflater for details
strategy
compression strategy -- see java.util.zip.Deflater for details
nowrap
if true, ZLIB header and checksum will not be used
chunkSize
buffer size, in bytes, to use when compressing
final def digest(digest: MessageDigest): BitVector
Computes a digest of this bit vector.
Computes a digest of this bit vector.
Exceptions thrown from the underlying JCA API are propagated.
The last byte is zero padded if the size is not evenly divisible by 8.
digest
digest to use
final def digest(algorithm: String): BitVector
Computes a digest of this bit vector.
Computes a digest of this bit vector.
Exceptions thrown from the underlying JCA API are propagated.
The last byte is zero padded if the size is not evenly divisible by 8.
algorithm
digest algorithm to use
final def dropRight(n: Long): BitVector
Returns a vector of all bits in this vector except the last n bits.
Returns a vector of all bits in this vector except the last n bits.
The resulting vector's size is 0 max (size - n).
final def encrypt(ci: Cipher, key: Key, aparams: Option[AlgorithmParameters] = None)(implicit sr: SecureRandom): Either[GeneralSecurityException, BitVector]
Encrypts this bit vector using the specified cipher and key.
Encrypts this bit vector using the specified cipher and key.
The last byte is zero padded if the size is not evenly divisible by 8.
ci
cipher to use for encryption
key
key to encrypt with
aparams
optional algorithm paramaters used for encryption (e.g., initialization vector)
sr
secure random
final def endsWith(b: BitVector): Boolean
Returns true if this bit vector ends with the specified vector.
def ensuring(cond: (BitVector) => Boolean, msg: => Any): BitVector
Implicit
This member is added by an implicit conversion from BitVector toEnsuring[BitVector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (BitVector) => Boolean): BitVector
Implicit
This member is added by an implicit conversion from BitVector toEnsuring[BitVector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): BitVector
Implicit
This member is added by an implicit conversion from BitVector toEnsuring[BitVector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): BitVector
Implicit
This member is added by an implicit conversion from BitVector toEnsuring[BitVector] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def equals(other: Any): Boolean
Returns true if the specified value is a BitVector with the same contents as this vector.
Returns true if the specified value is a BitVector with the same contents as this vector.
Definition Classes
BitVector → AnyRef → Any
See also
BitVector.===
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def force: BitVector
Forces any Suspend nodes in this BitVector and ensures the tree is balanced.
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from BitVector toStringFormat[BitVector] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
final def grouped(n: Long): Iterator[BitVector]
Converts this vector in to a sequence of n-bit vectors.
Converts this vector in to a sequence of n-bit vectors.
Implicit
This member is added by an implicit conversion from BitVector toGroupedOp performed by method GroupedOp in scodec.bits.BitVector.
Definition Classes
GroupedOp
final lazy val hashCode: Int
Calculates the hash code of this vector.
Calculates the hash code of this vector. The result is cached.
final def head: Boolean
Returns the first bit of this vector or throws if vector is emtpy.
final def headOption: Option[Boolean]
Returns the first bit of this vector or None if vector is emtpy.
def iff(other: BitVector): BitVector
Returns a bitwise if-and-only-if of this value with the specified value.
Returns a bitwise if-and-only-if of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
def implies(other: BitVector): BitVector
Returns a bitwise implication of this value with the specified value.
Returns a bitwise implication of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
final def indexOfSlice(slice: BitVector, from: Long): Long
Finds the first index after from of the specified bit pattern in this vector.
Finds the first index after from of the specified bit pattern in this vector.
returns
index of slice or -1 if not found
final def indexOfSlice(slice: BitVector): Long
Finds the first index of the specified bit pattern in this vector.
Finds the first index of the specified bit pattern in this vector.
returns
index of slice or -1 if not found
final def inflate(chunkSize: Int = 4096): Either[DataFormatException, BitVector]
Decompresses this vector using ZLIB.
Decompresses this vector using ZLIB.
The last byte is zero padded if the size is not evenly divisible by 8.
chunkSize
buffer size, in bytes, to use when compressing
final def init: BitVector
Returns a vector of all bits in this vector except the last bit.
final def insert(idx: Long, b: Boolean): BitVector
Returns a vector with the specified bit inserted at the specified index.
final def intSize: Option[Int]
Returns the number of bits in this vector, or None if the size does not fit into an Int.
final def invertReverseByteOrder: BitVector
Inverse of reverseByteOrder.
final def isEmpty: Boolean
Returns true if this vector has no bits.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def last: Boolean
Returns the last bit in this vector or throws if vector is empty.
final def lastOption: Option[Boolean]
Returns the last bit in this vector or returns None if vector is empty.
final def length: Long
Alias for size.
final def lift(n: Long): Option[Boolean]
Returns Some(true) if the nth bit is high, Some(false) if low, and None if n >= size.
final def mapBytes(f: (ByteVector) => ByteVector): BitVector
Attributes
protected
def nand(other: BitVector): BitVector
Returns a bitwise NAND of this value with the specified value.
Returns a bitwise NAND of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def nonEmpty: Boolean
Returns true if this vector has a non-zero number of bits.
def nor(other: BitVector): BitVector
Returns a bitwise NOR of this value with the specified value.
Returns a bitwise NOR of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations
final def not: BitVector
Returns a bitwise complement of this bit vector.
Returns a bitwise complement of this bit vector.
Definition Classes
BitVector → BitwiseOperations
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def or(other: BitVector): BitVector
Returns a bitwise OR of this bit vector with the specified bit vector.
Returns a bitwise OR of this bit vector with the specified bit vector.
The resulting bit vector's size is the minimum of this bit vector's size and the specified bit vector's size.
Definition Classes
BitVector → BitwiseOperations
final def outOfBounds(n: Long): Nothing
Attributes
protected
final def padLeft(n: Long): BitVector
Returns an n-bit vector whose contents are 0 or more low bits followed by this vector's contents.
Returns an n-bit vector whose contents are 0 or more low bits followed by this vector's contents.
Exceptions thrown
IllegalArgumentException if n < size
final def padRight(n: Long): BitVector
Returns an n-bit vector whose contents are 0 or more low bits followed by this vector's contents.
Returns an n-bit vector whose contents are 0 or more low bits followed by this vector's contents.
Exceptions thrown
IllegalArgumentException if n < size
final def padTo(n: Long): BitVector
Alias for padRight.
Alias for padRight.
Exceptions thrown
IllegalArgumentException if n < size
final def patch(idx: Long, b: BitVector): BitVector
Returns a vector with the specified bit vector replacing bits [idx, idx + b.size].
final def populationCount: Long
Returns the number of bits that are high.
final def reverse: BitVector
Reverse the bits of this vector.
final def reverseBitOrder: BitVector
Returns a new vector of the same size with the bit order reversed.
final def reverseByteOrder: BitVector
Returns a new vector of the same size with the byte order reversed.
Returns a new vector of the same size with the byte order reversed.
Note that reverseByteOrder.reverseByteOrder == identity only when size is evenly divisble by 8. To invert reverseByteOrder for an arbitrary size, use invertReverseByteOrder.
final def rotateLeft(n: Long): BitVector
Returns a bit vector of the same size with each bit circularly shifted to the left n bits.
Returns a bit vector of the same size with each bit circularly shifted to the left n bits.
Definition Classes
BitVector → BitwiseOperations
final def rotateRight(n: Long): BitVector
Returns a bit vector of the same size with each bit circularly shifted to the right n bits.
Returns a bit vector of the same size with each bit circularly shifted to the right n bits.
Definition Classes
BitVector → BitwiseOperations
val self: BitVector
Implicit
This member is added by an implicit conversion from BitVector toGroupedOp performed by method GroupedOp in scodec.bits.BitVector.
Definition Classes
GroupedOp
final def set(n: Long): BitVector
Returns a new bit vector with the nth bit high (and all other bits unmodified).
final def shiftLeft(n: Long): BitVector
Returns a bit vector of the same size with each bit shifted to the left n bits.
Returns a bit vector of the same size with each bit shifted to the left n bits.
Definition Classes
BitVector → BitwiseOperations
final def shiftRight(n: Long, signExtension: Boolean): BitVector
Returns a bit vector of the same size with each bit shifted to the right n bits.
Returns a bit vector of the same size with each bit shifted to the right n bits.
signExtension
whether the n left-msot bits should take on the value of bit 0
Definition Classes
BitVector → BitwiseOperations
final def sizeGreaterThan(n: Long): Boolean
Returns true if the size of this BitVector is greater than n.
Returns true if the size of this BitVector is greater than n. Unlike size, this forces this BitVector from left to right, halting as soon as it has a definite answer.
final def sizeGreaterThanOrEqual(n: Long): Boolean
Returns true if the size of this BitVector is greater than or equal to n.
Returns true if the size of this BitVector is greater than or equal to n. Unlike size, this forces this BitVector from left to right, halting as soon as it has a definite answer.
final def sizeLessThanOrEqual(n: Long): Boolean
Returns true if the size of this BitVector is less than or equal to n.
Returns true if the size of this BitVector is less than or equal to n. Unlike size, this forces this BitVector from left to right, halting as soon as it has a definite answer.
final def slice(from: Long, until: Long): BitVector
Returns a vector made up of the bits starting at index from up to index until, not including the index until.
final def sliceToByte(start: Long, bits: Int, signed: Boolean = true): Byte
Convert a slice of bits from this vector (start until start+bits) to a Byte.
Convert a slice of bits from this vector (start until start+bits) to a Byte.
signed
whether sign extension should be performed
Exceptions thrown
IllegalArgumentException if the slice refers to indices that are out of range
final def sliceToInt(start: Long, bits: Int, signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Int
Convert a slice of bits from this vector (start until start+bits) to an Int.
Convert a slice of bits from this vector (start until start+bits) to an Int.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if the slice refers to indices that are out of range
final def sliceToLong(start: Long, bits: Int, signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Long
Convert a slice of bits from this vector (start until start+bits) to a Long.
Convert a slice of bits from this vector (start until start+bits) to a Long.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if the slice refers to indices that are out of range
final def sliceToShort(start: Long, bits: Int, signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Short
Convert a slice of bits from this vector (start until start+bits) to a Short.
Convert a slice of bits from this vector (start until start+bits) to a Short.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if the slice refers to indices that are out of range
final def splice(idx: Long, b: BitVector): BitVector
Returns a vector with the specified bit vector inserted at the specified index.
final def splitAt(n: Long): (BitVector, BitVector)
Returns a pair of vectors that is equal to (take(n), drop(n)).
final def startsWith(b: BitVector): Boolean
Returns true if this bit vector starts with the specified vector.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def tail: BitVector
Returns a vector of all bits in this vector except the first bit.
final def takeRight(n: Long): BitVector
Returns a vector of the last n bits of this vector.
Returns a vector of the last n bits of this vector.
The resulting vector's size is n min size.
final def toBase16(alphabet: HexAlphabet): String
Helper alias of toHex(alpbabet:scodec\.bits\.Bases\.HexAlphabet):String*
final def toBase16: String
Helper alias of toHex():String*
final def toBase32(alphabet: Base32Alphabet): String
Converts the contents of this vector to a base 32 string using the specified alphabet.
Converts the contents of this vector to a base 32 string using the specified alphabet.
The last byte is right-padded with zeros if the size is not evenly divisible by 8.
final def toBase32: String
Converts the contents of this vector to a base 32 string.
Converts the contents of this vector to a base 32 string.
The last byte is right-padded with zeros if the size is not evenly divisible by 8.
final def toBase58(alphabet: Alphabet): String
Converts the contents of this vector to a base 58 string using the specified alphabet.
Converts the contents of this vector to a base 58 string using the specified alphabet.
the order is assumed to be the same as (Bitcoin)https://en.bitcoin.it/wiki/Base58Check_encoding#Base58_symbol_chart
final def toBase58: String
Converts the contents of this vector to a base 58 string.
Converts the contents of this vector to a base 58 string.
the order is assumed to be the same as (Bitcoin)https://en.bitcoin.it/wiki/Base58Check_encoding#Base58_symbol_chart
final def toBase64(alphabet: Base64Alphabet): String
Converts the contents of this vector to a base 64 string using the specified alphabet.
Converts the contents of this vector to a base 64 string using the specified alphabet.
The last byte is right-padded with zeros if the size is not evenly divisible by 8.
final def toBase64: String
Converts the contents of this vector to a base 64 string.
Converts the contents of this vector to a base 64 string.
The last byte is right-padded with zeros if the size is not evenly divisible by 8.
final def toBase64NoPad: String
Converts the contents of this vector to a base 64 string without padding.
final def toBase64Url: String
Converts the contents of this vector to a base 64 string without padding.
final def toBase64UrlNoPad: String
Converts the contents of this vector to a base 64 string without padding.
final def toBin(alphabet: BinaryAlphabet): String
Converts the contents of this bit vector to a binary string of size digits.
final def toBin: String
Converts the contents of this bit vector to a binary string of size digits.
final def toByte(signed: Boolean = true): Byte
Converts the contents of this vector to a byte.
Converts the contents of this vector to a byte.
signed
whether sign extension should be performed
Exceptions thrown
IllegalArgumentException if size is greater than 8
final def toByteArray: Array[Byte]
Converts the contents of this vector to a byte array.
Converts the contents of this vector to a byte array.
If this vector's size does not divide evenly by 8, the last byte of the returned vector will be zero-padded to the right.
final def toByteBuffer: ByteBuffer
Converts the contents of this vector to a java.nio.ByteBuffer.
Converts the contents of this vector to a java.nio.ByteBuffer.
The returned buffer is freshly allocated with limit set to the minimum number of bytes needed to represent the contents of this vector, position set to zero, and remaining set to the limit.
See also
toByteVector
final def toByteVector: ByteVector
Converts the contents of this vector to a byte vector.
Converts the contents of this vector to a byte vector.
If this vector's size does not divide evenly by 8, the last byte of the returned vector will be zero-padded to the right.
final def toHex(alphabet: HexAlphabet): String
Converts the contents of this bit vector to a hexadecimal string of ceil(size / 4) nibbles.
Converts the contents of this bit vector to a hexadecimal string of ceil(size / 4) nibbles.
The last nibble is right-padded with zeros if the size is not evenly divisible by 4.
final def toHex: String
Converts the contents of this bit vector to a hexadecimal string of ceil(size / 4) nibbles.
Converts the contents of this bit vector to a hexadecimal string of ceil(size / 4) nibbles.
The last nibble is right-padded with zeros if the size is not evenly divisible by 4.
final def toIndexedSeq: IndexedSeq[Boolean]
Return the sequence of bits in this vector.
Return the sequence of bits in this vector. The returned IndexedSeq is just a view; nothing is actually copied.
Exceptions thrown
IllegalArgumentException if this vector's size exceeds Int.MaxValue
See also
acquire
toIndexedSeq
final def toInt(signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Int
Converts the contents of this vector to an int.
Converts the contents of this vector to an int.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if size is greater than 32
final def toLong(signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Long
Converts the contents of this vector to a long.
Converts the contents of this vector to a long.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if size is greater than 64
final def toShort(signed: Boolean = true, ordering: ByteOrdering = ByteOrdering.BigEndian): Short
Converts the contents of this vector to a short.
Converts the contents of this vector to a short.
signed
whether sign extension should be performed
ordering
order bytes should be processed in
Exceptions thrown
IllegalArgumentException if size is greater than 16
final def toString(): String
Display the size and bytes of this BitVector.
Display the size and bytes of this BitVector. For bit vectors beyond a certain size, only a hash of the contents are shown.
Definition Classes
BitVector → AnyRef → Any
final def toUUID: UUID
Converts the contents of this bit vector to a UUID.
Converts the contents of this bit vector to a UUID.
Exceptions thrown
IllegalArgumentException if size is not exactly 128.
final def unary_~: BitVector
Returns a bitwise complement of this value.
Returns a bitwise complement of this value.
Definition Classes
BitwiseOperations
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def writeReplace(): AnyRef
Attributes
protected
final def xor(other: BitVector): BitVector
Returns a bitwise XOR of this bit vector with the specified bit vector.
Returns a bitwise XOR of this bit vector with the specified bit vector.
The resulting bit vector's size is the minimum of this bit vector's size and the specified bit vector's size.
Definition Classes
BitVector → BitwiseOperations
final def |(other: BitVector): BitVector
Returns a bitwise OR of this value with the specified value.
Returns a bitwise OR of this value with the specified value.
The resulting value's size is the minimum of this value's size and the specified value's size.
Definition Classes
BitwiseOperations

Shadowed Implicit Value Members

def <(that: BitVector): Boolean
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).<(that)
Definition Classes
Ordered
def <=(that: BitVector): Boolean
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).<=(that)
Definition Classes
Ordered
def >(that: BitVector): Boolean
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).>(that)
Definition Classes
Ordered
def >=(that: BitVector): Boolean
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).>=(that)
Definition Classes
Ordered
def compare(that: BitVector): Int
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).compare(that)
Definition Classes
Ordered
def compareTo(that: BitVector): Int
Implicit
This member is added by an implicit conversion from BitVector toOrdered[BitVector] performed by method orderingToOrdered in scala.math.Ordered.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(bitVector: Ordered[BitVector]).compareTo(that)
Definition Classes
Ordered → Comparable

Deprecated Value Members

def →[B](y: B): (BitVector, B)
Implicit
This member is added by an implicit conversion from BitVector toArrowAssoc[BitVector] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Packages

BitVector

Companion object BitVector

sealed abstract class BitVector extends BitwiseOperations[BitVector, Long] with Ordered[BitVector] with Serializable

Abstract Value Members

Concrete Value Members

Shadowed Implicit Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Ordered[BitVector]

Inherited from Comparable[BitVector]

Inherited from BitwiseOperations[BitVector, Long]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GroupedOp fromBitVector to GroupedOp

Inherited by implicit conversion orderingToOrdered fromBitVector to Ordered[BitVector]

Inherited by implicit conversion any2stringadd fromBitVector to any2stringadd[BitVector]

Inherited by implicit conversion StringFormat fromBitVector to StringFormat[BitVector]

Inherited by implicit conversion Ensuring fromBitVector to Ensuring[BitVector]

Inherited by implicit conversion ArrowAssoc fromBitVector to ArrowAssoc[BitVector]

Collection Like Methods

Bitwise Operations

Conversions

Cryptography

Ungrouped

Packages

BitVector

Companion object BitVector

sealed abstract class BitVector extends BitwiseOperations[BitVector, Long] with Ordered[BitVector] with Serializable

Abstract Value Members

Concrete Value Members

Shadowed Implicit Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Ordered[BitVector]

Inherited from Comparable[BitVector]

Inherited from BitwiseOperations[BitVector, Long]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GroupedOp fromBitVector to GroupedOp

Inherited by implicit conversion orderingToOrdered fromBitVector to Ordered[BitVector]

Inherited by implicit conversion any2stringadd fromBitVector to any2stringadd[BitVector]

Inherited by implicit conversion StringFormat fromBitVector to StringFormat[BitVector]

Inherited by implicit conversion Ensuring fromBitVector to Ensuring[BitVector]

Inherited by implicit conversion ArrowAssoc fromBitVector to ArrowAssoc[BitVector]

Collection Like Methods

Bitwise Operations

Conversions

Cryptography

Ungrouped

BitVector