Package org.jpmml.evaluator

Class Value<V extends java.lang.Number>

java.lang.Object

org.jpmml.evaluator.Value<V>

All Implemented Interfaces:

java.lang.Comparable<Value<V>>

Direct Known Subclasses:

DoubleValue, FloatValue

public abstract class Value<V extends java.lang.Number>
extends java.lang.Object
implements java.lang.Comparable<Value<V>>

Constructor Summary

Constructors

Constructor	Description
Value()

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

Value

public Value()

Method Detail

copy

public abstract Value<V> copy()

reset

public abstract Value<V> reset(java.lang.Number value)

add

public abstract Value<V> add(java.lang.Number value)

add

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

add

public abstract Value<V> add(java.lang.Number coefficient,
                             java.lang.Number factor)

Adds coefficient * factor.

add

public abstract Value<V> add(java.lang.Number coefficient,
                             java.lang.Number firstFactor,
                             java.lang.Number secondFactor)

add

public abstract Value<V> add(java.lang.Number coefficient,
                             java.lang.Number... factors)

Adds coefficient * product(factors).

add

public abstract Value<V> add(java.lang.Number coefficient,
                             java.lang.Number factor,
                             int exponent)

Adds coefficient * (factor ^ exponent).

subtract

public abstract Value<V> subtract(java.lang.Number value)

subtract

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

multiply

public abstract Value<V> multiply(java.lang.Number value)

multiply

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

multiply

public abstract Value<V> multiply(java.lang.Number factor,
                                  java.lang.Number exponent)

Multiplies by factor ^ exponent.

divide

public abstract Value<V> divide(java.lang.Number value)

divide

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

residual

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

square

public abstract Value<V> square()

power

public abstract Value<V> power(java.lang.Number value)

reciprocal

public abstract Value<V> reciprocal()

elliott

public abstract Value<V> elliott()

exp

public abstract Value<V> exp()

ln

public abstract Value<V> ln()

gauss

public abstract Value<V> gauss()

inverseLogit

public abstract Value<V> inverseLogit()

inverseCloglog

public abstract Value<V> inverseCloglog()

inverseLoglog

public abstract Value<V> inverseLoglog()

inverseLogc

public abstract Value<V> inverseLogc()

inverseNegbin

public abstract Value<V> inverseNegbin(java.lang.Number value)

inverseOddspower

public abstract Value<V> inverseOddspower(java.lang.Number value)

inversePower

public abstract Value<V> inversePower(java.lang.Number value)

inverseCauchit

public abstract Value<V> inverseCauchit()

inverseProbit

public abstract Value<V> inverseProbit()

sin

public abstract Value<V> sin()

cos

public abstract Value<V> cos()

arctan

public abstract Value<V> arctan()

tanh

public abstract Value<V> tanh()

threshold

public abstract Value<V> threshold(java.lang.Number value)

relu

public abstract Value<V> relu()

abs

public abstract Value<V> abs()

gaussSim

public abstract Value<V> gaussSim(java.lang.Number value)

restrict

public abstract Value<V> restrict(java.lang.Number lowValue,
                                  java.lang.Number highValue)

round

public abstract Value<V> round()

ceiling

public abstract Value<V> ceiling()

floor

public abstract Value<V> floor()

normalize

public abstract Value<V> normalize(java.lang.Number leftOrig,
                                   java.lang.Number leftNorm,
                                   java.lang.Number rightOrig,
                                   java.lang.Number rightNorm)

denormalize

public abstract Value<V> denormalize(java.lang.Number leftOrig,
                                     java.lang.Number leftNorm,
                                     java.lang.Number rightOrig,
                                     java.lang.Number rightNorm)

isZero

public abstract boolean isZero()

isOne

public abstract boolean isOne()

equals

public abstract boolean equals(java.lang.Number value)

compareTo

public abstract int compareTo(java.lang.Number value)

floatValue

public abstract float floatValue()

doubleValue

public abstract double doubleValue()

getValue

public abstract V getValue()