org.apache.datasketches.tuple.adouble

Class DoubleSummarySetOperations

java.lang.Object

org.apache.datasketches.tuple.adouble.DoubleSummarySetOperations

All Implemented Interfaces:

SummarySetOperations<DoubleSummary>

public final class DoubleSummarySetOperations
extends Object
implements SummarySetOperations<DoubleSummary>

Methods for defining how unions and intersections of two objects of type DoubleSummary are performed. These methods are not called directly by a user.

Constructor Summary

Constructors

Constructor and Description
DoubleSummarySetOperations() Deprecated.
DoubleSummarySetOperations(DoubleSummary.Mode summaryMode) Creates an instance given a DoubleSummary update mode.

Method Summary

Modifier and Type	Method and Description
DoubleSummary	intersection(DoubleSummary a, DoubleSummary b) Intersection is not well defined or even meaningful between numeric values.
DoubleSummary	union(DoubleSummary a, DoubleSummary b) This is called when a union of two sketches is produced, and both sketches have the same key.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleSummarySetOperations

@Deprecated
public DoubleSummarySetOperations()

Deprecated.

Creates an instance with default mode.

DoubleSummarySetOperations

public DoubleSummarySetOperations(DoubleSummary.Mode summaryMode)

Creates an instance given a DoubleSummary update mode.

Parameters:

summaryMode - DoubleSummary update mode.

Method Detail

union

public DoubleSummary union(DoubleSummary a,
                           DoubleSummary b)

Description copied from interface: SummarySetOperations

This is called when a union of two sketches is produced, and both sketches have the same key.

Caution: Do not modify the input Summary objects. Also do not return them directly, unless they are immutable (most Summary objects are not). For mutable Summary objects, it is important to create a new Summary object with the correct contents to be returned. Do not return null summaries.

Specified by:

union in interface SummarySetOperations<DoubleSummary>

Parameters:

a - Summary from sketch A

b - Summary from sketch B

Returns:

union of Summary A and Summary B

intersection

public DoubleSummary intersection(DoubleSummary a,
                                  DoubleSummary b)

Intersection is not well defined or even meaningful between numeric values. Nevertheless, this can be defined to be just a different type of aggregation. In this case it is defined to be the same as union. It can be overridden to be a more meaningful operation.

Specified by:

intersection in interface SummarySetOperations<DoubleSummary>

Parameters:

a - Summary from sketch A

b - Summary from sketch B

Returns:

intersection of Summary A and Summary B