Apache Commons Math 3.6.1 · org.apache.commons.math3.RealFieldElement

Method Summary

Modifier and Type	Method and Description
public T	Returns: abs(this) abs() absolute value.
public T	Returns: acos(this) acos() Arc cosine operation.
public T	Returns: acosh(this) acosh() Inverse hyperbolic cosine operation.
public T	Returns: this+a add(double right hand side parameter of the operator a) Redeclares org.apache.commons.math3.FieldElement.add. '+' operator.
public T	Returns: asin(this) asin() Arc sine operation.
public T	Returns: asin(this) asinh() Inverse hyperbolic sine operation.
public T	Returns: atan(this) atan() Arc tangent operation.
public T	Returns: atan2(this, x) atan2(T second argument of the arc tangent x) Two arguments arc tangent operation.
public T	Returns: atanh(this) atanh() Inverse hyperbolic tangent operation.
public T	Returns: cubic root of the instance cbrt() Cubic root.
public T	Returns: ceil(this) ceil() Get the smallest whole number larger than instance.
public T	Returns: the instance with the same sign as the `sign` argument copySign(T the sign for the returned value sign) Returns the instance with the sign of the argument.
public T	Returns: the instance with the same sign as the `sign` argument copySign(double the sign for the returned value sign) Returns the instance with the sign of the argument.
public T	Returns: cos(this) cos() Cosine operation.
public T	Returns: cosh(this) cosh() Hyperbolic cosine operation.
public T	Returns: this÷a divide(double right hand side parameter of the operator a) Redeclares org.apache.commons.math3.FieldElement.divide. '÷' operator.
public T	Returns: exponential of the instance exp() Exponential.
public T	Returns: exponential minus one of the instance expm1() Exponential minus 1.
public T	Returns: floor(this) floor() Get the largest whole number smaller than instance.
public double	Returns: real value getReal() Get the real value of the number.
public T	Returns: sqrt(this² +y²) hypot(T a value y) Returns the hypotenuse of a triangle with sides `this` and `y` - sqrt(this² +y²) avoiding intermediate overflow or underflow.
public T	Returns: `Σ_i a_i b_i`. linearCombination(T[] Factors. a, T[] Factors. b) Compute a linear combination.
public T	Returns: `Σ_i a_i b_i`. linearCombination(double[] Factors. a, T[] Factors. b) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ linearCombination(T first factor of the first term a1, T second factor of the first term b1, T first factor of the second term a2, T second factor of the second term b2) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ linearCombination(double first factor of the first term a1, T second factor of the first term b1, double first factor of the second term a2, T second factor of the second term b2) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ + a₃×b₃ linearCombination(T first factor of the first term a1, T second factor of the first term b1, T first factor of the second term a2, T second factor of the second term b2, T first factor of the third term a3, T second factor of the third term b3) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ + a₃×b₃ linearCombination(double first factor of the first term a1, T second factor of the first term b1, double first factor of the second term a2, T second factor of the second term b2, double first factor of the third term a3, T second factor of the third term b3) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄ linearCombination(T first factor of the first term a1, T second factor of the first term b1, T first factor of the second term a2, T second factor of the second term b2, T first factor of the third term a3, T second factor of the third term b3, T first factor of the third term a4, T second factor of the third term b4) Compute a linear combination.
public T	Returns: a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄ linearCombination(double first factor of the first term a1, T second factor of the first term b1, double first factor of the second term a2, T second factor of the second term b2, double first factor of the third term a3, T second factor of the third term b3, double first factor of the third term a4, T second factor of the third term b4) Compute a linear combination.
public T	Returns: logarithm of the instance log() Natural logarithm.
public T	Returns: logarithm of one plus the instance log1p() Shifted natural logarithm.
public T	Returns: this×a multiply(double right hand side parameter of the operator a) Redeclares org.apache.commons.math3.FieldElement.multiply. '×' operator.
public T	Returns: this^p pow(double power to apply p) Power operation.
public T	Returns: thisⁿ pow(int power to apply n) Integer power operation.
public T	Returns: this^e pow(T exponent e) Power operation.
public T	reciprocal() Redeclares org.apache.commons.math3.FieldElement.reciprocal. Returns the multiplicative inverse of `this` element.
public T	Returns: this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers) remainder(double right hand side parameter of the operator a) IEEE remainder operator.
public T	Returns: this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers) remainder(T right hand side parameter of the operator a) IEEE remainder operator.
public T	Returns: a double number r such that r is an integer r - 0.5 ≤ this ≤ r + 0.5 rint() Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers.
public T	Returns: n^th root of the instance rootN(int order of the root n) N^th root.
public long	Returns: closest long to `getReal()` round() Get the closest long to instance value.
public T	Returns: this × 2ⁿ scalb(int power of 2 n) Multiply the instance by a power of 2.
public T	Returns: -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a signum() Compute the signum of the instance.
public T	Returns: sin(this) sin() Sine operation.
public T	Returns: sinh(this) sinh() Hyperbolic sine operation.
public T	Returns: square root of the instance sqrt() Square root.
public T	Returns: this-a subtract(double right hand side parameter of the operator a) Redeclares org.apache.commons.math3.FieldElement.subtract. '-' operator.
public T	Returns: tan(this) tan() Tangent operation.
public T	Returns: tanh(this) tanh() Hyperbolic tangent operation.

Inherited from org.apache.commons.math3.FieldElement:: getField multiply negate

Method Detail

abs	back to summary
public T abs() absolute value. Returns:T abs(this)

abs

back to summary

public T abs()

absolute value.

Returns:T: abs(this)

acos	back to summary
public T acos() Arc cosine operation. Returns:T acos(this)

acos

back to summary

public T acos()

Arc cosine operation.

Returns:T: acos(this)

acosh	back to summary
public T acosh() Inverse hyperbolic cosine operation. Returns:T acosh(this)

acosh

back to summary

public T acosh()

Inverse hyperbolic cosine operation.

Returns:T: acosh(this)

add	back to summary
public T add(double a) Redeclares org.apache.commons.math3.FieldElement.add. '+' operator. Parameters a:double right hand side parameter of the operator Returns:T this+a

add

back to summary

public T add(double a)

Redeclares org.apache.commons.math3.FieldElement.add.

'+' operator.

Parameters

a:double: right hand side parameter of the operator

Returns:T

this+a

asin	back to summary
public T asin() Arc sine operation. Returns:T asin(this)

asin

back to summary

public T asin()

Arc sine operation.

Returns:T: asin(this)

asinh	back to summary
public T asinh() Inverse hyperbolic sine operation. Returns:T asin(this)

asinh

back to summary

public T asinh()

Inverse hyperbolic sine operation.

Returns:T: asin(this)

atan	back to summary
public T atan() Arc tangent operation. Returns:T atan(this)

atan

back to summary

public T atan()

Arc tangent operation.

Returns:T: atan(this)

atan2	back to summary
public T atan2(T x) throws DimensionMismatchException Two arguments arc tangent operation. Parameters x:T second argument of the arc tangent Returns:T atan2(this, x) Exceptions DimensionMismatchException: if number of free parameters or orders are inconsistent

atan2

back to summary

public T atan2(T x) throws DimensionMismatchException

Two arguments arc tangent operation.

Parameters

x:T: second argument of the arc tangent

Returns:T

atan2(this, x)

Exceptions

DimensionMismatchException:: if number of free parameters or orders are inconsistent

atanh	back to summary
public T atanh() Inverse hyperbolic tangent operation. Returns:T atanh(this)

atanh

back to summary

public T atanh()

Inverse hyperbolic tangent operation.

Returns:T: atanh(this)

cbrt	back to summary
public T cbrt() Cubic root. Returns:T cubic root of the instance

cbrt

back to summary

public T cbrt()

Cubic root.

Returns:T: cubic root of the instance

ceil	back to summary
public T ceil() Get the smallest whole number larger than instance. Returns:T ceil(this)

ceil

back to summary

public T ceil()

Get the smallest whole number larger than instance.

Returns:T: ceil(this)

copySign back to summary

copySign	back to summary
public T copySign(T sign) Returns the instance with the sign of the argument. A NaN `sign` argument is treated as positive. Parameters sign:T the sign for the returned value Returns:T the instance with the same sign as the `sign` argument

public T copySign(T sign)

Returns the instance with the sign of the argument. A NaN sign argument is treated as positive.

Parameters

sign:T: the sign for the returned value

Returns:T

the instance with the same sign as the sign argument

copySign back to summary

copySign	back to summary
public T copySign(double sign) Returns the instance with the sign of the argument. A NaN `sign` argument is treated as positive. Parameters sign:double the sign for the returned value Returns:T the instance with the same sign as the `sign` argument

public T copySign(double sign)

Returns the instance with the sign of the argument. A NaN sign argument is treated as positive.

Parameters

sign:double: the sign for the returned value

Returns:T

the instance with the same sign as the sign argument

cos	back to summary
public T cos() Cosine operation. Returns:T cos(this)

cos

back to summary

public T cos()

Cosine operation.

Returns:T: cos(this)

cosh	back to summary
public T cosh() Hyperbolic cosine operation. Returns:T cosh(this)

cosh

back to summary

public T cosh()

Hyperbolic cosine operation.

Returns:T: cosh(this)

divide	back to summary
public T divide(double a) Redeclares org.apache.commons.math3.FieldElement.divide. '÷' operator. Parameters a:double right hand side parameter of the operator Returns:T this÷a

divide

back to summary

public T divide(double a)

Redeclares org.apache.commons.math3.FieldElement.divide.

'÷' operator.

Parameters

a:double: right hand side parameter of the operator

Returns:T

this÷a

exp	back to summary
public T exp() Exponential. Returns:T exponential of the instance

exp

back to summary

public T exp()

Exponential.

Returns:T: exponential of the instance

expm1	back to summary
public T expm1() Exponential minus 1. Returns:T exponential minus one of the instance

expm1

back to summary

public T expm1()

Exponential minus 1.

Returns:T: exponential minus one of the instance

floor	back to summary
public T floor() Get the largest whole number smaller than instance. Returns:T floor(this)

floor

back to summary

public T floor()

Get the largest whole number smaller than instance.

Returns:T: floor(this)

getReal	back to summary
public double getReal() Get the real value of the number. Returns:double real value

getReal

back to summary

public double getReal()

Get the real value of the number.

Returns:double: real value

hypot back to summary

hypot	back to summary
public T hypot(T y) throws DimensionMismatchException Returns the hypotenuse of a triangle with sides `this` and `y` - sqrt(this² +y²) avoiding intermediate overflow or underflow. If either argument is infinite, then the result is positive infinity. else, if either argument is NaN then the result is NaN. Parameters y:T a value Returns:T sqrt(this² +y²) Exceptions DimensionMismatchException: if number of free parameters or orders are inconsistent

public T hypot(T y) throws DimensionMismatchException

Returns the hypotenuse of a triangle with sides this and y - sqrt(this² +y²) avoiding intermediate overflow or underflow.

If either argument is infinite, then the result is positive infinity.
else, if either argument is NaN then the result is NaN.

Parameters

y:T: a value

Returns:T

sqrt(this² +y²)

Exceptions

DimensionMismatchException:: if number of free parameters or orders are inconsistent

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(T[] a, T[] b) throws DimensionMismatchException Compute a linear combination. Parameters a:T[] Factors. b:T[] Factors. Returns:T `Σ_i a_i b_i`. Exceptions DimensionMismatchException: if arrays dimensions don't match Since 3.2

public T linearCombination(T[] a, T[] b) throws DimensionMismatchException

Compute a linear combination.

Parameters

a:T[]: Factors.
b:T[]: Factors.

Returns:T

Σ_i a_i b_i.

Exceptions

DimensionMismatchException:: if arrays dimensions don't match

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(double[] a, T[] b) throws DimensionMismatchException Compute a linear combination. Parameters a:double[] Factors. b:T[] Factors. Returns:T `Σ_i a_i b_i`. Exceptions DimensionMismatchException: if arrays dimensions don't match Since 3.2

public T linearCombination(double[] a, T[] b) throws DimensionMismatchException

Compute a linear combination.

Parameters

a:double[]: Factors.
b:T[]: Factors.

Returns:T

Σ_i a_i b_i.

Exceptions

DimensionMismatchException:: if arrays dimensions don't match

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(T a1, T b1, T a2, T b2) Compute a linear combination. Parameters a1:T first factor of the first term b1:T second factor of the first term a2:T first factor of the second term b2:T second factor of the second term Returns:T a₁×b₁ + a₂×b₂ Since 3.2 See Also `linearCombination(Object, Object, Object, Object, Object, Object)`, `linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)`

public T linearCombination(T a1, T b1, T a2, T b2)

Compute a linear combination.

Parameters

a1:T: first factor of the first term
b1:T: second factor of the first term
a2:T: first factor of the second term
b2:T: second factor of the second term

Returns:T

a₁×b₁ + a₂×b₂

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(double a1, T b1, double a2, T b2) Compute a linear combination. Parameters a1:double first factor of the first term b1:T second factor of the first term a2:double first factor of the second term b2:T second factor of the second term Returns:T a₁×b₁ + a₂×b₂ Since 3.2 See Also `linearCombination(double, Object, double, Object, double, Object)`, `linearCombination(double, Object, double, Object, double, Object, double, Object)`

public T linearCombination(double a1, T b1, double a2, T b2)

Compute a linear combination.

Parameters

a1:double: first factor of the first term
b1:T: second factor of the first term
a2:double: first factor of the second term
b2:T: second factor of the second term

Returns:T

a₁×b₁ + a₂×b₂

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3) Compute a linear combination. Parameters a1:T first factor of the first term b1:T second factor of the first term a2:T first factor of the second term b2:T second factor of the second term a3:T first factor of the third term b3:T second factor of the third term Returns:T a₁×b₁ + a₂×b₂ + a₃×b₃ Since 3.2 See Also `linearCombination(Object, Object, Object, Object)`, `linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)`

public T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3)

Compute a linear combination.

Parameters

a1:T: first factor of the first term
b1:T: second factor of the first term
a2:T: first factor of the second term
b2:T: second factor of the second term
a3:T: first factor of the third term
b3:T: second factor of the third term

Returns:T

a₁×b₁ + a₂×b₂ + a₃×b₃

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3) Compute a linear combination. Parameters a1:double first factor of the first term b1:T second factor of the first term a2:double first factor of the second term b2:T second factor of the second term a3:double first factor of the third term b3:T second factor of the third term Returns:T a₁×b₁ + a₂×b₂ + a₃×b₃ Since 3.2 See Also `linearCombination(double, Object, double, Object)`, `linearCombination(double, Object, double, Object, double, Object, double, Object)`

public T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3)

Compute a linear combination.

Parameters

a1:double: first factor of the first term
b1:T: second factor of the first term
a2:double: first factor of the second term
b2:T: second factor of the second term
a3:double: first factor of the third term
b3:T: second factor of the third term

Returns:T

a₁×b₁ + a₂×b₂ + a₃×b₃

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3, T a4, T b4) Compute a linear combination. Parameters a1:T first factor of the first term b1:T second factor of the first term a2:T first factor of the second term b2:T second factor of the second term a3:T first factor of the third term b3:T second factor of the third term a4:T first factor of the third term b4:T second factor of the third term Returns:T a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄ Since 3.2 See Also `linearCombination(Object, Object, Object, Object)`, `linearCombination(Object, Object, Object, Object, Object, Object)`

public T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3, T a4, T b4)

Compute a linear combination.

Parameters

a1:T: first factor of the first term
b1:T: second factor of the first term
a2:T: first factor of the second term
b2:T: second factor of the second term
a3:T: first factor of the third term
b3:T: second factor of the third term
a4:T: first factor of the third term
b4:T: second factor of the third term

Returns:T

a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄

Since

3.2

linearCombination back to summary

linearCombination	back to summary
public T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3, double a4, T b4) Compute a linear combination. Parameters a1:double first factor of the first term b1:T second factor of the first term a2:double first factor of the second term b2:T second factor of the second term a3:double first factor of the third term b3:T second factor of the third term a4:double first factor of the third term b4:T second factor of the third term Returns:T a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄ Since 3.2 See Also `linearCombination(double, Object, double, Object)`, `linearCombination(double, Object, double, Object, double, Object)`

public T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3, double a4, T b4)

Compute a linear combination.

Parameters

a1:double: first factor of the first term
b1:T: second factor of the first term
a2:double: first factor of the second term
b2:T: second factor of the second term
a3:double: first factor of the third term
b3:T: second factor of the third term
a4:double: first factor of the third term
b4:T: second factor of the third term

Returns:T

a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄

Since

3.2

log	back to summary
public T log() Natural logarithm. Returns:T logarithm of the instance

log

back to summary

public T log()

Natural logarithm.

Returns:T: logarithm of the instance

log1p	back to summary
public T log1p() Shifted natural logarithm. Returns:T logarithm of one plus the instance

log1p

back to summary

public T log1p()

Shifted natural logarithm.

Returns:T: logarithm of one plus the instance

multiply	back to summary
public T multiply(double a) Redeclares org.apache.commons.math3.FieldElement.multiply. '×' operator. Parameters a:double right hand side parameter of the operator Returns:T this×a

multiply

back to summary

public T multiply(double a)

Redeclares org.apache.commons.math3.FieldElement.multiply.

'×' operator.

Parameters

a:double: right hand side parameter of the operator

Returns:T

this×a

pow	back to summary
public T pow(double p) Power operation. Parameters p:double power to apply Returns:T this^p

pow

back to summary

public T pow(double p)

Power operation.

Parameters

p:double: power to apply

Returns:T

this^p

pow	back to summary
public T pow(int n) Integer power operation. Parameters n:int power to apply Returns:T thisⁿ

pow

back to summary

public T pow(int n)

Integer power operation.

Parameters

n:int: power to apply

Returns:T

thisⁿ

pow	back to summary
public T pow(T e) throws DimensionMismatchException Power operation. Parameters e:T exponent Returns:T this^e Exceptions DimensionMismatchException: if number of free parameters or orders are inconsistent

pow

back to summary

public T pow(T e) throws DimensionMismatchException

Power operation.

Parameters

e:T: exponent

Returns:T

this^e

Exceptions

DimensionMismatchException:: if number of free parameters or orders are inconsistent

reciprocal back to summary

reciprocal	back to summary
public T reciprocal() Redeclares org.apache.commons.math3.FieldElement.reciprocal. Doc from org.apache.commons.math3.FieldElement.reciprocal. Returns the multiplicative inverse of `this` element. Returns:T the inverse of `this`.

public T reciprocal()

Redeclares org.apache.commons.math3.FieldElement.reciprocal.

Doc from org.apache.commons.math3.FieldElement.reciprocal.

Returns the multiplicative inverse of this element.

Returns:T: the inverse of this.

remainder	back to summary
public T remainder(double a) IEEE remainder operator. Parameters a:double right hand side parameter of the operator Returns:T this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers)

remainder

back to summary

public T remainder(double a)

IEEE remainder operator.

Parameters

a:double: right hand side parameter of the operator

Returns:T

this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers)

remainder	back to summary
public T remainder(T a) throws DimensionMismatchException IEEE remainder operator. Parameters a:T right hand side parameter of the operator Returns:T this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers) Exceptions DimensionMismatchException: if number of free parameters or orders are inconsistent

remainder

back to summary

public T remainder(T a) throws DimensionMismatchException

IEEE remainder operator.

Parameters

a:T: right hand side parameter of the operator

Returns:T

this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers)

Exceptions

DimensionMismatchException:: if number of free parameters or orders are inconsistent

rint	back to summary
public T rint() Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers. Returns:T a double number r such that r is an integer r - 0.5 ≤ this ≤ r + 0.5

rint

back to summary

public T rint()

Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers.

Returns:T: a double number r such that r is an integer r - 0.5 ≤ this ≤ r + 0.5

rootN	back to summary
public T rootN(int n) N^th root. Parameters n:int order of the root Returns:T n^th root of the instance

rootN

back to summary

public T rootN(int n)

N^th root.

Parameters

n:int: order of the root

Returns:T

n^th root of the instance

round back to summary

round	back to summary
public long round() Get the closest long to instance value. Returns:long closest long to `getReal()`

public long round()

Get the closest long to instance value.

Returns:long: closest long to getReal()

scalb	back to summary
public T scalb(int n) Multiply the instance by a power of 2. Parameters n:int power of 2 Returns:T this × 2ⁿ

scalb

back to summary

public T scalb(int n)

Multiply the instance by a power of 2.

Parameters

n:int: power of 2

Returns:T

this × 2ⁿ

signum	back to summary
public T signum() Compute the signum of the instance. The signum is -1 for negative numbers, +1 for positive numbers and 0 otherwise Returns:T -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a

signum

back to summary

public T signum()

Compute the signum of the instance. The signum is -1 for negative numbers, +1 for positive numbers and 0 otherwise

Returns:T: -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a

sin	back to summary
public T sin() Sine operation. Returns:T sin(this)

sin

back to summary

public T sin()

Sine operation.

Returns:T: sin(this)

sinh	back to summary
public T sinh() Hyperbolic sine operation. Returns:T sinh(this)

sinh

back to summary

public T sinh()

Hyperbolic sine operation.

Returns:T: sinh(this)

sqrt	back to summary
public T sqrt() Square root. Returns:T square root of the instance

sqrt

back to summary

public T sqrt()

Square root.

Returns:T: square root of the instance

subtract	back to summary
public T subtract(double a) Redeclares org.apache.commons.math3.FieldElement.subtract. '-' operator. Parameters a:double right hand side parameter of the operator Returns:T this-a

subtract

back to summary

public T subtract(double a)

Redeclares org.apache.commons.math3.FieldElement.subtract.

'-' operator.

Parameters