LongZeroConvergence (Flink : Core 1.20.2-cp1 API)

java.lang.Object
- org.apache.flink.api.common.aggregators.LongZeroConvergence

All Implemented Interfaces:

Serializable, ConvergenceCriterion<LongValue>
```
@PublicEvolving
public class LongZeroConvergence
extends Object
implements ConvergenceCriterion<LongValue>
```
A ConvergenceCriterion over an Aggregator that defines convergence as reached once the aggregator holds the value zero. The aggregated data type is a LongValue.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

LongZeroConvergence()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isConverged(int iteration, LongValue 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
  - LongZeroConvergence
```
public LongZeroConvergence()
```
- Method Detail
  - isConverged
```
public boolean isConverged(int iteration,
                           LongValue value)
```
    Returns true, if the aggregator value is zero, false otherwise.
    
    Specified by:
    
    isConverged in interface ConvergenceCriterion<LongValue>
    
    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.