BigFunction (ojAlgo 47.2.0 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.Consumer`
`static interface`	`BigFunction.Parameter`
`static interface`	`BigFunction.Predicate`
`static interface`	`BigFunction.Unary`

Field Summary

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

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()` Standard logistic sigmoid function
`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
```
@Deprecated
public static final BigFunction.Unary ABS
```
    Deprecated. v48 Use BigMath.ABS instead
  - ACOS
```
@Deprecated
public static final BigFunction.Unary ACOS
```
    Deprecated. v48 Use BigMath.ACOS instead
  - ACOSH
```
@Deprecated
public static final BigFunction.Unary ACOSH
```
    Deprecated. v48 Use BigMath.ACOSH instead
  - ADD
```
@Deprecated
public static final BigFunction.Binary ADD
```
    Deprecated. v48 Use BigMath.ADD instead
  - ASIN
```
@Deprecated
public static final BigFunction.Unary ASIN
```
    Deprecated. v48 Use BigMath.ASIN instead
  - ASINH
```
@Deprecated
public static final BigFunction.Unary ASINH
```
    Deprecated. v48 Use BigMath.ASINH instead
  - ATAN
```
@Deprecated
public static final BigFunction.Unary ATAN
```
    Deprecated. v48 Use BigMath.ATAN instead
  - ATAN2
```
@Deprecated
public static final BigFunction.Binary ATAN2
```
    Deprecated. v48 Use BigMath.ATAN2 instead
  - ATANH
```
@Deprecated
public static final BigFunction.Unary ATANH
```
    Deprecated. v48 Use BigMath.ATANH instead
  - CARDINALITY
```
@Deprecated
public static final BigFunction.Unary CARDINALITY
```
    Deprecated. v48 Use BigMath.CARDINALITY instead
  - CBRT
```
@Deprecated
public static final BigFunction.Unary CBRT
```
    Deprecated. v48 Use BigMath.CBRT instead
  - CEIL
```
@Deprecated
public static final BigFunction.Unary CEIL
```
    Deprecated. v48 Use BigMath.CEIL instead
  - CONJUGATE
```
@Deprecated
public static final BigFunction.Unary CONJUGATE
```
    Deprecated. v48 Use BigMath.CONJUGATE instead
  - COS
```
@Deprecated
public static final BigFunction.Unary COS
```
    Deprecated. v48 Use BigMath.COS instead
  - COSH
```
@Deprecated
public static final BigFunction.Unary COSH
```
    Deprecated. v48 Use BigMath.COSH instead
  - DIVIDE
```
@Deprecated
public static final BigFunction.Binary DIVIDE
```
    Deprecated. v48 Use BigMath.DIVIDE instead
  - EXP
```
@Deprecated
public static final BigFunction.Unary EXP
```
    Deprecated. v48 Use BigMath.EXP instead
  - EXPM1
```
@Deprecated
public static final BigFunction.Unary EXPM1
```
    Deprecated. v48 Use BigMath.EXPM1 instead
  - FLOOR
```
@Deprecated
public static final BigFunction.Unary FLOOR
```
    Deprecated. v48 Use BigMath.FLOOR instead
  - HYPOT
```
@Deprecated
public static final BigFunction.Binary HYPOT
```
    Deprecated. v48 Use BigMath.HYPOT instead
  - INVERT
```
@Deprecated
public static final BigFunction.Unary INVERT
```
    Deprecated. v48 Use BigMath.INVERT instead
  - LOG
```
@Deprecated
public static final BigFunction.Unary LOG
```
    Deprecated. v48 Use BigMath.LOG instead
  - LOG10
```
@Deprecated
public static final BigFunction.Unary LOG10
```
    Deprecated. v48 Use BigMath.LOG10 instead
  - LOG1P
```
@Deprecated
public static final BigFunction.Unary LOG1P
```
    Deprecated. v48 Use BigMath.LOG1P instead
  - LOGISTIC
```
@Deprecated
public static final BigFunction.Unary LOGISTIC
```
    Deprecated. v48 Use BigMath.LOGISTIC instead
  - LOGIT
```
@Deprecated
public static final BigFunction.Unary LOGIT
```
    Deprecated. v48 Use BigMath.LOGIT instead
  - MAX
```
@Deprecated
public static final BigFunction.Binary MAX
```
    Deprecated. v48 Use BigMath.MAX instead
  - MIN
```
@Deprecated
public static final BigFunction.Binary MIN
```
    Deprecated. v48 Use BigMath.MIN instead
  - MULTIPLY
```
@Deprecated
public static final BigFunction.Binary MULTIPLY
```
    Deprecated. v48 Use BigMath.MULTIPLY instead
  - NEGATE
```
@Deprecated
public static final BigFunction.Unary NEGATE
```
    Deprecated. v48 Use BigMath.NEGATE instead
  - POW
```
@Deprecated
public static final BigFunction.Binary POW
```
    Deprecated. v48 Use BigMath.POW instead
  - POWER
```
@Deprecated
public static final BigFunction.Parameter POWER
```
    Deprecated. v48 Use BigMath.POWER instead
  - RINT
```
@Deprecated
public static final BigFunction.Unary RINT
```
    Deprecated. v48 Use BigMath.RINT instead
  - ROOT
```
@Deprecated
public static final BigFunction.Parameter ROOT
```
    Deprecated. v48 Use BigMath.ROOT instead
  - SCALE
```
@Deprecated
public static final BigFunction.Parameter SCALE
```
    Deprecated. v48 Use BigMath.SCALE instead
  - SIGNUM
```
@Deprecated
public static final BigFunction.Unary SIGNUM
```
    Deprecated. v48 Use BigMath.SIGNUM instead
  - SIN
```
@Deprecated
public static final BigFunction.Unary SIN
```
    Deprecated. v48 Use BigMath.SIN instead
  - SINH
```
@Deprecated
public static final BigFunction.Unary SINH
```
    Deprecated. v48 Use BigMath.SINH instead
  - SQRT
```
@Deprecated
public static final BigFunction.Unary SQRT
```
    Deprecated. v48 Use BigMath.SQRT instead
  - SQRT1PX2
```
@Deprecated
public static final BigFunction.Unary SQRT1PX2
```
    Deprecated. v48 Use BigMath.SQRT1PX2 instead
  - SUBTRACT
```
@Deprecated
public static final BigFunction.Binary SUBTRACT
```
    Deprecated. v48 Use BigMath.SUBTRACT instead
  - TAN
```
@Deprecated
public static final BigFunction.Unary TAN
```
    Deprecated. v48 Use BigMath.TAN instead
  - TANH
```
@Deprecated
public static final BigFunction.Unary TANH
```
    Deprecated. v48 Use BigMath.TANH instead
  - VALUE
```
@Deprecated
public static final BigFunction.Unary VALUE
```
    Deprecated. v48 Use BigMath.VALUE instead
- 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()
```
    Description copied from class: FunctionSet
    
    Standard logistic sigmoid function
    
    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