org.apache.flink.graph.drivers.parameter

Class DoubleParameter

java.lang.Object

org.apache.flink.graph.drivers.parameter.SimpleParameter<Double>

org.apache.flink.graph.drivers.parameter.DoubleParameter

All Implemented Interfaces:

Parameter<Double>

public class DoubleParameter
extends SimpleParameter<Double>

A Parameter storing a Double.

Field Summary

Fields inherited from class org.apache.flink.graph.drivers.parameter.SimpleParameter

defaultValue, hasDefaultValue, name, value

Constructor Summary

Constructors

Constructor and Description
DoubleParameter(ParameterizedBase owner, String name) Set the parameter name and add this parameter to the list of parameters stored by owner.

Method Summary

Modifier and Type	Method and Description
void	configure(org.apache.flink.api.java.utils.ParameterTool parameterTool) Read and parse the parameter value from command-line arguments.
DoubleParameter	setDefaultValue(double defaultValue) Set the default value.
DoubleParameter	setMaximumValue(double maximumValue, boolean inclusive) Set the maximum value.
DoubleParameter	setMinimumValue(double minimumValue, boolean inclusive) Set the minimum value.
String	toString()

Methods inherited from class org.apache.flink.graph.drivers.parameter.SimpleParameter

getUsage, getValue, isHidden, setDefaultValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleParameter

public DoubleParameter(ParameterizedBase owner,
                       String name)

Set the parameter name and add this parameter to the list of parameters stored by owner.

Parameters:

owner - the Parameterized using this Parameter

name - the parameter name

Method Detail

setDefaultValue

public DoubleParameter setDefaultValue(double defaultValue)

Set the default value.

Parameters:

defaultValue - the default value

Returns:

this

setMinimumValue

public DoubleParameter setMinimumValue(double minimumValue,
                                       boolean inclusive)

Set the minimum value. The minimum value is an acceptable value if and only if inclusive is set to true.

Parameters:

minimumValue - the minimum value

inclusive - whether the minimum value is a valid value

Returns:

this

setMaximumValue

public DoubleParameter setMaximumValue(double maximumValue,
                                       boolean inclusive)

Set the maximum value. The maximum value is an acceptable value if and only if inclusive is set to true.

Parameters:

maximumValue - the maximum value

inclusive - whether the maximum value is a valid value

Returns:

this

configure

public void configure(org.apache.flink.api.java.utils.ParameterTool parameterTool)

Description copied from interface: Parameter

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

Parameters:

parameterTool - parameter parser

toString

public String toString()

Overrides:

toString in class Object