org.znerd.math

Class Power

java.lang.Object

java.lang.Number

org.znerd.math.RealNumber

org.znerd.math.CompositeNumber

org.znerd.math.AbstractCompositeNumber

org.znerd.math.Power

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, RoundingModes

public class Power
extends AbstractCompositeNumber

A power, consisting of a base and an exponent.

Version:

$Revision: 1.3 $ $Date: 2002/08/16 20:51:08 $

Author:

Ernst de Haan (znerd@FreeBSD.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.znerd.math.RealNumber

MAXIMUM_RADIX

Fields inherited from interface org.znerd.math.RoundingModes

ROUND_CEILING, ROUND_DOWN, ROUND_FLOOR, ROUND_UP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Power(RealNumber base, RealNumber exponent) Constructs a Power with the specified base and exponent.

Method Summary

Modifier and Type	Method and Description
static Power	createInstance(RealNumber base, RealNumber exponent) Returns a Power with the specified operands.
protected static int	determineSign(RealNumber base, RealNumber exponent) Computes the sign of a power with the specified operands.
RealNumber	getBase() Returns the base of this power.
RealNumber	getExponent() Returns the exponent of this power.
java.math.BigDecimal	toBigDecimal(int precision, int roundingMode) Converts the value of this number to a BigDecimal with the specified precision and rounding mode.
IntegerNumber	trunc() Rounds to an integer number towards 0.

Methods inherited from class org.znerd.math.AbstractCompositeNumber

getElement, getElementCount, getElements

Methods inherited from class org.znerd.math.RealNumber

abs, add, byteValue, compareTo, compareTo, compareToImpl, divide, doubleValue, equals, fitsByte, fitsDouble, fitsFloat, fitsInt, fitsLong, fitsShort, floatValue, getSign, intValue, invert, longValue, multiply, negate, pow, powImpl, round, shortValue, subtract, toBigDecimal, toBigInteger, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Power

protected Power(RealNumber base,
                RealNumber exponent)
         throws java.lang.IllegalArgumentException

Constructs a Power with the specified base and exponent.

Parameters:

base - the base for the power, not null.

exponent - the exponent for the power, not null.

Throws:

java.lang.IllegalArgumentException - if base == null || exponent == null.

Method Detail

createInstance

public static Power createInstance(RealNumber base,
                                   RealNumber exponent)
                            throws java.lang.IllegalArgumentException

Returns a Power with the specified operands.

Parameters:

base - the base for the power, not null.

exponent - the exponent for the power, not null.

Returns:

the Power instance, possibly newly constructed.

Throws:

java.lang.IllegalArgumentException - if base == null || exponent == null.

determineSign

protected static int determineSign(RealNumber base,
                                   RealNumber exponent)
                            throws java.lang.IllegalArgumentException

Computes the sign of a power with the specified operands.

Parameters:

base - the base for the power, not null.

exponent - the exponent for the power, not null.

Returns:

the Power instance, possibly newly constructed.

Throws:

java.lang.IllegalArgumentException - if base == null || exponent == null.

getBase

public RealNumber getBase()

Returns the base of this power.

Returns:

the base, never null.

getExponent

public RealNumber getExponent()

Returns the exponent of this power.

Returns:

the exponent, never null.

toBigDecimal

public java.math.BigDecimal toBigDecimal(int precision,
                                         int roundingMode)
                                  throws java.lang.IllegalArgumentException

Description copied from class: RealNumber

Converts the value of this number to a BigDecimal with the specified precision and rounding mode.

Specified by:

toBigDecimal in class RealNumber

Parameters:

precision - the number of digits behind the decimal point, >= 0.

roundingMode - the rounding mode to use, one of the modes defined in class BigDecimal.

Returns:

a BigDecimal with the rounded value of this, never null.

Throws:

java.lang.IllegalArgumentException - if one of the following applies:

1. precision < 0
2. roundingMode is not one of the valid rounding modes defined in class BigDecimal

trunc

public IntegerNumber trunc()

Description copied from class: RealNumber

Rounds to an integer number towards 0.

Overrides:

trunc in class RealNumber

Returns:

this real number truncated to an integer, never null.