Package org.jpmml.evaluator

Class FloatValue

java.lang.Object

org.jpmml.evaluator.Value<java.lang.Float>

org.jpmml.evaluator.FloatValue

All Implemented Interfaces:

java.lang.Comparable<Value<java.lang.Float>>

public class FloatValue
extends Value<java.lang.Float>

Field Summary

Fields

Modifier and Type	Field	Description
static double	E
static double	PI
protected float	value

Constructor Summary

Constructors

Constructor	Description
FloatValue(float value)
FloatValue(java.lang.Number value)

Method Summary

Modifier and Type	Method	Description
FloatValue	abs()
FloatValue	add(java.lang.Number value)
FloatValue	add(java.lang.Number coefficient, java.lang.Number factor)	Adds coefficient * factor.
FloatValue	add(java.lang.Number coefficient, java.lang.Number... factors)	Adds coefficient * product(factors).
FloatValue	add(java.lang.Number coefficient, java.lang.Number factor, int exponent)	Adds coefficient * (factor ^ exponent).
FloatValue	add(java.lang.Number coefficient, java.lang.Number firstFactor, java.lang.Number secondFactor)
FloatValue	add(Value<? extends java.lang.Number> value)
FloatValue	arctan()
FloatValue	ceiling()
int	compareTo(java.lang.Number value)
int	compareTo(Value<java.lang.Float> that)
FloatValue	copy()
FloatValue	cos()
FloatValue	denormalize(java.lang.Number leftOrig, java.lang.Number leftNorm, java.lang.Number rightOrig, java.lang.Number rightNorm)
FloatValue	divide(java.lang.Number value)
FloatValue	divide(Value<? extends java.lang.Number> value)
double	doubleValue()
FloatValue	elliott()
boolean	equals(java.lang.Number value)
boolean	equals(java.lang.Object object)
FloatValue	exp()
static float	exp(float value)	Computes exp(float).
float	floatValue()
FloatValue	floor()
FloatValue	gauss()
FloatValue	gaussSim(java.lang.Number value)
java.lang.Float	getValue()
int	hashCode()
FloatValue	inverseCauchit()
FloatValue	inverseCloglog()
FloatValue	inverseLogc()
FloatValue	inverseLogit()
FloatValue	inverseLoglog()
FloatValue	inverseNegbin(java.lang.Number value)
FloatValue	inverseOddspower(java.lang.Number value)
FloatValue	inversePower(java.lang.Number value)
FloatValue	inverseProbit()
boolean	isOne()
boolean	isZero()
FloatValue	ln()
FloatValue	multiply(java.lang.Number value)
FloatValue	multiply(java.lang.Number factor, java.lang.Number exponent)	Multiplies by factor ^ exponent.
FloatValue	multiply(Value<? extends java.lang.Number> value)
FloatValue	normalize(java.lang.Number leftOrig, java.lang.Number leftNorm, java.lang.Number rightOrig, java.lang.Number rightNorm)
static float	pow(float value, float power)
FloatValue	power(java.lang.Number value)
FloatValue	reciprocal()
FloatValue	relu()
FloatValue	reset(java.lang.Number value)
FloatValue	residual(Value<? extends java.lang.Number> value)
FloatValue	restrict(java.lang.Number lowValue, java.lang.Number highValue)
FloatValue	round()
FloatValue	sin()
FloatValue	square()
FloatValue	subtract(java.lang.Number value)
FloatValue	subtract(Value<? extends java.lang.Number> value)
FloatValue	tanh()
FloatValue	threshold(java.lang.Number value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected float value

E

public static final double E

See Also:

Constant Field Values

PI

public static final double PI

See Also:

Constant Field Values

Constructor Detail

FloatValue

public FloatValue(float value)

FloatValue

public FloatValue(java.lang.Number value)

Method Detail

compareTo

public int compareTo(Value<java.lang.Float> that)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

copy

public FloatValue copy()

Specified by:

copy in class Value<java.lang.Float>

reset

public FloatValue reset(java.lang.Number value)

Specified by:

reset in class Value<java.lang.Float>

add

public FloatValue add(java.lang.Number value)

Specified by:

add in class Value<java.lang.Float>

add

public FloatValue add(Value<? extends java.lang.Number> value)

Specified by:

add in class Value<java.lang.Float>

add

public FloatValue add(java.lang.Number coefficient,
                      java.lang.Number factor)

Description copied from class: Value

Adds coefficient * factor.

Specified by:

add in class Value<java.lang.Float>

add

public FloatValue add(java.lang.Number coefficient,
                      java.lang.Number firstFactor,
                      java.lang.Number secondFactor)

Specified by:

add in class Value<java.lang.Float>

add

public FloatValue add(java.lang.Number coefficient,
                      java.lang.Number... factors)

Description copied from class: Value

Adds coefficient * product(factors).

Specified by:

add in class Value<java.lang.Float>

add

public FloatValue add(java.lang.Number coefficient,
                      java.lang.Number factor,
                      int exponent)

Description copied from class: Value

Adds coefficient * (factor ^ exponent).

Specified by:

add in class Value<java.lang.Float>

subtract

public FloatValue subtract(java.lang.Number value)

Specified by:

subtract in class Value<java.lang.Float>

subtract

public FloatValue subtract(Value<? extends java.lang.Number> value)

Specified by:

subtract in class Value<java.lang.Float>

multiply

public FloatValue multiply(java.lang.Number value)

Specified by:

multiply in class Value<java.lang.Float>

multiply

public FloatValue multiply(Value<? extends java.lang.Number> value)

Specified by:

multiply in class Value<java.lang.Float>

multiply

public FloatValue multiply(java.lang.Number factor,
                           java.lang.Number exponent)

Description copied from class: Value

Multiplies by factor ^ exponent.

Specified by:

multiply in class Value<java.lang.Float>

divide

public FloatValue divide(java.lang.Number value)

Specified by:

divide in class Value<java.lang.Float>

divide

public FloatValue divide(Value<? extends java.lang.Number> value)

Specified by:

divide in class Value<java.lang.Float>

residual

public FloatValue residual(Value<? extends java.lang.Number> value)

Specified by:

residual in class Value<java.lang.Float>

square

public FloatValue square()

Specified by:

square in class Value<java.lang.Float>

power

public FloatValue power(java.lang.Number value)

Specified by:

power in class Value<java.lang.Float>

reciprocal

public FloatValue reciprocal()

Specified by:

reciprocal in class Value<java.lang.Float>

elliott

public FloatValue elliott()

Specified by:

elliott in class Value<java.lang.Float>

exp

public FloatValue exp()

Specified by:

exp in class Value<java.lang.Float>

ln

public FloatValue ln()

Specified by:

ln in class Value<java.lang.Float>

gauss

public FloatValue gauss()

Specified by:

gauss in class Value<java.lang.Float>

inverseLogit

public FloatValue inverseLogit()

Specified by:

inverseLogit in class Value<java.lang.Float>

inverseCloglog

public FloatValue inverseCloglog()

Specified by:

inverseCloglog in class Value<java.lang.Float>

inverseLoglog

public FloatValue inverseLoglog()

Specified by:

inverseLoglog in class Value<java.lang.Float>

inverseLogc

public FloatValue inverseLogc()

Specified by:

inverseLogc in class Value<java.lang.Float>

inverseNegbin

public FloatValue inverseNegbin(java.lang.Number value)

Specified by:

inverseNegbin in class Value<java.lang.Float>

inverseOddspower

public FloatValue inverseOddspower(java.lang.Number value)

Specified by:

inverseOddspower in class Value<java.lang.Float>

inversePower

public FloatValue inversePower(java.lang.Number value)

Specified by:

inversePower in class Value<java.lang.Float>

inverseCauchit

public FloatValue inverseCauchit()

Specified by:

inverseCauchit in class Value<java.lang.Float>

inverseProbit

public FloatValue inverseProbit()

Specified by:

inverseProbit in class Value<java.lang.Float>

sin

public FloatValue sin()

Specified by:

sin in class Value<java.lang.Float>

cos

public FloatValue cos()

Specified by:

cos in class Value<java.lang.Float>

arctan

public FloatValue arctan()

Specified by:

arctan in class Value<java.lang.Float>

tanh

public FloatValue tanh()

Specified by:

tanh in class Value<java.lang.Float>

threshold

public FloatValue threshold(java.lang.Number value)

Specified by:

threshold in class Value<java.lang.Float>

relu

public FloatValue relu()

Specified by:

relu in class Value<java.lang.Float>

abs

public FloatValue abs()

Specified by:

abs in class Value<java.lang.Float>

gaussSim

public FloatValue gaussSim(java.lang.Number value)

Specified by:

gaussSim in class Value<java.lang.Float>

restrict

public FloatValue restrict(java.lang.Number lowValue,
                           java.lang.Number highValue)

Specified by:

restrict in class Value<java.lang.Float>

round

public FloatValue round()

Specified by:

round in class Value<java.lang.Float>

ceiling

public FloatValue ceiling()

Specified by:

ceiling in class Value<java.lang.Float>

floor

public FloatValue floor()

Specified by:

floor in class Value<java.lang.Float>

normalize

public FloatValue normalize(java.lang.Number leftOrig,
                            java.lang.Number leftNorm,
                            java.lang.Number rightOrig,
                            java.lang.Number rightNorm)

Specified by:

normalize in class Value<java.lang.Float>

denormalize

public FloatValue denormalize(java.lang.Number leftOrig,
                              java.lang.Number leftNorm,
                              java.lang.Number rightOrig,
                              java.lang.Number rightNorm)

Specified by:

denormalize in class Value<java.lang.Float>

isZero

public boolean isZero()

Specified by:

isZero in class Value<java.lang.Float>

isOne

public boolean isOne()

Specified by:

isOne in class Value<java.lang.Float>

equals

public boolean equals(java.lang.Number value)

Specified by:

equals in class Value<java.lang.Float>

compareTo

public int compareTo(java.lang.Number value)

Specified by:

compareTo in class Value<java.lang.Float>

floatValue

public float floatValue()

Specified by:

floatValue in class Value<java.lang.Float>

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Value<java.lang.Float>

getValue

public java.lang.Float getValue()

Specified by:

getValue in class Value<java.lang.Float>

exp

public static float exp(float value)

Computes exp(float).

The function exp(float) can be reasonably emulated as (float)Math#pow(2.7182817d, double). The constant 2.7182817d has to be hard-coded as double literal, because a float value (which could be either hard-coded as float literal or computed as (float)Math#E) would be promoted to a double value 2.7182817459106445d (via a widening primitive conversion) by the method invocation expression.

pow

public static float pow(float value,
                        float power)