Class PrimitiveFunction

java.lang.Object

org.ojalgo.function.FunctionSet<Double>

org.ojalgo.function.PrimitiveFunction

public final class PrimitiveFunction
extends FunctionSet<Double>

Only the primitive parameter (double) methods are actually implemented. The methods with the reference type parameters (Double) should delegate to the primitive methods (and do nothing else). The various implementations should delegate as much as possible to Math and/or built-in Java operators.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PrimitiveFunction.Binary
static interface	PrimitiveFunction.Consumer
static interface	PrimitiveFunction.Nullary
static interface	PrimitiveFunction.Parameter
static interface	PrimitiveFunction.Predicate
static final class	PrimitiveFunction.SampleDomain
static interface	PrimitiveFunction.Unary

Field Summary

Fields

Modifier and Type	Field	Description
private static final PrimitiveFunction	SET

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PrimitiveFunction()

Method Summary

Modifier and Type	Method	Description
UnaryFunction<Double>	abs()
UnaryFunction<Double>	acos()
UnaryFunction<Double>	acosh()
BinaryFunction<Double>	add()	+
AggregatorSet<Double>	aggregator()
UnaryFunction<Double>	asin()
UnaryFunction<Double>	asinh()
UnaryFunction<Double>	atan()
BinaryFunction<Double>	atan2()
UnaryFunction<Double>	atanh()
UnaryFunction<Double>	cardinality()
UnaryFunction<Double>	cbrt()
UnaryFunction<Double>	ceil()
UnaryFunction<Double>	conjugate()
UnaryFunction<Double>	cos()
UnaryFunction<Double>	cosh()
BinaryFunction<Double>	divide()	/
PrimitiveFunction.Unary	enforce(NumberContext context)
UnaryFunction<Double>	exp()
UnaryFunction<Double>	expm1()
UnaryFunction<Double>	floor()
static PrimitiveFunction	getSet()
BinaryFunction<Double>	hypot()
UnaryFunction<Double>	invert()
UnaryFunction<Double>	log()
UnaryFunction<Double>	log10()
UnaryFunction<Double>	log1p()
UnaryFunction<Double>	logistic()	Standard logistic sigmoid function
UnaryFunction<Double>	logit()
BinaryFunction<Double>	max()
BinaryFunction<Double>	min()
BinaryFunction<Double>	multiply()	*
UnaryFunction<Double>	negate()
static PrimitiveFunction.Nullary	nullary(double value)
BinaryFunction<Double>	pow()
ParameterFunction<Double>	power()
UnaryFunction<Double>	rint()
ParameterFunction<Double>	root()
ParameterFunction<Double>	scale()
UnaryFunction<Double>	signum()
UnaryFunction<Double>	sin()
UnaryFunction<Double>	sinh()
UnaryFunction<Double>	sqrt()
UnaryFunction<Double>	sqrt1px2()
BinaryFunction<Double>	subtract()	-
UnaryFunction<Double>	tan()
UnaryFunction<Double>	tanh()
UnaryFunction<Double>	value()

Methods inherited from class Object

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

Field Details

SET

private static final PrimitiveFunction SET

Constructor Details

PrimitiveFunction

private PrimitiveFunction()

Method Details

getSet

public static PrimitiveFunction getSet()

nullary

public static PrimitiveFunction.Nullary nullary(double value)

abs

public UnaryFunction<Double> abs()

Specified by:

abs in class FunctionSet<Double>

See Also:

• Math.abs(double)

acos

public UnaryFunction<Double> acos()

Specified by:

acos in class FunctionSet<Double>

See Also:

• Math.acos(double)

acosh

public UnaryFunction<Double> acosh()

Specified by:

acosh in class FunctionSet<Double>

add

public BinaryFunction<Double> add()

Description copied from class: FunctionSet

+

Specified by:

add in class FunctionSet<Double>

aggregator

public AggregatorSet<Double> aggregator()

Specified by:

aggregator in class FunctionSet<Double>

asin

public UnaryFunction<Double> asin()

Specified by:

asin in class FunctionSet<Double>

See Also:

• Math.asin(double)

asinh

public UnaryFunction<Double> asinh()

Specified by:

asinh in class FunctionSet<Double>

atan

public UnaryFunction<Double> atan()

Specified by:

atan in class FunctionSet<Double>

See Also:

• Math.atan(double)

atan2

public BinaryFunction<Double> atan2()

Specified by:

atan2 in class FunctionSet<Double>

See Also:

• Math.atan2(double,double)

atanh

public UnaryFunction<Double> atanh()

Specified by:

atanh in class FunctionSet<Double>

cardinality

public UnaryFunction<Double> cardinality()

Specified by:

cardinality in class FunctionSet<Double>

cbrt

public UnaryFunction<Double> cbrt()

Specified by:

cbrt in class FunctionSet<Double>

See Also:

• Math.cbrt(double)

ceil

public UnaryFunction<Double> ceil()

Specified by:

ceil in class FunctionSet<Double>

See Also:

• Math.ceil(double)

conjugate

public UnaryFunction<Double> conjugate()

Specified by:

conjugate in class FunctionSet<Double>

cos

public UnaryFunction<Double> cos()

Specified by:

cos in class FunctionSet<Double>

See Also:

• Math.cos(double)

cosh

public UnaryFunction<Double> cosh()

Specified by:

cosh in class FunctionSet<Double>

See Also:

• Math.cosh(double)

divide

public BinaryFunction<Double> divide()

Description copied from class: FunctionSet

/

Specified by:

divide in class FunctionSet<Double>

enforce

public PrimitiveFunction.Unary enforce(NumberContext context)

Specified by:

enforce in class FunctionSet<Double>

exp

public UnaryFunction<Double> exp()

Specified by:

exp in class FunctionSet<Double>

See Also:

• Math.exp(double)

expm1

public UnaryFunction<Double> expm1()

Specified by:

expm1 in class FunctionSet<Double>

See Also:

• Math.expm1(double)

floor

public UnaryFunction<Double> floor()

Specified by:

floor in class FunctionSet<Double>

See Also:

• Math.floor(double)

hypot

public BinaryFunction<Double> hypot()

Specified by:

hypot in class FunctionSet<Double>

See Also:

• Math.hypot(double, double)

invert

public UnaryFunction<Double> invert()

Specified by:

invert in class FunctionSet<Double>

log

public UnaryFunction<Double> log()

Specified by:

log in class FunctionSet<Double>

See Also:

• Math.log(double)

log10

public UnaryFunction<Double> log10()

Specified by:

log10 in class FunctionSet<Double>

See Also:

• Math.log10(double)

log1p

public UnaryFunction<Double> log1p()

Specified by:

log1p in class FunctionSet<Double>

See Also:

• Math.log1p(double)

logistic

public UnaryFunction<Double> logistic()

Description copied from class: FunctionSet

Standard logistic sigmoid function

Specified by:

logistic in class FunctionSet<Double>

logit

public UnaryFunction<Double> logit()

Specified by:

logit in class FunctionSet<Double>

max

public BinaryFunction<Double> max()

Specified by:

max in class FunctionSet<Double>

See Also:

• Math.max(double, double)

min

public BinaryFunction<Double> min()

Specified by:

min in class FunctionSet<Double>

See Also:

• Math.min(double, double)

multiply

public BinaryFunction<Double> multiply()

Description copied from class: FunctionSet

*

Specified by:

multiply in class FunctionSet<Double>

negate

public UnaryFunction<Double> negate()

Specified by:

negate in class FunctionSet<Double>

pow

public BinaryFunction<Double> pow()

Specified by:

pow in class FunctionSet<Double>

See Also:

• Math.pow(double, double)

power

public ParameterFunction<Double> power()

Specified by:

power in class FunctionSet<Double>

rint

public UnaryFunction<Double> rint()

Specified by:

rint in class FunctionSet<Double>

See Also:

• Math.rint(double)

root

public ParameterFunction<Double> root()

Specified by:

root in class FunctionSet<Double>

scale

public ParameterFunction<Double> scale()

Specified by:

scale in class FunctionSet<Double>

signum

public UnaryFunction<Double> signum()

Specified by:

signum in class FunctionSet<Double>

See Also:

• Math.signum(double)

sin

public UnaryFunction<Double> sin()

Specified by:

sin in class FunctionSet<Double>

See Also:

• Math.sin(double)

sinh

public UnaryFunction<Double> sinh()

Specified by:

sinh in class FunctionSet<Double>

See Also:

• Math.sinh(double)

sqrt

public UnaryFunction<Double> sqrt()

Specified by:

sqrt in class FunctionSet<Double>

See Also:

• Math.sqrt(double)

sqrt1px2

public UnaryFunction<Double> sqrt1px2()

Specified by:

sqrt1px2 in class FunctionSet<Double>

Returns:

sqrt(1.0 + x²)

subtract

public BinaryFunction<Double> subtract()

Description copied from class: FunctionSet

-

Specified by:

subtract in class FunctionSet<Double>

tan

public UnaryFunction<Double> tan()

Specified by:

tan in class FunctionSet<Double>

See Also:

• Math.tan(double)

tanh

public UnaryFunction<Double> tanh()

Specified by:

tanh in class FunctionSet<Double>

See Also:

• Math.tanh(double)

value

public UnaryFunction<Double> value()

Specified by:

value in class FunctionSet<Double>