com.yahoo.sketches.tuple

Class DoubleSummary

java.lang.Object

com.yahoo.sketches.tuple.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. Three modes are supported: Sum, Min and Max. The default mode is Sum.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DoubleSummary.Mode The aggregation modes for this Summary

Constructor Summary

Constructors

Constructor and Description
DoubleSummary() Creates an instance of DoubleSummary with zero starting value and default mode (Sum)
DoubleSummary(double value, DoubleSummary.Mode mode) Creates an instance of DoubleSummary with a given starting value and mode
DoubleSummary(DoubleSummary.Mode mode) Creates an instance of DoubleSummary with zero starting value and a given mode (Sum)

Method Summary

Modifier and Type	Method and Description
DoubleSummary	copy()
static DeserializeResult<DoubleSummary>	fromMemory(Memory mem) Creates an instance of the DoubleSummary given a serialized representation
double	getValue()
byte[]	toByteArray() This is to serialize an instance to a byte array.
void	update(Double value) This is to provide a method of updating summaries

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleSummary

public DoubleSummary()

Creates an instance of DoubleSummary with zero starting value and default mode (Sum)

DoubleSummary

public DoubleSummary(DoubleSummary.Mode mode)

Creates an instance of DoubleSummary with zero starting value and a given mode (Sum)

Parameters:

mode - update mode

DoubleSummary

public DoubleSummary(double value,
                     DoubleSummary.Mode mode)

Creates an instance of DoubleSummary with a given starting value and mode

Parameters:

value - starting value

mode - update mode

Method Detail

update

public void update(Double value)

Description copied from interface: UpdatableSummary

This is to provide a method of updating summaries

Specified by:

update in interface UpdatableSummary<Double>

Parameters:

value - update value

copy

public DoubleSummary copy()

Specified by:

copy in interface Summary

Returns:

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 an instance to a byte array. For deserialization there must be a static method DeserializeResult<T> fromMemory(Memory mem)

Specified by:

toByteArray in interface Summary

Returns:

serialized representation of the Summary

fromMemory

public static DeserializeResult<DoubleSummary> fromMemory(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