Packages

object GCS

Defines all functionality dealing with Golomb-Coded Sets

See also

https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#GolombCoded_Sets

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GCS
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buildBasicBlockFilter(data: Vector[ByteVector], key: SipHashKey): GolombFilter

    Given data, constructs a GolombFilter for that data using Basic Block Filter parameters

    Given data, constructs a GolombFilter for that data using Basic Block Filter parameters

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#block-filters

  6. def buildGCS(data: Vector[ByteVector], key: SipHashKey, p: UInt8, m: UInt64): BitVector

    Given parameters and data, golomb-encodes the data

    Given parameters and data, golomb-encodes the data

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#set-construction

  7. def buildGolombFilter(data: Vector[ByteVector], key: SipHashKey, p: UInt8, m: UInt64): GolombFilter

    Given parameters and data, constructs a GolombFilter for that data

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def encodeSortedSet(hashes: Vector[UInt64], p: UInt8): BitVector

    Given a set of ascending hashes, golomb-encodes them

    Given a set of ascending hashes, golomb-encodes them

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#set-construction

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def golombDecode(codedItem: BitVector, p: UInt8): UInt64

    Decodes an item off of the front of a BitVector by reversing GCS.golombEncode

    Decodes an item off of the front of a BitVector by reversing GCS.golombEncode

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#golomb-rice-coding

  15. def golombDecodeSet(encodedData: BitVector, p: UInt8): Vector[UInt64]

    Decodes all hashes from golomb-encoded data, reversing GCS.encodeSortedSet

  16. def golombDecodeSetsWithPredicate(encodedData: BitVector, p: UInt8)(predicate: (UInt64) => Boolean): Vector[UInt64]

    Decodes all hashes while the given predicate returns true

    Decodes all hashes while the given predicate returns true

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#set-queryingdecompression

  17. def golombEncode(item: UInt64, p: UInt8): BitVector

    Encodes a hash into a unary prefix and binary suffix

    Encodes a hash into a unary prefix and binary suffix

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#golomb-rice-coding

  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashToRange(item: ByteVector, f: UInt64, key: SipHashKey): UInt64

    Hashes the item to the range [0, f)

  20. def hashedSetConstruct(rawItems: Vector[ByteVector], key: SipHashKey, m: UInt64): Vector[UInt64]

    Hashes the items of a set of items

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def toUnary(num: UInt64): BitVector

    Converts num to unary (6 = 1111110)

    Converts num to unary (6 = 1111110)

    See also

    https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki#golomb-rice-coding TODO: protect against large inputs which cause OutOfMemoryErrors and even larger ones which fail on toInt

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped