com.yahoo.sketches.tuple

Class DoubleSummaryFactory

java.lang.Object

com.yahoo.sketches.tuple.DoubleSummaryFactory

All Implemented Interfaces:

SummaryFactory<DoubleSummary>

public final class DoubleSummaryFactory
extends Object
implements SummaryFactory<DoubleSummary>

Factory for DoubleSummary. It supports three modes of operation of DoubleSummary: Sum, Min and Max.

Constructor Summary

Constructors

Constructor and Description
DoubleSummaryFactory() Creates an instance of DoubleSummaryFactory with default mode
DoubleSummaryFactory(DoubleSummary.Mode summaryMode) Creates an instance of DoubleSummaryFactory with a given mode

Method Summary

Modifier and Type	Method and Description
static DeserializeResult<DoubleSummaryFactory>	fromMemory(Memory mem) Creates an instance of the DoubleSummaryFactory given a serialized representation
DoubleSummarySetOperations	getSummarySetOperations() This is to obtain methods of producing unions and intersections of two Summary objects
DoubleSummary	newSummary()
DeserializeResult<DoubleSummary>	summaryFromMemory(Memory mem) This is to create an instance of a Summary given a serialized representation
byte[]	toByteArray() This is to serialize an instance to a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleSummaryFactory

public DoubleSummaryFactory()

Creates an instance of DoubleSummaryFactory with default mode

DoubleSummaryFactory

public DoubleSummaryFactory(DoubleSummary.Mode summaryMode)

Creates an instance of DoubleSummaryFactory with a given mode

Parameters:

summaryMode - summary mode

Method Detail

newSummary

public DoubleSummary newSummary()

Specified by:

newSummary in interface SummaryFactory<DoubleSummary>

Returns:

new instance of Summary

getSummarySetOperations

public DoubleSummarySetOperations getSummarySetOperations()

Description copied from interface: SummaryFactory

This is to obtain methods of producing unions and intersections of two Summary objects

Specified by:

getSummarySetOperations in interface SummaryFactory<DoubleSummary>

Returns:

SummarySetOperations

toByteArray

public byte[] toByteArray()

Description copied from interface: SummaryFactory

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 SummaryFactory<DoubleSummary>

Returns:

serialized representation of the SummaryFactory

fromMemory

public static DeserializeResult<DoubleSummaryFactory> fromMemory(Memory mem)

Creates an instance of the DoubleSummaryFactory given a serialized representation

Parameters:

mem - Memory object with serialized DoubleSummaryFactory

Returns:

DeserializedResult object, which contains a DoubleSummaryFactory object and number of bytes read from the Memory

summaryFromMemory

public DeserializeResult<DoubleSummary> summaryFromMemory(Memory mem)

Description copied from interface: SummaryFactory

This is to create an instance of a Summary given a serialized representation

Specified by:

summaryFromMemory in interface SummaryFactory<DoubleSummary>

Parameters:

mem - Memory object with serialized representation of a Summary

Returns:

DeserializedResult object, which contains a Summary object and number of bytes read from the Memory