Package org.apache.datasketches.common

Class ArrayOfBooleansSerDe

java.lang.Object
org.apache.datasketches.common.ArrayOfItemsSerDe<Boolean>
org.apache.datasketches.common.ArrayOfBooleansSerDe
public class ArrayOfBooleansSerDe extends ArrayOfItemsSerDe<Boolean>
Methods of serializing and deserializing arrays of Boolean as a bit array.
Author:
Jon Malkin

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArrayOfBooleansSerDe()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    computeBytesNeeded(int arrayLength)
    Computes number of bytes needed for packed bit encoding of the array of booleans.
    Boolean[]
    deserializeFromMemory(org.apache.datasketches.memory.Memory mem, int numItems)
    Deserialize a contiguous sequence of serialized items from the given Memory starting at a Memory offset of zero and extending numItems.
    Boolean[]
    deserializeFromMemory(org.apache.datasketches.memory.Memory mem, long offsetBytes, int numItems)
    Deserialize a contiguous sequence of serialized items from the given Memory starting at the given Memory offsetBytes and extending numItems.
    Class<Boolean>
    getClassOfT()
    Returns the concrete class of type T
    byte[]
    serializeToByteArray(Boolean item)
    Serialize a single unserialized item to a byte array.
    byte[]
    serializeToByteArray(Boolean[] items)
    Serialize an array of unserialized items to a byte array of contiguous serialized items.
    int
    sizeOf(Boolean item)
    Returns the serialized size in bytes of a single unserialized item.
    int
    sizeOf(Boolean[] items)
    Returns the serialized size in bytes of the array of items.
    int
    sizeOf(org.apache.datasketches.memory.Memory mem, long offsetBytes, int numItems)
    Returns the serialized size in bytes of the number of contiguous serialized items in Memory.
    String
    toString(Boolean item)
    Returns a human readable string of an item.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ArrayOfBooleansSerDe

      public ArrayOfBooleansSerDe()

  • Method Details

    • computeBytesNeeded

      public static int computeBytesNeeded(int arrayLength)
      Computes number of bytes needed for packed bit encoding of the array of booleans. Rounds partial bytes up to return a whole number of bytes.
      Parameters:
      arrayLength - Number of items in the array to serialize
      Returns:
      Number of bytes needed to encode the array

    • serializeToByteArray

      public byte[] serializeToByteArray(Boolean item)
      Description copied from class: ArrayOfItemsSerDe
      Serialize a single unserialized item to a byte array.
      Specified by:
      serializeToByteArray in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      item - the item to be serialized
      Returns:
      serialized representation of the given item

    • serializeToByteArray

      public byte[] serializeToByteArray(Boolean[] items)
      Description copied from class: ArrayOfItemsSerDe
      Serialize an array of unserialized items to a byte array of contiguous serialized items.
      Specified by:
      serializeToByteArray in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      items - array of items to be serialized
      Returns:
      contiguous, serialized representation of the given array of unserialized items

    • deserializeFromMemory

      public Boolean[] deserializeFromMemory(org.apache.datasketches.memory.Memory mem, int numItems)
      Description copied from class: ArrayOfItemsSerDe
      Deserialize a contiguous sequence of serialized items from the given Memory starting at a Memory offset of zero and extending numItems.
      Overrides:
      deserializeFromMemory in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      mem - Memory containing a contiguous sequence of serialized items
      numItems - number of items in the contiguous serialized sequence.
      Returns:
      array of deserialized items
      See Also:

    • deserializeFromMemory

      public Boolean[] deserializeFromMemory(org.apache.datasketches.memory.Memory mem, long offsetBytes, int numItems)
      Description copied from class: ArrayOfItemsSerDe
      Deserialize a contiguous sequence of serialized items from the given Memory starting at the given Memory offsetBytes and extending numItems.
      Specified by:
      deserializeFromMemory in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      mem - Memory containing a contiguous sequence of serialized items
      offsetBytes - the starting offset in the given Memory.
      numItems - number of items in the contiguous serialized sequence.
      Returns:
      array of deserialized items

    • sizeOf

      public int sizeOf(Boolean item)
      Description copied from class: ArrayOfItemsSerDe
      Returns the serialized size in bytes of a single unserialized item.
      Specified by:
      sizeOf in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      item - a specific item
      Returns:
      the serialized size in bytes of a single unserialized item.

    • sizeOf

      public int sizeOf(Boolean[] items)
      Description copied from class: ArrayOfItemsSerDe
      Returns the serialized size in bytes of the array of items.
      Overrides:
      sizeOf in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      items - an array of items.
      Returns:
      the serialized size in bytes of the array of items.

    • sizeOf

      public int sizeOf(org.apache.datasketches.memory.Memory mem, long offsetBytes, int numItems)
      Description copied from class: ArrayOfItemsSerDe
      Returns the serialized size in bytes of the number of contiguous serialized items in Memory. The capacity of the given Memory can be much larger that the required size of the items.
      Specified by:
      sizeOf in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      mem - the given Memory.
      offsetBytes - the starting offset in the given Memory.
      numItems - the number of serialized items contained in the Memory
      Returns:
      the serialized size in bytes of the given number of items.

    • toString

      public String toString(Boolean item)
      Description copied from class: ArrayOfItemsSerDe
      Returns a human readable string of an item.
      Specified by:
      toString in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      item - a specific item
      Returns:
      a human readable string of an item.

    • getClassOfT

      public Class<Boolean> getClassOfT()
      Description copied from class: ArrayOfItemsSerDe
      Returns the concrete class of type T
      Specified by:
      getClassOfT in class ArrayOfItemsSerDe<Boolean>
      Returns:
      the concrete class of type T