BigFunction (ojAlgo 45.1.1 API)

java.lang.Object
- org.ojalgo.function.FunctionSet<BigDecimal>
- - org.ojalgo.function.BigFunction

```
public final class BigFunction
extends FunctionSet<BigDecimal>
```
Only the reference type parameter (BigDecimal) methods are actually implemented. The methods with the primitive parameters (double) should create a BigDecimal and then delegate to the primitive methods (and do nothing else). If possible the implementations should be pure BigDecimal arithmatic without rounding. If rounding is necessary MathContext.DECIMAL128 should be used. If BigDecimal arithmatic is not possible at all the implementation should delegate to PrimitiveFunction.

Author:

apete

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BigFunction.Binary

static interface BigFunction.Parameter

static interface BigFunction.Unary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BigFunction.Binary`
`static interface`	`BigFunction.Parameter`
`static interface`	`BigFunction.Unary`

Field Summary

Fields
Modifier and Type	Field and Description
`static BigFunction.Unary`	`ABS`
`static BigFunction.Unary`	`ACOS`
`static BigFunction.Unary`	`ACOSH`
`static BigFunction.Binary`	`ADD`
`static BigFunction.Unary`	`ASIN`
`static BigFunction.Unary`	`ASINH`
`static BigFunction.Unary`	`ATAN`
`static BigFunction.Binary`	`ATAN2`
`static BigFunction.Unary`	`ATANH`
`static BigFunction.Unary`	`CARDINALITY`
`static BigFunction.Unary`	`CBRT`
`static BigFunction.Unary`	`CEIL`
`static BigFunction.Unary`	`CONJUGATE`
`static BigFunction.Unary`	`COS`
`static BigFunction.Unary`	`COSH`
`static BigFunction.Binary`	`DIVIDE`
`static BigFunction.Unary`	`EXP`
`static BigFunction.Unary`	`EXPM1`
`static BigFunction.Unary`	`FLOOR`
`static BigFunction.Binary`	`HYPOT`
`static BigFunction.Unary`	`INVERT`
`static BigFunction.Unary`	`LOG`
`static BigFunction.Unary`	`LOG10`
`static BigFunction.Unary`	`LOG1P`
`static BigFunction.Unary`	`LOGISTIC`
`static BigFunction.Unary`	`LOGIT`
`static BigFunction.Binary`	`MAX`
`static BigFunction.Binary`	`MIN`
`static BigFunction.Binary`	`MULTIPLY`
`static BigFunction.Unary`	`NEGATE`
`static BigFunction.Binary`	`POW`
`static BigFunction.Parameter`	`POWER`
`static BigFunction.Unary`	`RINT`
`static BigFunction.Parameter`	`ROOT`
`static BigFunction.Parameter`	`SCALE`
`static BigFunction.Unary`	`SIGNUM`
`static BigFunction.Unary`	`SIN`
`static BigFunction.Unary`	`SINH`
`static BigFunction.Unary`	`SQRT`
`static BigFunction.Unary`	`SQRT1PX2`
`static BigFunction.Binary`	`SUBTRACT`
`static BigFunction.Unary`	`TAN`
`static BigFunction.Unary`	`TANH`
`static BigFunction.Unary`	`VALUE`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ABS

public static final BigFunction.Unary ABS

ACOS

public static final BigFunction.Unary ACOS

ACOSH

public static final BigFunction.Unary ACOSH

ADD

public static final BigFunction.Binary ADD

ASIN

public static final BigFunction.Unary ASIN

ASINH

public static final BigFunction.Unary ASINH

ATAN

public static final BigFunction.Unary ATAN

ATAN2

public static final BigFunction.Binary ATAN2

ATANH

public static final BigFunction.Unary ATANH

CARDINALITY

public static final BigFunction.Unary CARDINALITY

CBRT

public static final BigFunction.Unary CBRT

CEIL

public static final BigFunction.Unary CEIL

CONJUGATE

public static final BigFunction.Unary CONJUGATE

COS

public static final BigFunction.Unary COS

COSH

public static final BigFunction.Unary COSH

DIVIDE

public static final BigFunction.Binary DIVIDE

EXP

public static final BigFunction.Unary EXP

EXPM1

public static final BigFunction.Unary EXPM1

FLOOR

public static final BigFunction.Unary FLOOR

HYPOT

public static final BigFunction.Binary HYPOT

INVERT

public static final BigFunction.Unary INVERT

LOG

public static final BigFunction.Unary LOG

LOG10

public static final BigFunction.Unary LOG10

LOG1P

public static final BigFunction.Unary LOG1P

LOGISTIC

public static final BigFunction.Unary LOGISTIC

LOGIT

public static final BigFunction.Unary LOGIT

MAX

public static final BigFunction.Binary MAX

MIN

public static final BigFunction.Binary MIN

MULTIPLY

public static final BigFunction.Binary MULTIPLY

NEGATE

public static final BigFunction.Unary NEGATE

POW

public static final BigFunction.Binary POW

POWER

public static final BigFunction.Parameter POWER

RINT

public static final BigFunction.Unary RINT

ROOT

public static final BigFunction.Parameter ROOT

SCALE

public static final BigFunction.Parameter SCALE

SIGNUM

public static final BigFunction.Unary SIGNUM

SIN

public static final BigFunction.Unary SIN

SINH

public static final BigFunction.Unary SINH

SQRT

public static final BigFunction.Unary SQRT

SQRT1PX2

public static final BigFunction.Unary SQRT1PX2

SUBTRACT

public static final BigFunction.Binary SUBTRACT

TAN

public static final BigFunction.Unary TAN

TANH

public static final BigFunction.Unary TANH

VALUE

public static final BigFunction.Unary VALUE

Method Detail
- getSet
```
public static BigFunction getSet()
```
- abs
```
public UnaryFunction<BigDecimal> abs()
```
  Specified by:
  
  abs in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.abs(double)
- acos
```
public UnaryFunction<BigDecimal> acos()
```
  Specified by:
  
  acos in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.acos(double)
- acosh
```
public UnaryFunction<BigDecimal> acosh()
```
  Specified by:
  
  acosh in class FunctionSet<BigDecimal>
- add
```
public BinaryFunction<BigDecimal> add()
```
  Description copied from class: FunctionSet
  
  +
  
  Specified by:
  
  add in class FunctionSet<BigDecimal>
- aggregator
```
public AggregatorSet<BigDecimal> aggregator()
```
  Specified by:
  
  aggregator in class FunctionSet<BigDecimal>
- asin
```
public UnaryFunction<BigDecimal> asin()
```
  Specified by:
  
  asin in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.asin(double)
- asinh
```
public UnaryFunction<BigDecimal> asinh()
```
  Specified by:
  
  asinh in class FunctionSet<BigDecimal>
- atan
```
public UnaryFunction<BigDecimal> atan()
```
  Specified by:
  
  atan in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.atan(double)
- atan2
```
public BinaryFunction<BigDecimal> atan2()
```
  Specified by:
  
  atan2 in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.atan2(double,double)
- atanh
```
public UnaryFunction<BigDecimal> atanh()
```
  Specified by:
  
  atanh in class FunctionSet<BigDecimal>
- cardinality
```
public UnaryFunction<BigDecimal> cardinality()
```
  Specified by:
  
  cardinality in class FunctionSet<BigDecimal>
- cbrt
```
public UnaryFunction<BigDecimal> cbrt()
```
  Specified by:
  
  cbrt in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.cbrt(double)
- ceil
```
public UnaryFunction<BigDecimal> ceil()
```
  Specified by:
  
  ceil in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.ceil(double)
- conjugate
```
public UnaryFunction<BigDecimal> conjugate()
```
  Specified by:
  
  conjugate in class FunctionSet<BigDecimal>
- cos
```
public UnaryFunction<BigDecimal> cos()
```
  Specified by:
  
  cos in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.cos(double)
- cosh
```
public UnaryFunction<BigDecimal> cosh()
```
  Specified by:
  
  cosh in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.cosh(double)
- divide
```
public BinaryFunction<BigDecimal> divide()
```
  Description copied from class: FunctionSet
  
  /
  
  Specified by:
  
  divide in class FunctionSet<BigDecimal>
- enforce
```
public BigFunction.Unary enforce(NumberContext context)
```
  Specified by:
  
  enforce in class FunctionSet<BigDecimal>
- exp
```
public UnaryFunction<BigDecimal> exp()
```
  Specified by:
  
  exp in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.exp(double)
- expm1
```
public UnaryFunction<BigDecimal> expm1()
```
  Specified by:
  
  expm1 in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.expm1(double)
- floor
```
public UnaryFunction<BigDecimal> floor()
```
  Specified by:
  
  floor in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.floor(double)
- hypot
```
public BinaryFunction<BigDecimal> hypot()
```
  Specified by:
  
  hypot in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.hypot(double, double)
- invert
```
public UnaryFunction<BigDecimal> invert()
```
  Specified by:
  
  invert in class FunctionSet<BigDecimal>
- log
```
public UnaryFunction<BigDecimal> log()
```
  Specified by:
  
  log in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.log(double)
- log10
```
public UnaryFunction<BigDecimal> log10()
```
  Specified by:
  
  log10 in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.log10(double)
- log1p
```
public UnaryFunction<BigDecimal> log1p()
```
  Specified by:
  
  log1p in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.log1p(double)
- logistic
```
public UnaryFunction<BigDecimal> logistic()
```
  Specified by:
  
  logistic in class FunctionSet<BigDecimal>
- logit
```
public UnaryFunction<BigDecimal> logit()
```
  Specified by:
  
  logit in class FunctionSet<BigDecimal>
- max
```
public BinaryFunction<BigDecimal> max()
```
  Specified by:
  
  max in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.max(double, double)
- min
```
public BinaryFunction<BigDecimal> min()
```
  Specified by:
  
  min in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.min(double, double)
- multiply
```
public BinaryFunction<BigDecimal> multiply()
```
  Description copied from class: FunctionSet
  
  *
  
  Specified by:
  
  multiply in class FunctionSet<BigDecimal>
- negate
```
public UnaryFunction<BigDecimal> negate()
```
  Specified by:
  
  negate in class FunctionSet<BigDecimal>
- pow
```
public BinaryFunction<BigDecimal> pow()
```
  Specified by:
  
  pow in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.pow(double, double)
- power
```
public ParameterFunction<BigDecimal> power()
```
  Specified by:
  
  power in class FunctionSet<BigDecimal>
- rint
```
public UnaryFunction<BigDecimal> rint()
```
  Specified by:
  
  rint in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.rint(double)
- root
```
public ParameterFunction<BigDecimal> root()
```
  Specified by:
  
  root in class FunctionSet<BigDecimal>
- scale
```
public ParameterFunction<BigDecimal> scale()
```
  Specified by:
  
  scale in class FunctionSet<BigDecimal>
- signum
```
public UnaryFunction<BigDecimal> signum()
```
  Specified by:
  
  signum in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.signum(double)
- sin
```
public UnaryFunction<BigDecimal> sin()
```
  Specified by:
  
  sin in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.sin(double)
- sinh
```
public UnaryFunction<BigDecimal> sinh()
```
  Specified by:
  
  sinh in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.sinh(double)
- sqrt
```
public UnaryFunction<BigDecimal> sqrt()
```
  Specified by:
  
  sqrt in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.sqrt(double)
- sqrt1px2
```
public UnaryFunction<BigDecimal> sqrt1px2()
```
  Specified by:
  
  sqrt1px2 in class FunctionSet<BigDecimal>
  
  Returns:
  
  sqrt(1.0 + x²)
- subtract
```
public BinaryFunction<BigDecimal> subtract()
```
  Description copied from class: FunctionSet
  
  -
  
  Specified by:
  
  subtract in class FunctionSet<BigDecimal>
- tan
```
public UnaryFunction<BigDecimal> tan()
```
  Specified by:
  
  tan in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.tan(double)
- tanh
```
public UnaryFunction<BigDecimal> tanh()
```
  Specified by:
  
  tanh in class FunctionSet<BigDecimal>
  
  See Also:
  
  Math.tanh(double)
- value
```
public UnaryFunction<BigDecimal> value()
```
  Specified by:
  
  value in class FunctionSet<BigDecimal>

Class BigFunction

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ABS

ACOS

ACOSH

ADD

ASIN

ASINH

ATAN

ATAN2

ATANH

CARDINALITY

CBRT

CEIL

CONJUGATE

COS

COSH

DIVIDE

EXP

EXPM1

FLOOR

HYPOT

INVERT

LOG

LOG10

LOG1P

LOGISTIC

LOGIT

MAX

MIN

MULTIPLY

NEGATE

POW

POWER

RINT

ROOT

SCALE

SIGNUM

SIN

SINH

SQRT

SQRT1PX2

SUBTRACT

TAN

TANH

VALUE

Method Detail

getSet

abs

acos

acosh

add

aggregator

asin

asinh

atan

atan2

atanh

cardinality

cbrt

ceil

conjugate

cos

cosh

divide

enforce

exp

expm1

floor

hypot

invert

log

log10

log1p

logistic

logit