EmpiricalRVParameters

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Returns an unmodifiable Set of the parameter's names for double[] Parameters

Link copied to clipboard

Returns an unmodifiable Set of the parameter's names for Double Parameters

Link copied to clipboard

Returns an unmodifiable Set of the parameter's names for Integer Parameters

Link copied to clipboard

The number of defined parameters (with names)

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns an array containing the double and integer valued parameters. The elements of the array are the parameter values based on the order of their names in doubleParameterNames and integerParameterNames. If the parameter is integer value, it is converted to a double value.

Link copied to clipboard

Returns a map containing the double and integer valued parameters. The key to the map is the name of the parameter and the value is the current value of the parameter. If the parameter is integer value, it is converted to a double value.

Link copied to clipboard

Changes the value associated with the parameterName to the supplied value. The supplied array is copied.

Link copied to clipboard
fun changeDoubleParameter(parameterName: String, value: Double): Double

Changes the value associated with the parameterName to the supplied value. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs

Link copied to clipboard
fun changeIntegerParameter(parameterName: String, value: Int): Int

Changes the value of the parameterName to the supplied value. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs.

Link copied to clipboard
fun changeParameter(parameterName: String, value: Double): Boolean

A convenience method to change the named parameter to the supplied value. This will work with either double or integer parameters. Integer parameters are coerced to the rounded up value of the supplied double, provided that the integer can hold the supplied value. If the named parameter is not associated with the parameters, then no change occurs. In other words, the action fails, silently by returning false.

Link copied to clipboard

Checks if the supplied key is contained in the parameters

Link copied to clipboard
fun copyFrom(rvParameters: RVParameters)

Copies from the supplied parameters into this parameters

Link copied to clipboard
Link copied to clipboard

Gets the value associated with the supplied parameterName as a double[]. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs

Link copied to clipboard
fun doubleArrayParameterSize(parameterName: String): Int

Returns the size (array length) of the DoubleArray parameter. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs

Link copied to clipboard
fun doubleParameter(parameterName: String): Double

Gets the value associated with the supplied parameterName as a double. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard

Returns true if at least one double[] parameter has been set

Link copied to clipboard
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard

Returns true if at least one Integer parameter has been set

Link copied to clipboard
fun integerParameter(parameterName: String): Int

Gets the value associated with the supplied parameterName. If the parameterName is null or there is no parameter for the supplied parameterName, then an exception occurs.

Link copied to clipboard

Can be used to determine which of the getXParameter(String key) methods to call

Link copied to clipboard
open override fun toString(): String