Class DoubleSummary

  • All Implemented Interfaces:
    Summary, UpdatableSummary<Double>

    public final class DoubleSummary
    extends Object
    implements UpdatableSummary<Double>
    Summary for generic tuple sketches of type Double. This summary keeps a double value. On update a predefined operation is performed depending on the mode. Supported modes: Sum, Min, Max, AlwaysOne, Increment. The default mode is Sum.
    • Constructor Detail

      • DoubleSummary

        public DoubleSummary​(DoubleSummary.Mode mode)
        Creates an instance of DoubleSummary with a given mode.
        Parameters:
        mode - update mode
    • Method Detail

      • copy

        public DoubleSummary copy()
        Description copied from interface: Summary
        Deep copy.

        Caution: This must implement a deep copy.

        Specified by:
        copy in interface Summary
        Returns:
        deep copy of the Summary
      • getValue

        public double getValue()
        Returns:
        current value of the DoubleSummary
      • toByteArray

        public byte[] toByteArray()
        Description copied from interface: Summary
        This is to serialize a Summary instance to a byte array.

        The user should encode in the byte array its total size, which is used during deserialization, especially if the Summary has variable sized elements.

        Specified by:
        toByteArray in interface Summary
        Returns:
        serialized representation of the Summary
      • fromMemory

        public static DeserializeResult<DoubleSummary> fromMemory​(org.apache.datasketches.memory.Memory mem)
        Creates an instance of the DoubleSummary given a serialized representation
        Parameters:
        mem - Memory object with serialized DoubleSummary
        Returns:
        DeserializedResult object, which contains a DoubleSummary object and number of bytes read from the Memory