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

Method Summary

Modifier and Type	Method and Description
public T	Returns: a new element representing this + a add(T element to add a) Compute this + a.
public T	Returns: a new element representing this ÷ a divide(T element to divide by a) Compute this ÷ a.
public Field<T>	Returns: `Field` to which the instance belongs getField() Get the `Field` to which the instance belongs.
public T	Returns: A new element representing n × this. multiply(int Number of times `this` must be added to itself. n) Compute n × this.</center>
public T	Returns: a new element representing this × a multiply(T element to multiply a) Compute this × a.
public T	Returns: the opposite of `this`. negate() Returns the additive inverse of `this` element.
public T	Returns: the inverse of `this`. reciprocal() Returns the multiplicative inverse of `this` element.
public T	Returns: a new element representing this - a subtract(T element to subtract a) Compute this - a.

Method Detail

add back to summary

add	back to summary
public T add(T a) throws NullArgumentException Compute this + a. Parameters a:T element to add Returns:T a new element representing this + a Exceptions NullArgumentException: if `a` is `null`.

public T add(T a) throws NullArgumentException

Compute this + a.

Parameters

a:T: element to add

Returns:T

a new element representing this + a

Exceptions

NullArgumentException:: if a is null.

divide back to summary

divide	back to summary
public T divide(T a) throws NullArgumentException, MathArithmeticException Compute this ÷ a. Parameters a:T element to divide by Returns:T a new element representing this ÷ a Exceptions NullArgumentException: if `a` is `null`. MathArithmeticException: if `a` is zero

public T divide(T a) throws NullArgumentException, MathArithmeticException

Compute this ÷ a.

Parameters

a:T: element to divide by

Returns:T

a new element representing this ÷ a

Exceptions

NullArgumentException:: if a is null.
MathArithmeticException:: if a is zero

getField back to summary

getField	back to summary
public Field<T> getField() Get the `Field` to which the instance belongs. Returns:Field<T> `Field` to which the instance belongs

public Field<T> getField()

Get the Field to which the instance belongs.

Returns:Field<T>: Field to which the instance belongs

multiply back to summary

multiply	back to summary
public T multiply(int n) Compute n × this. Multiplication by an integer number is defined as the following sum n × this = ∑_i=1ⁿ this. Parameters n:int Number of times `this` must be added to itself. Returns:T A new element representing n × this.

public T multiply(int n)

Compute n × this. Multiplication by an integer number is defined as the following sum

n × this = ∑_i=1ⁿ this.

Parameters

n:int: Number of times this must be added to itself.

Returns:T

A new element representing n × this.

multiply back to summary

multiply	back to summary
public T multiply(T a) throws NullArgumentException Compute this × a. Parameters a:T element to multiply Returns:T a new element representing this × a Exceptions NullArgumentException: if `a` is `null`.

public T multiply(T a) throws NullArgumentException

Compute this × a.

Parameters

a:T: element to multiply

Returns:T

a new element representing this × a

Exceptions

NullArgumentException:: if a is null.

negate back to summary

negate	back to summary
public T negate() Returns the additive inverse of `this` element. Returns:T the opposite of `this`.

public T negate()

Returns the additive inverse of this element.

Returns:T: the opposite of this.

reciprocal back to summary

reciprocal	back to summary
public T reciprocal() throws MathArithmeticException Returns the multiplicative inverse of `this` element. Returns:T the inverse of `this`. Exceptions MathArithmeticException: if `this` is zero

public T reciprocal() throws MathArithmeticException

Returns the multiplicative inverse of this element.

Returns:T

the inverse of this.

Exceptions

MathArithmeticException:: if this is zero

subtract back to summary

subtract	back to summary
public T subtract(T a) throws NullArgumentException Compute this - a. Parameters a:T element to subtract Returns:T a new element representing this - a Exceptions NullArgumentException: if `a` is `null`.

public T subtract(T a) throws NullArgumentException

Compute this - a.

Parameters

a:T: element to subtract

Returns:T

a new element representing this - a

Exceptions

NullArgumentException:: if a is null.

public Interface FieldElement<T>

Method Summary

Method Detail