## Functions: FnBigInteger

### 1. Overview

FnBigInteger is a function hub class containing a lot of static methods to work with BigInteger objects. Those static methods return functions that take an BigInteger object either as its input or output (depending on the function). It includes conversions to String, to an String representing a currency and logical operations between BigInteger objects among others.

### 2. Functions

Function nameTypeParamsDescription
absFunction<BigInteger, BigInteger>

It returns the absolute value of the input

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

It adds the given number to the target and returns the result

avgFunction<Iterable<BigInteger>, BigInteger>

It returns the average of all the numbers in the Iterable input object

avgFunction<Iterable<BigInteger>, BigInteger>RoundingMode roundingMode

It returns the average of all the numbers in the Iterable input object. The given RoundingMode will be used to round the output

avgFunction<Iterable<BigInteger>, BigInteger>MathContext mathContext

It returns the average of all the numbers in the Iterable input object. The given MathContext will be used to round and set the output precision

avgArrayFunction<BigInteger[], BigInteger>

It returns the average of all the numbers in the input array

avgArrayFunction<BigInteger[], BigInteger>RoundingMode roundingMode

It returns the average of all the numbers in the input array. The given RoundingMode will be used to round the output

avgArrayFunction<BigInteger[], BigInteger>MathContext mathContext

It returns the average of all the numbers in the input array. The given MathContext will be used to round and set the output precision

betweenFunction<BigInteger,Boolean>Number min
Number max

Determines whether the target object is between min and max in value, this is, whether target.compareTo(min) >= 0 && target.compareTo(max) <= 0. The target and the specified min and max have to implement Comparable.

divideByFunction<BigInteger, BigInteger>Number divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>byte divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>short divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>int divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>long divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>float divisor

It divides the target element by the given divisor and returns its result

divideByFunction<BigInteger, BigInteger>double divisor

It divides the target element by the given divisor and returns its result

eqFunction<BigInteger,Boolean>BigInteger object

Determines whether the target object and the specified object are equal by calling the equals method on the target object.

eqByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object and the specified object parameter are equal by calling the equals method.

eqValueFunction<BigInteger,Boolean>Number object

Determines whether the target object and the specified object are equal in value, this is, whether target.compareTo(object) == 0. Both the target and the specified object have to implement Comparable.

eqValueByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object and the specified object parameter are equal in value, this is, whether functionResult.compareTo(object) == 0. Both the function result and the specified object have to implement Comparable.

greaterOrEqToFunction<BigInteger,Boolean>Number object

Determines whether the target object is greater or equal to the specified object in value, this is, whether target.compareTo(object) >= 0. Both the target and the specified object have to implement Comparable.

greaterOrEqToByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object is greater or equal to the specified object parameter in value, this is, whether functionResult.compareTo(object) >= 0. Both the target and the specified object have to implement Comparable.

greaterThanFunction<BigInteger,Boolean>Number object

Determines whether the target object is greater than the specified object in value, this is, whether target.compareTo(object) > 0. Both the target and the specified object have to implement Comparable.

greaterThanByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object is greater than the specified object parameter in value, this is, whether functionResult.compareTo(object) > 0. Both the target and the specified object have to implement Comparable.

isNotNullFunction<BigInteger,Boolean>

Determines whether the target object is null or not.

isNullFunction<BigInteger,Boolean>

Determines whether the target object is null or not.

lessOrEqToFunction<BigInteger,Boolean>Number object

Determines whether the target object is less or equal to the specified object in value, this is, whether target.compareTo(object) <= 0. Both the target and the specified object have to implement Comparable.

lessOrEqToByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object is less or equal to the specified object parameter in value, this is, whether functionResult.compareTo(object) <= 0. Both the target and the specified object have to implement Comparable.

lessThanFunction<BigInteger,Boolean>Number object

Determines whether the target object is less than the specified object in value, this is, whether target.compareTo(object) < 0. Both the target and the specified object have to implement Comparable.

lessThanByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object is less than the specified object parameter in value, this is, whether functionResult.compareTo(object) < 0. Both the target and the specified object have to implement Comparable.

maxFunction<Iterable<BigInteger>, BigInteger>

It returns the maximum number from an Iterable input object

maxArrayFunction<BigInteger[], BigInteger>

It returns the maximum number from the input array

minFunction<Iterable<BigInteger>, BigInteger>

It returns the minimum number from an Iterable input object

minArrayFunction<BigInteger[], BigInteger>

It returns the minimum number from the input array

moduleFunction<BigInteger, BigInteger>byte module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>short module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>int module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>long module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>Byte module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>Short module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>Integer module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>Long module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

moduleFunction<BigInteger, BigInteger>BigInteger module

It performs a module operation and returns the value of (input mod module) which is always positive (whereas remainder is not)

multiplyByFunction<BigInteger, BigInteger>Number multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>byte multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>short multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>int multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>long multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>float multiplicand

It multiplies target by multiplicand and returns its value

multiplyByFunction<BigInteger, BigInteger>double multiplicand

It multiplies target by multiplicand and returns its value

notEqFunction<BigInteger,Boolean>BigInteger object

Determines whether the target object and the specified object are NOT equal by calling the equals method on the target object.

notEqByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object and the specified object parameter are NOT equal by calling the equals method.

notEqValueFunction<BigInteger,Boolean>Number object

Determines whether the target object and the specified object are NOT equal in value, this is, whether target.compareTo(object) != 0. Both the target and the specified object have to implement Comparable.

notEqValueByFunction<BigInteger,Boolean>IFunction<BigInteger,?> by
Object object

Determines whether the result of executing the specified function on the target object and the specified object parameter are NOT equal in value, this is, whether functionResult.compareTo(object) != 0. Both the function result and the specified object have to implement Comparable.

powFunction<BigInteger, BigInteger>int power

It performs the operation targetpower and returns its value

remainderFunction<BigInteger, BigInteger>Number divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>byte divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>short divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>int divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>long divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>float divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

remainderFunction<BigInteger, BigInteger>double divisor

It divides the target element by the given divisor and returns the remainder (target % divisor)

subtractFunction<BigInteger, BigInteger>Number subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>byte subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>short subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>int subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>long subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>float subtract

It subtracts the given number from the target and returns the result

subtractFunction<BigInteger, BigInteger>double subtract

It subtracts the given number from the target and returns the result

sumFunction<Iterable<BigInteger>, BigInteger>

It returns the sum of all the numbers in the Iterable input object

sumArrayFunction<BigInteger[], BigInteger>

It returns the sum of all the numbers in the input array

toCurrencyStrFunction<BigInteger,String>

It returns the String representation of the target as a currency in the default Locale

toCurrencyStrFunction<BigInteger,String>boolean groupingUsed

It returns the String representation of the target as a currency in the default Locale

toCurrencyStrFunction<BigInteger,String>Locale locale

It returns the String representation of the target as a currency in the given Locale

toCurrencyStrFunction<BigInteger,String>String locale

It returns the String representation of the target as a currency in the given locale

toCurrencyStrFunction<BigInteger,String>Locale locale
boolean groupingUsed

It returns the String representation of the target as a currency in the given Locale

toCurrencyStrFunction<BigInteger,String>String locale
boolean groupingUsed

It returns the String representation of the target as a currency in the given locale

toPercentStrFunction<BigInteger,String>

A String representing a percentage is created from the target number.

toPercentStrFunction<BigInteger,String>boolean groupingUsed

A String representing a percentage is created from the target number either using grouping or not depending on the given parameter. So,

toPercentStr(true) would return 100,000% if target number is 1000
toPercentStr(false) would return 100000% if target number is 1000
toPercentStrFunction<BigInteger,String>Locale locale

A String representing a percentage is created from the target number in the given Locale

toPercentStrFunction<BigInteger,String>String locale

A String representing a percentage is created from the target number in the given locale

toPercentStrFunction<BigInteger,String>Locale locale
boolean groupingUsed

A String representing a percentage is created from the target number in the given Locale. Grouping will be used depending on the value of the groupingUsed parameter.

toPercentStrFunction<BigInteger,String>String locale
boolean groupingUsed

A String representing a percentage is created from the target number in the given locale. Grouping will be used depending on the value of the groupingUsed parameter.

toStrFunction<BigInteger,String>

It returns the String representation of the input number

toStrFunction<BigInteger,String>boolean groupingUsed

It returns the String representation of the input number either using or not using grouping

toStrFunction<BigInteger,String>Locale locale

It returns the String representation of the target number in the given Locale

toStrFunction<BigInteger,String>String locale

It returns the String representation of the target number in the given locale

toStrFunction<BigInteger,String>Locale locale
boolean groupingUsed

It returns the String representation of the target number in the given Locale. Grouping will be used depending on the value of the groupingUsed parameter

toStrFunction<BigInteger,String>String locale
boolean groupingUsed

It returns the String representation of the target number in the given locale. Grouping will be used depending on the value of the groupingUsed parameter