org.decimal4j.arithmetic

Class Square

java.lang.Object

org.decimal4j.arithmetic.Square

final class Square
extends Object

Provides methods to calculate squares.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static long	SQRT_MAX_VALUE Value representing: floor(sqrt(Long.MAX_VALUE))

Method Summary

Modifier and Type	Method and Description
static long	square(ScaleMetrics scaleMetrics, DecimalRounding rounding, long uDecimal) Calculates the square uDecimal^2 / scaleFactor applying the specified rounding for truncated decimals.
static long	square(ScaleMetrics scaleMetrics, long uDecimal) Calculates the square uDecimal^2 / scaleFactor without rounding.
static long	squareChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal) Calculates the square uDecimal^2 / scaleFactor applying the specified rounding for truncated decimals.
static long	squareChecked(DecimalArithmetic arith, long uDecimal) Calculates the square uDecimal^2 / scaleFactor truncating the result if necessary.

Methods inherited from class java.lang.Object

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

Field Detail

SQRT_MAX_VALUE

static final long SQRT_MAX_VALUE

Value representing: floor(sqrt(Long.MAX_VALUE))

See Also:

Constant Field Values

Method Detail

square

public static final long square(ScaleMetrics scaleMetrics,
                                long uDecimal)

Calculates the square uDecimal^2 / scaleFactor without rounding. Overflows are silently truncated.

Parameters:

scaleMetrics - the scale metrics defining the scale

uDecimal - the unscaled decimal value to square

Returns:

the square result without rounding

square

public static final long square(ScaleMetrics scaleMetrics,
                                DecimalRounding rounding,
                                long uDecimal)

Calculates the square uDecimal^2 / scaleFactor applying the specified rounding for truncated decimals. Overflows are silently truncated.

Parameters:

scaleMetrics - the scale metrics defining the scale

rounding - the rounding to apply for truncated decimals

uDecimal - the unscaled decimal value to square

Returns:

the square result with rounding

squareChecked

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

Calculates the square uDecimal^2 / scaleFactor truncating the result if necessary. Throws an exception if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

uDecimal - the unscaled decimal value to square

Returns:

the square result without rounding

squareChecked

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

Calculates the square uDecimal^2 / scaleFactor applying the specified rounding for truncated decimals. Throws an exception if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply for truncated decimals

uDecimal - the unscaled decimal value to square

Returns:

the square result with rounding