Package org.apache.flink.api.common.aggregators

Class DoubleZeroConvergence

java.lang.Object

org.apache.flink.api.common.aggregators.DoubleZeroConvergence

All Implemented Interfaces:

Serializable, ConvergenceCriterion<DoubleValue>

@PublicEvolving
public class DoubleZeroConvergence
extends Object
implements ConvergenceCriterion<DoubleValue>

A ConvergenceCriterion over an Aggregator that defines convergence as reached once the aggregator holds the value zero. The aggregated data type is a DoubleValue.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DoubleZeroConvergence()

Method Summary

Modifier and Type	Method	Description
boolean	isConverged(int iteration, DoubleValue value)	Returns true, if the aggregator value is zero, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleZeroConvergence

public DoubleZeroConvergence()

Method Detail

isConverged

public boolean isConverged(int iteration,
                           DoubleValue value)

Returns true, if the aggregator value is zero, false otherwise.

Specified by:

isConverged in interface ConvergenceCriterion<DoubleValue>

Parameters:

iteration - The number of the iteration superstep. Ignored in this case.

value - The aggregator value, which is compared to zero.

Returns:

True, if the aggregator value is zero, false otherwise.