com.yahoo.sketches.tuple

Interface SummaryFactory<S extends Summary>

Type Parameters:

S - type of Summary

All Known Implementing Classes:

DoubleSummaryFactory

public interface SummaryFactory<S extends Summary>

Interface for user-defined SummaryFactory

Method Summary

Modifier and Type	Method and Description
SummarySetOperations<S>	getSummarySetOperations() This is to obtain methods of producing unions and intersections of two Summary objects
S	newSummary()
DeserializeResult<S>	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.

Method Detail

newSummary

S newSummary()

Returns:

new instance of Summary

getSummarySetOperations

SummarySetOperations<S> getSummarySetOperations()

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

Returns:

SummarySetOperations

summaryFromMemory

DeserializeResult<S> summaryFromMemory(Memory mem)

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

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

toByteArray

byte[] toByteArray()

This is to serialize an instance to a byte array. For deserialization there must be a static method DeserializeResult<T> fromMemory(Memory mem)

Returns:

serialized representation of the SummaryFactory