aima.core.util.math

Class MixedRadixNumber

java.lang.Object

java.lang.Number

aima.core.util.math.MixedRadixNumber

All Implemented Interfaces:

java.io.Serializable

public class MixedRadixNumber
extends java.lang.Number

For details on Mixed Radix Number Representations.

Author:

Ciaran O'Reilly, Mike Stampone

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MixedRadixNumber(int[] radixValues, int[] radices) Constructs a mixed radix number with a specified array of numerals and a specified array of radices.
MixedRadixNumber(long value, int[] radices) Constructs a mixed radix number with a specified value and a specified array of radices.
MixedRadixNumber(long value, java.util.List<java.lang.Integer> radices) Constructs a mixed radix number with a specified value and a specified list of radices.

Method Summary

Modifier and Type	Method and Description
boolean	decrement() Decrements the value of the mixed radix number, if the value is greater than zero.
double	doubleValue()
float	floatValue()
int	getCurrentNumeralValue(int atPosition) Returns the numeral at the specified position.
long	getCurrentValueFor(int[] radixValues) Returns the value of the mixed radix number with the specified array of numerals and the current array of radices.
long	getMaxAllowedValue() Returns the maximum value which can be represented by the current array of radices.
boolean	increment() Increments the value of the mixed radix number, if the value is less than the maximum value which can be represented by the current array of radices.
int	intValue()
long	longValue()
void	setCurrentValueFor(int[] radixValues) Sets the value of the mixed radix number with the specified array of numerals and the current array of radices.
java.lang.String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

MixedRadixNumber

public MixedRadixNumber(long value,
                        int[] radices)

Constructs a mixed radix number with a specified value and a specified array of radices.

Parameters:

value - the value of the mixed radix number

radices - the radices used to represent the value of the mixed radix number

MixedRadixNumber

public MixedRadixNumber(long value,
                        java.util.List<java.lang.Integer> radices)

Constructs a mixed radix number with a specified value and a specified list of radices.

Parameters:

value - the value of the mixed radix number

radices - the radices used to represent the value of the mixed radix number

MixedRadixNumber

public MixedRadixNumber(int[] radixValues,
                        int[] radices)

Constructs a mixed radix number with a specified array of numerals and a specified array of radices.

Parameters:

radixValues - the numerals of the mixed radix number

radices - the radices of the mixed radix number

Method Detail

getCurrentValueFor

public long getCurrentValueFor(int[] radixValues)

Returns the value of the mixed radix number with the specified array of numerals and the current array of radices.

Returns:

the value of the mixed radix number

Throws:

java.lang.IllegalArgumentException - if any of the specified numerals is less than zero, or if any of the specified numerals is greater than it's corresponding radix.

setCurrentValueFor

public void setCurrentValueFor(int[] radixValues)

Sets the value of the mixed radix number with the specified array of numerals and the current array of radices.

Parameters:

radixValues - the numerals of the mixed radix number

getMaxAllowedValue

public long getMaxAllowedValue()

Returns the maximum value which can be represented by the current array of radices.

Returns:

the maximum value which can be represented by the current array of radices.

increment

public boolean increment()

Increments the value of the mixed radix number, if the value is less than the maximum value which can be represented by the current array of radices.

Returns:

true if the increment was successful.

decrement

public boolean decrement()

Decrements the value of the mixed radix number, if the value is greater than zero.

Returns:

true if the decrement was successful.

getCurrentNumeralValue

public int getCurrentNumeralValue(int atPosition)

Returns the numeral at the specified position.

Parameters:

atPosition - the position of the numeral to return

Returns:

the numeral at the specified position.

intValue

public int intValue()

Specified by:

intValue in class java.lang.Number

longValue

public long longValue()

Specified by:

longValue in class java.lang.Number

floatValue

public float floatValue()

Specified by:

floatValue in class java.lang.Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class java.lang.Number

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object