org.decimal4j.arithmetic

Class Sqrt

java.lang.Object

org.decimal4j.arithmetic.Sqrt

final class Sqrt
extends Object

Provides static methods to calculate square roots of Decimal numbers.

Method Summary

Modifier and Type	Method and Description
static long	sqrt(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal) Calculates the square root of the specified unscaled decimal value rounding the result if necessary.
static long	sqrt(DecimalArithmetic arith, long uDecimal) Calculates the square root of the specified unscaled decimal value truncating the result if necessary.
static long	sqrtLong(DecimalRounding rounding, long lValue) Calculates the square root of the specified long value rounding the result if necessary.
static long	sqrtLong(long lValue) Calculates the square root of the specified long value truncating the result if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sqrtLong

public static final long sqrtLong(long lValue)

Calculates the square root of the specified long value truncating the result if necessary.

Parameters:

lValue - the long value

Returns:

roundDOWN(lValue)

Throws:

ArithmeticException - if lValue < 0

sqrtLong

public static final long sqrtLong(DecimalRounding rounding,
                                  long lValue)

Calculates the square root of the specified long value rounding the result if necessary.

Parameters:

rounding - the rounding to apply if necessary

lValue - the long value

Returns:

round(lValue)

Throws:

ArithmeticException - if lValue < 0

sqrt

public static final long sqrt(DecimalArithmetic arith,
                              long uDecimal)

Calculates the square root of the specified unscaled decimal value truncating the result if necessary.

Parameters:

arith - the arithmetic associated with the value

uDecimal - the unscaled decimal value

Returns:

roundDOWN(uDecimal)

Throws:

ArithmeticException - if uDecimal < 0

sqrt

public static final long sqrt(DecimalArithmetic arith,
                              DecimalRounding rounding,
                              long uDecimal)

Calculates the square root of the specified unscaled decimal value rounding the result if necessary.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply if necessary

uDecimal - the unscaled decimal value

Returns:

round(uDecimal)

Throws:

ArithmeticException - if uDecimal < 0