org.apache.flink.graph.drivers.parameter

Class IterationConvergence

java.lang.Object

org.apache.flink.graph.drivers.parameter.IterationConvergence

All Implemented Interfaces:

Parameter<IterationConvergence.Value>

public class IterationConvergence
extends Object
implements Parameter<IterationConvergence.Value>

Iterative algorithms which converge can be terminated with a maximum number of iterations or a convergence threshold which stops computation when the total change in scores is below a given delta.

If the command-line configuration specifies neither a number of iterations nor a convergence threshold then a default number of iterations is used with an infinite convergence threshold. Otherwise, when either value is configured then an unset value is set to infinity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IterationConvergence.Value Encapsulate the number of iterations and the convergence threshold.

Constructor Summary

Constructors

Constructor and Description
IterationConvergence(ParameterizedBase owner, int defaultIterations) Add this parameter to the list of parameters stored by owner.

Method Summary

Modifier and Type	Method and Description
void	configure(ParameterTool parameterTool) Read and parse the parameter value from command-line arguments.
String	getUsage() An informal usage string.
IterationConvergence.Value	getValue() Get the parameter value.
boolean	isHidden() A hidden parameter is parsed from the command-line configuration but is not printed in the usage string.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterationConvergence

public IterationConvergence(ParameterizedBase owner,
                            int defaultIterations)

Add this parameter to the list of parameters stored by owner.

Parameters:

owner - the Parameterized using this Parameter

defaultIterations - the default number of iterations if neither the number of iterations nor the convergence threshold are specified

Method Detail

getUsage

public String getUsage()

Description copied from interface: Parameter

An informal usage string. Parameter names are prefixed with "--".

Optional parameters are enclosed by "[" and "]".

Generic values are represented by all-caps with specific values enclosed by "<" and ">".

Specified by:

getUsage in interface Parameter<IterationConvergence.Value>

Returns:

command-line usage string

isHidden

public boolean isHidden()

Description copied from interface: Parameter

A hidden parameter is parsed from the command-line configuration but is not printed in the usage string. This can be used for power-user options not displayed to the general user.

Specified by:

isHidden in interface Parameter<IterationConvergence.Value>

Returns:

whether this parameter should be hidden from standard usage

configure

public void configure(ParameterTool parameterTool)

Description copied from interface: Parameter

Read and parse the parameter value from command-line arguments.

Specified by:

configure in interface Parameter<IterationConvergence.Value>

Parameters:

parameterTool - parameter parser

getValue

public IterationConvergence.Value getValue()

Description copied from interface: Parameter

Get the parameter value.

Specified by:

getValue in interface Parameter<IterationConvergence.Value>

Returns:

parameter value