Class NaturalNumberSecondary

java.lang.Object

components.naturalnumber.NaturalNumberSecondary

All Implemented Interfaces:

NaturalNumber, NaturalNumberKernel, Standard<NaturalNumber>, Comparable<NaturalNumber>

Direct Known Subclasses:

NaturalNumber1L, NaturalNumber2, NaturalNumber3, NaturalNumber4

public abstract class NaturalNumberSecondary
extends Object
implements NaturalNumber

Layered implementations of secondary methods for NaturalNumber.

Field Summary

Fields inherited from interface NaturalNumberKernel

RADIX

Constructor Summary

Constructors

Constructor	Description
NaturalNumberSecondary()

Method Summary

Modifier and Type	Method	Description
void	add(NaturalNumber n)	Adds n to this.
boolean	canConvertToInt()	Reports whether this is small enough to convert to int.
boolean	canSetFromString(String s)	Reports whether s is of the right form to convert to a NaturalNumber.
int	compareTo(NaturalNumber n)
void	copyFrom(NaturalNumber n)	Copies n to this.
void	decrement()	Decrements this.
NaturalNumber	divide(NaturalNumber n)	Divides this by n, returning the remainder.
final boolean	equals(Object obj)
int	hashCode()
void	increment()	Increments this.
void	multiply(NaturalNumber n)	Multiplies this by n.
void	power(int p)	Raises this to the power p.
void	root(int r)	Updates this to the r-th root of its incoming value.
void	setFromInt(int i)	Sets the value of this to i, when i is non-negative.
void	setFromString(String s)	Sets the value of this to the number whose standard decimal representation as a String is s, when s has the appropriate form (i.e., s is the result of the function toString for some NaturalNumber).
void	subtract(NaturalNumber n)	Subtracts n from this.
int	toInt()	Reports the value of this as an int, when this is small enough.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface NaturalNumberKernel

divideBy10, isZero, multiplyBy10

Methods inherited from interface Standard

clear, newInstance, transferFrom

Constructor Details

NaturalNumberSecondary

public NaturalNumberSecondary()

Method Details

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(NaturalNumber n)

Specified by:

compareTo in interface Comparable<NaturalNumber>

setFromInt

public void setFromInt(int i)

Description copied from interface: NaturalNumber

Sets the value of this to i, when i is non-negative.

Specified by:

setFromInt in interface NaturalNumber

Parameters:

i - the new value

canConvertToInt

public boolean canConvertToInt()

Description copied from interface: NaturalNumber

Reports whether this is small enough to convert to int.

Specified by:

canConvertToInt in interface NaturalNumber

Returns:

true iff this is small enough

toInt

public int toInt()

Description copied from interface: NaturalNumber

Reports the value of this as an int, when this is small enough.

Specified by:

toInt in interface NaturalNumber

Returns:

the value

canSetFromString

public boolean canSetFromString(String s)

Description copied from interface: NaturalNumber

Reports whether s is of the right form to convert to a NaturalNumber. Note that this is an instance method and needs to be called with a distinguished argument even though the corresponding parameter (this) is not going to be used. This method should be a static method but currently in Java static methods cannot be declared in interfaces.

Specified by:

canSetFromString in interface NaturalNumber

Parameters:

s - the String to be converted

Returns:

true iff s is of the right form

setFromString

public void setFromString(String s)

Description copied from interface: NaturalNumber

Sets the value of this to the number whose standard decimal representation as a String is s, when s has the appropriate form (i.e., s is the result of the function toString for some NaturalNumber).

Specified by:

setFromString in interface NaturalNumber

Parameters:

s - the String to be converted

copyFrom

public void copyFrom(NaturalNumber n)

Description copied from interface: NaturalNumber

Copies n to this.

Specified by:

copyFrom in interface NaturalNumber

Parameters:

n - NaturalNumber to copy from

increment

public void increment()

Description copied from interface: NaturalNumber

Increments this.

Specified by:

increment in interface NaturalNumber

decrement

public void decrement()

Description copied from interface: NaturalNumber

Decrements this.

Specified by:

decrement in interface NaturalNumber

add

public void add(NaturalNumber n)

Description copied from interface: NaturalNumber

Adds n to this.

Specified by:

add in interface NaturalNumber

Parameters:

n - NaturalNumber to add

subtract

public void subtract(NaturalNumber n)

Description copied from interface: NaturalNumber

Subtracts n from this.

Specified by:

subtract in interface NaturalNumber

Parameters:

n - NaturalNumber to subtract

multiply

public void multiply(NaturalNumber n)

Description copied from interface: NaturalNumber

Multiplies this by n.

Specified by:

multiply in interface NaturalNumber

Parameters:

n - NaturalNumber to multiply by

divide

public NaturalNumber divide(NaturalNumber n)

Description copied from interface: NaturalNumber

Divides this by n, returning the remainder.

Specified by:

divide in interface NaturalNumber

Parameters:

n - NaturalNumber to divide by

Returns:

remainder after division

power

public void power(int p)

Description copied from interface: NaturalNumber

Raises this to the power p.

Specified by:

power in interface NaturalNumber

Parameters:

p - power to raise to

root

public void root(int r)

Description copied from interface: NaturalNumber

Updates this to the r-th root of its incoming value.

Specified by:

root in interface NaturalNumber

Parameters:

r - root