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 Details

    • ArrayOfBooleansSerDe

      public ArrayOfBooleansSerDe()
      No argument constructor.

  • 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

    • deserializeFromMemorySegment

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

    • deserializeFromMemorySegment

      public Boolean[] deserializeFromMemorySegment(MemorySegment seg, long offsetBytes, int numItems)
      Description copied from class: ArrayOfItemsSerDe
      Deserialize a contiguous sequence of serialized items from the given MemorySegment starting at the given MemorySegment offsetBytes and extending numItems.
      Specified by:
      deserializeFromMemorySegment in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      seg - MemorySegment containing a contiguous sequence of serialized items
      offsetBytes - the starting offset in the given MemorySegment.
      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(MemorySegment seg, long offsetBytes, int numItems)
      Description copied from class: ArrayOfItemsSerDe
      Returns the serialized size in bytes of the number of contiguous serialized items in MemorySegment. The capacity of the given MemorySegment can be much larger that the required size of the items.
      Specified by:
      sizeOf in class ArrayOfItemsSerDe<Boolean>
      Parameters:
      seg - the given MemorySegment.
      offsetBytes - the starting offset in the given MemorySegment.
      numItems - the number of serialized items contained in the MemorySegment
      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