uk.ac.starlink.ttools.plot2

Class RangeCollector<S extends Splittable<S>>

java.lang.Object

uk.ac.starlink.ttools.plot2.RangeCollector<S>

All Implemented Interfaces:

SplitCollector<S,Range[]>

public abstract class RangeCollector<S extends Splittable<S>>
extends Object
implements SplitCollector<S,Range[]>

Partial SplitCollector implementation for accumulating range data. The accumulate method should be implemented to submit values to an N-element array of ranges.

On completion, the mergeRanges(uk.ac.starlink.ttools.plot.Range[], uk.ac.starlink.ttools.plot.Range[]) method may be used to update a supplied Range array with the collected result.

Since:

22 Jan 2021

Author:

Mark Taylor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RangeCollector(int ndim) Constructor.

Method Summary

Modifier and Type	Method and Description
Range[]	combine(Range[] ranges1, Range[] ranges2) Combines the content of two accumulators.
Range[]	createAccumulator() Returns a new accumulator into which results can be collected.
void	mergeRanges(Range[] ranges0, Range[] ranges1) Merges the content of the second range into the first one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.starlink.util.SplitCollector

accumulate

Constructor Detail

RangeCollector

protected RangeCollector(int ndim)

Constructor.

Parameters:

ndim - number of range objects (data dimensions)

Method Detail

createAccumulator

public Range[] createAccumulator()

Description copied from interface: SplitCollector

Returns a new accumulator into which results can be collected. Accumulator instances may only be used from one thread at any one time.

Specified by:

createAccumulator in interface SplitCollector<S extends Splittable<S>,Range[]>

Returns:

new accumulator

combine

public Range[] combine(Range[] ranges1,
                       Range[] ranges2)

Description copied from interface: SplitCollector

Combines the content of two accumulators. The returned value may or may not be the same object as one of the input values. The input values should not be used following this call. The sequence of the input values is not significant.

Specified by:

combine in interface SplitCollector<S extends Splittable<S>,Range[]>

Parameters:

ranges1 - one input accumulator

ranges2 - other input accumulator

Returns:

accumulator containing the combined result of the inputs

mergeRanges

public void mergeRanges(Range[] ranges0,
                        Range[] ranges1)

Merges the content of the second range into the first one.

Parameters:

ranges0 - first input range, modified on exit

ranges1 - second input range, unmodified on exit