net.sf.jaccumulator.reals

Class AbstractReal<REAL extends Real<REAL>>

java.lang.Object

java.lang.Number

net.sf.jaccumulator.scalars.AbstractScalar<REAL>

net.sf.jaccumulator.reals.AbstractReal<REAL>

Type Parameters:

REAL - this real type (used to facilitate operation chaining on write operations)

All Implemented Interfaces:

Serializable, AlgebraicStructure<REAL>, BooleanValue<REAL>, MutableBooleanValue<REAL>, SealedBooleanValue, ByteValue<REAL>, MutableByteValue<REAL>, SealedByteValue, CharacterValue<REAL>, MutableCharacterValue<REAL>, SealedCharacterValue, DoubleValue<REAL>, MutableDoubleValue<REAL>, SealedDoubleValue, FloatValue<REAL>, MutableFloatValue<REAL>, SealedFloatValue, IntegerValue<REAL>, MutableIntegerValue<REAL>, SealedIntegerValue, LongValue<REAL>, MutableLongValue<REAL>, SealedLongValue, Mutable, MutableAlgebraicStructure<REAL>, MutableKernel<REAL>, MutableReal<REAL>, MutableRealDomain<REAL>, Real<REAL>, RealDomain<REAL>, RealInductor<REAL>, RealReplicator<REAL>, SealedReal<REAL>, SealedRealBag, SealedRealDomain, Replicator<REAL>, CharacterProperties, MutableScalar<REAL>, MutableScalarDomain<REAL>, NumericProperties, Scalar<REAL>, ScalarDomain<REAL>, ScalarInductor<REAL>, ScalarReplicator<REAL>, SealedScalar<REAL>, SealedScalarBag, SealedScalarDomain, SealedAlgebraicStructure, SealedKernel, MutableShortValue<REAL>, SealedShortValue, ShortValue<REAL>, StructureProperties, MutableUnlimitedDecimalValue<REAL>, MutableUnlimitedIntegerValue<REAL>, SealedUnlimitedDecimalValue, SealedUnlimitedIntegerValue, UnlimitedDecimalValue<REAL>, UnlimitedIntegerValue<REAL>

Direct Known Subclasses:

AbstractPrimitive

public abstract class AbstractReal<REAL extends Real<REAL>>
extends AbstractScalar<REAL>
implements Real<REAL>

Common read and write behavior for any representation of real numbers, either boolean vector, unlimited array representation or text

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.jaccumulator.scalars.AbstractScalar

NaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI

Constructor Summary

Constructors

Constructor and Description
AbstractReal()
AbstractReal(Domain aDomain, NumericPrecision aPrecision)
AbstractReal(NumericPrecision aPrecision)

Method Summary

Methods

Modifier and Type	Method and Description
REAL	and(BigInteger aValue) Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	andOfNumber(Number aNumber) Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	andOfReal(SealedReal<?> aValue) Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	angleWithReal(SealedReal<?> aValue) Set this value to the angle formed by the rectangular coordinates given by the current value, x, and the specified value, y.
int	compareToNumber(Number aValue) Compares this object with the specified object for order
int	compareToReal(BigDecimal aReal) Compares this object with the specified object for order
int	compareToReal(BigInteger aReal) Compares this object with the specified object for order
int	compareToReal(SealedReal<?> aValue) Compares this object with the specified object for order
REAL	difference(BigDecimal aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
REAL	difference(BigInteger aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
REAL	differenceOfNumber(Number aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
REAL	differenceOfReal(SealedReal<?> aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
boolean	equals(Object anObject)
REAL	gcd(BigInteger aValue) Replace the current value with the greatest common denonimator between this value and the specific one
REAL	gcdOfNumber(Number aNumber) Replace the current value with the greatest common factor between this value and the specific one
REAL	gcdOfReal(Real<?> aValue) Replace the current value with the greatest common denonimator between this value and the specific one
REAL	hypotenuseWithReal(SealedReal<?> aValue) Set this value to the hypotenuse formed by the square root of the sum of the square of the current value, x, and the square of the specified value, y, without intermediate overflow or underflow
<R extends Real<?>> R	induceRealSize(R aTarget) Update the target scalar with the element count in this structure
boolean	isEqual(BigDecimal aReal)
boolean	isEqual(BigInteger aReal)
boolean	isEqualToNumber(Number aNumber)
boolean	isEqualToReal(SealedReal<?> aValue)
boolean	isGreater(BigDecimal aReal)
boolean	isGreater(BigInteger aReal)
boolean	isGreaterOrEqual(BigDecimal aReal)
boolean	isGreaterOrEqual(BigInteger aReal)
boolean	isGreaterOrEqualToNumber(Number aNumber)
boolean	isGreaterOrEqualToReal(SealedReal<?> aValue)
boolean	isGreaterThanNumber(Number aNumber)
boolean	isGreaterThanReal(SealedReal<?> aValue)
boolean	isLess(BigDecimal aReal)
boolean	isLess(BigInteger aReal)
boolean	isLessOrEqual(BigDecimal aReal)
boolean	isLessOrEqual(BigInteger aReal)
boolean	isLessOrEqualToNumber(Number aNumber)
boolean	isLessOrEqualToReal(SealedReal<?> aValue)
boolean	isLessThanNumber(Number aNumber)
boolean	isLessThanReal(SealedReal<?> aValue)
boolean	isNotEqual(BigDecimal aReal)
boolean	isNotEqual(BigInteger aReal)
boolean	isNotEqualToNumber(Number aNumber)
boolean	isNotEqualToReal(SealedReal<?> aValue)
REAL	mod(BigDecimal aValue) Set the value of this scalar to its current value modulo of the specified value
REAL	mod(BigInteger aValue) Set the value of this scalar to its current value modulo of the specified value
REAL	modOfNumber(Number aValue) Set the value of this scalar to its current value modulo of the specified value
REAL	modOfReal(SealedReal<?> aValue) Set the value of this scalar to its current value modulo of the specified value
REAL	or(BigInteger aValue) Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	orOfNumber(Number aValue) Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	orOfReal(SealedReal<?> aValue) Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	powerOfReal(SealedReal<?> aValue) Set this value to the current value, x, raised to the specified exponent, n, or xn
REAL	product(BigDecimal aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
REAL	product(BigInteger aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
REAL	productOfNumber(Number aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
REAL	productOfReal(SealedReal<?> aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
REAL	quotient(BigDecimal aValue) Set the value of this scalar to the mathematical quotient between its current value and the specified value
REAL	quotient(BigInteger aValue) Set the value of this scalar to the mathematical quotient between its current value and the specified value
REAL	quotientOfNumber(Number aValue) Set the value of this scalar to the mathematical quotient of its current value and the specified value
REAL	quotientOfReal(SealedReal<?> aValue) Set the value of this scalar to the mathematical quotient between its current value and the specified value
REAL	setNumber(Number aValue) Set this object to the specified system-supported Number and answer this object (facilitates chaining)
REAL	setReal(SealedReal<?> aValue) Set this property to the specified numeric primitive and answer this object (facilitates chaining)
REAL	sum(BigDecimal aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
REAL	sum(BigInteger aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
REAL	sumOfNumber(Number aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
REAL	sumOfReal(SealedReal<?> aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
Real<?>	toReal() If this real is already a real number real then simply call its Replicator.copy() function, otherwise produce a new real number real
static BigInteger	unlimitedIntegerModularInverse(BigInteger p0, BigInteger p1)
REAL	xor(BigInteger aValue) Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	xorOfNumber(Number aValue) Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector
REAL	xorOfReal(SealedReal<?> aValue) Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Methods inherited from class net.sf.jaccumulator.scalars.AbstractScalar

absoluteValue, and, and, and, and, and, and, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, assertDomain, assertPrecision, base10Log, boundsCheck, byteMaskAt, byteNotMaskAt, byteValue, ceiling, charMaskAt, charNotMaskAt, charValue, clearByteBitAt, clearCharBitAt, clearDoubleBitAt, clearFloatBitAt, clearIntBitAt, clearLongBitAt, clearShortBitAt, clearUnlimitedDecimalBitAt, clearUnlimitedIntegerBitAt, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, cosine, cubeRoot, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfScalar, divideByZero, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfScalar, getBooleanBitAt, getByteBitAt, getCharBitAt, getDomain, getDoubleBitAt, getFloatBitAt, getIntBitAt, getLongBitAt, getPrecision, getShortBitAt, getUnlimitedDecimalBitAt, getUnlimitedIntegerBitAt, halfDown, halfEven, halfUp, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, indexOutOfBoundsAt, induceScalarSize, intGCD, intMaskAt, intModularInverse, intModularQuotient, intNotMaskAt, intValue, invalidate, isAlphabetic, isBmpCodePoint, isConfigurable, isCountable, isDigit, isElastic, isEmpty, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isExpandable, isFalse, isFinite, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToScalar, isGreaterThanScalar, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isImaginary, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToScalar, isLessThanScalar, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isMutable, isNegativeFinite, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isOrdered, isPositiveFinite, isReducible, isSupplementaryCodePoint, isSurrogate, isTitleCase, isTrue, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUnique, isUpperCase, isValid, isValidCodePoint, isWhitespace, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longSize, longValue, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, or, or, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfScalar, promoteTo, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setEnumeration, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setNegativeInfinity, setPi, setPositiveInfinity, setScalar, setShortBitAt, setTrue, setUnity, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, setZero, shiftRightExtendZero, shortMaskAt, shortNotMaskAt, shortValue, signum, sine, size, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfScalar, tangent, toBoolean, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toCharacter, toCodePoint, toEnumeration, toScalar, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xor, xor, xor, xor, xor, xor, xorOfScalar

Methods inherited from class java.lang.Number

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jaccumulator.reals.RealInductor

inducePostDecrement, inducePostIncrement, induceRealValue

Methods inherited from interface net.sf.jaccumulator.scalars.ScalarInductor

inducePostDecrement, inducePostIncrement, induceScalarValue

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalar

compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToScalar, isGreaterThanScalar, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToScalar, isLessThanScalar, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isTrue, toBoolean, toCharacter, toCodePoint, toEnumeration, toNumber

Methods inherited from interface net.sf.jaccumulator.SealedKernel

getConcurrency, hashCode, toString

Methods inherited from interface net.sf.jaccumulator.scalars.NumericProperties

isFinite, isImaginary, isInfinity, isInvalid, isMaximum, isMinimum, isModulo, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isUnity, isValid, isZero, signum

Methods inherited from interface net.sf.jaccumulator.scalars.CharacterProperties

isAlphabetic, isBmpCodePoint, isDigit, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isSupplementaryCodePoint, isSurrogate, isTitleCase, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUpperCase, isValidCodePoint, isWhitespace

Methods inherited from interface net.sf.jaccumulator.booleans.SealedBooleanValue

booleanValue

Methods inherited from interface net.sf.jaccumulator.bytes.SealedByteValue

byteValue

Methods inherited from interface net.sf.jaccumulator.characters.SealedCharacterValue

charValue

Methods inherited from interface net.sf.jaccumulator.doubles.SealedDoubleValue

doubleValue

Methods inherited from interface net.sf.jaccumulator.floats.SealedFloatValue

floatValue

Methods inherited from interface net.sf.jaccumulator.integers.SealedIntegerValue

intValue

Methods inherited from interface net.sf.jaccumulator.longs.SealedLongValue

longValue

Methods inherited from interface net.sf.jaccumulator.shorts.SealedShortValue

shortValue

Methods inherited from interface net.sf.jaccumulator.reals.SealedRealDomain

induceRealMaximum, induceRealMinimum

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalarDomain

getPrecision, induceScalarMaximum, induceScalarMinimum

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalarBag

induceScalarSize

Methods inherited from interface net.sf.jaccumulator.SealedAlgebraicStructure

getDomain, getStructureStrategy, longSize, size

Methods inherited from interface net.sf.jaccumulator.StructureProperties

isConfigurable, isCountable, isElastic, isEmpty, isExpandable, isOrdered, isReducible, isUnique

Methods inherited from interface net.sf.jaccumulator.reals.RealReplicator

copyUsing, copyUsing, copyUsingReal

Methods inherited from interface net.sf.jaccumulator.scalars.ScalarReplicator

copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsingScalar, toScalar

Methods inherited from interface net.sf.jaccumulator.Replicator

copy

Methods inherited from interface net.sf.jaccumulator.scalars.MutableScalar

absoluteValue, and, and, and, and, and, and, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cube, cubeRoot, decrement, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, increment, invalidate, inverse, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, negate, not, or, or, or, or, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfScalar, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, round, setE, setEnumeration, setMaximum, setMinimum, setNegativeInfinity, setPi, setPositiveInfinity, setScalar, setUnity, setZero, shiftLeft, shiftRight, shiftRightExtendZero, sine, square, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfScalar, tangent, up, xor, xor, xor, xor, xor, xor, xorOfScalar

Methods inherited from interface net.sf.jaccumulator.booleans.MutableBooleanValue

booleanPostDecrement, booleanPostIncrement, setFalse, setScalar, setTrue

Methods inherited from interface net.sf.jaccumulator.bytes.MutableByteValue

bytePostDecrement, bytePostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.characters.MutableCharacterValue

charPostDecrement, charPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.doubles.MutableDoubleValue

doublePostDecrement, doublePostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.floats.MutableFloatValue

floatPostDecrement, floatPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.integers.MutableIntegerValue

intPostDecrement, intPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.longs.MutableLongValue

longPostDecrement, longPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.shorts.MutableShortValue

setScalar, shortPostDecrement, shortPostIncrement

Methods inherited from interface net.sf.jaccumulator.scalars.MutableScalarDomain

assertPrecision, promoteTo

Methods inherited from interface net.sf.jaccumulator.MutableAlgebraicStructure

assertDomain, clear, clearContents

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

Methods inherited from interface net.sf.jaccumulator.unlimiteds.SealedUnlimitedIntegerValue

toUnlimitedInteger

Methods inherited from interface net.sf.jaccumulator.unlimiteds.MutableUnlimitedIntegerValue

setReal, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement

Methods inherited from interface net.sf.jaccumulator.unlimiteds.SealedUnlimitedDecimalValue

toUnlimitedDecimal

Methods inherited from interface net.sf.jaccumulator.unlimiteds.MutableUnlimitedDecimalValue

setReal, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement

Constructor Detail

AbstractReal

public AbstractReal()

AbstractReal

public AbstractReal(Domain aDomain,
            NumericPrecision aPrecision)

AbstractReal

public AbstractReal(NumericPrecision aPrecision)

Method Detail

and

public REAL and(BigInteger aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

and in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

andOfNumber

public REAL andOfNumber(Number aNumber)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableScalar

Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

andOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

andOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aNumber - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

andOfReal

public REAL andOfReal(SealedReal<?> aValue)
                                  throws UnsupportedOperationException,
                                         IllegalArgumentException,
                                         ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

andOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

angleWithReal

public REAL angleWithReal(SealedReal<?> aValue)
                                      throws UnsupportedOperationException,
                                             IllegalArgumentException,
                                             ArithmeticException

Description copied from interface: MutableReal

Set this value to the angle formed by the rectangular coordinates given by the current value, x, and the specified value, y. In other words returns the angle theta from the conversion of rectangular coordinates (x,y) to polar coordinates (r,theta).

Specified by:

angleWithReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a y coordinate value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

See Also:

Math.atan2(double, double)

compareToNumber

public int compareToNumber(Number aValue)

Description copied from interface: SealedScalar

Compares this object with the specified object for order

Specified by:

compareToNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

compareToNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - an object to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(Object)

compareToReal

public int compareToReal(BigDecimal aReal)

Description copied from interface: SealedReal

Compares this object with the specified object for order

Specified by:

compareToReal in interface SealedReal<REAL extends Real<REAL>>

Parameters:

aReal - an object to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(Object)

compareToReal

public int compareToReal(BigInteger aReal)

Description copied from interface: SealedReal

Compares this object with the specified object for order

Specified by:

compareToReal in interface SealedReal<REAL extends Real<REAL>>

Parameters:

aReal - an object to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(Object)

compareToReal

public int compareToReal(SealedReal<?> aValue)

Description copied from interface: SealedReal

Compares this object with the specified object for order

Specified by:

compareToReal in interface SealedReal<REAL extends Real<REAL>>

Parameters:

aValue - an object to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(Object)

difference

public REAL difference(BigDecimal aValue)
                                   throws UnsupportedOperationException,
                                          IllegalArgumentException,
                                          ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical difference between its current value and the specified value

Specified by:

difference in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a subtrahend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

difference

public REAL difference(BigInteger aValue)
                                   throws UnsupportedOperationException,
                                          IllegalArgumentException,
                                          ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical difference between its current value and the specified value

Specified by:

difference in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a subtrahend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

differenceOfNumber

public REAL differenceOfNumber(Number aValue)
                                           throws UnsupportedOperationException,
                                                  IllegalArgumentException,
                                                  ArithmeticException

Description copied from interface: MutableScalar

Set the value of this scalar to the mathematical difference between its current value and the specified value

Specified by:

differenceOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

differenceOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - a subtrahend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

differenceOfReal

public REAL differenceOfReal(SealedReal<?> aValue)
                                         throws UnsupportedOperationException,
                                                IllegalArgumentException,
                                                ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical difference between its current value and the specified value

Specified by:

differenceOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a subtrahend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

equals

public boolean equals(Object anObject)

Specified by:

equals in interface SealedKernel

Overrides:

equals in class AbstractScalar<REAL extends Real<REAL>>

gcd

public REAL gcd(BigInteger aValue)
                            throws UnsupportedOperationException,
                                   ArithmeticException,
                                   IllegalArgumentException

Description copied from interface: MutableReal

Replace the current value with the greatest common denonimator between this value and the specific one

Specified by:

gcd in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

IllegalArgumentException - if the new value was incommensurate with this object's specification

gcdOfNumber

public REAL gcdOfNumber(Number aNumber)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableScalar

Replace the current value with the greatest common factor between this value and the specific one

Specified by:

gcdOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

gcdOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

gcdOfReal

public final REAL gcdOfReal(Real<?> aValue)
                                        throws UnsupportedOperationException,
                                               ArithmeticException,
                                               IllegalArgumentException

Description copied from interface: MutableReal

Replace the current value with the greatest common denonimator between this value and the specific one

Specified by:

gcdOfReal in interface MutableReal<REAL extends Real<REAL>>

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

IllegalArgumentException - if the new value was incommensurate with this object's specification

hypotenuseWithReal

public final REAL hypotenuseWithReal(SealedReal<?> aValue)
                                                 throws UnsupportedOperationException,
                                                        IllegalArgumentException,
                                                        ArithmeticException

Description copied from interface: MutableReal

Set this value to the hypotenuse formed by the square root of the sum of the square of the current value, x, and the square of the specified value, y, without intermediate overflow or underflow

Specified by:

hypotenuseWithReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a y value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

See Also:

Math.hypot(double, double)

induceRealSize

public <R extends Real<?>> R induceRealSize(R aTarget)
                              throws NullPointerException,
                                     NoSuchElementException,
                                     UnsupportedOperationException,
                                     IllegalStateException

Description copied from interface: SealedRealBag

Update the target scalar with the element count in this structure

Specified by:

induceRealSize in interface SealedRealBag

Type Parameters:

R - the target type

Parameters:

aTarget - the target to update

Returns:

the target scalar (facilitates operation chaining)

Throws:

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source

UnsupportedOperationException - this target cannot be changed

IllegalStateException - this target cannot be changed at this time

isEqual

public boolean isEqual(BigDecimal aReal)

Specified by:

isEqual in interface SealedReal<REAL extends Real<REAL>>

isEqual

public boolean isEqual(BigInteger aReal)

Specified by:

isEqual in interface SealedReal<REAL extends Real<REAL>>

isEqualToNumber

public boolean isEqualToNumber(Number aNumber)

Specified by:

isEqualToNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isEqualToNumber in class AbstractScalar<REAL extends Real<REAL>>

isEqualToReal

public boolean isEqualToReal(SealedReal<?> aValue)

Specified by:

isEqualToReal in interface SealedReal<REAL extends Real<REAL>>

isGreater

public boolean isGreater(BigDecimal aReal)

Specified by:

isGreater in interface SealedReal<REAL extends Real<REAL>>

isGreater

public boolean isGreater(BigInteger aReal)

Specified by:

isGreater in interface SealedReal<REAL extends Real<REAL>>

isGreaterOrEqual

public boolean isGreaterOrEqual(BigDecimal aReal)

Specified by:

isGreaterOrEqual in interface SealedReal<REAL extends Real<REAL>>

isGreaterOrEqual

public boolean isGreaterOrEqual(BigInteger aReal)

Specified by:

isGreaterOrEqual in interface SealedReal<REAL extends Real<REAL>>

isGreaterOrEqualToNumber

public boolean isGreaterOrEqualToNumber(Number aNumber)

Specified by:

isGreaterOrEqualToNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isGreaterOrEqualToNumber in class AbstractScalar<REAL extends Real<REAL>>

isGreaterOrEqualToReal

public boolean isGreaterOrEqualToReal(SealedReal<?> aValue)

Specified by:

isGreaterOrEqualToReal in interface SealedReal<REAL extends Real<REAL>>

isGreaterThanNumber

public boolean isGreaterThanNumber(Number aNumber)

Specified by:

isGreaterThanNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isGreaterThanNumber in class AbstractScalar<REAL extends Real<REAL>>

isGreaterThanReal

public boolean isGreaterThanReal(SealedReal<?> aValue)

Specified by:

isGreaterThanReal in interface SealedReal<REAL extends Real<REAL>>

isLess

public boolean isLess(BigDecimal aReal)

Specified by:

isLess in interface SealedReal<REAL extends Real<REAL>>

isLess

public boolean isLess(BigInteger aReal)

Specified by:

isLess in interface SealedReal<REAL extends Real<REAL>>

isLessOrEqual

public boolean isLessOrEqual(BigDecimal aReal)

Specified by:

isLessOrEqual in interface SealedReal<REAL extends Real<REAL>>

isLessOrEqual

public boolean isLessOrEqual(BigInteger aReal)

Specified by:

isLessOrEqual in interface SealedReal<REAL extends Real<REAL>>

isLessOrEqualToNumber

public boolean isLessOrEqualToNumber(Number aNumber)

Specified by:

isLessOrEqualToNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isLessOrEqualToNumber in class AbstractScalar<REAL extends Real<REAL>>

isLessOrEqualToReal

public boolean isLessOrEqualToReal(SealedReal<?> aValue)

Specified by:

isLessOrEqualToReal in interface SealedReal<REAL extends Real<REAL>>

isLessThanNumber

public boolean isLessThanNumber(Number aNumber)

Specified by:

isLessThanNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isLessThanNumber in class AbstractScalar<REAL extends Real<REAL>>

isLessThanReal

public boolean isLessThanReal(SealedReal<?> aValue)

Specified by:

isLessThanReal in interface SealedReal<REAL extends Real<REAL>>

isNotEqual

public boolean isNotEqual(BigDecimal aReal)

Specified by:

isNotEqual in interface SealedReal<REAL extends Real<REAL>>

isNotEqual

public boolean isNotEqual(BigInteger aReal)

Specified by:

isNotEqual in interface SealedReal<REAL extends Real<REAL>>

isNotEqualToNumber

public boolean isNotEqualToNumber(Number aNumber)

Specified by:

isNotEqualToNumber in interface SealedScalar<REAL extends Real<REAL>>

Overrides:

isNotEqualToNumber in class AbstractScalar<REAL extends Real<REAL>>

isNotEqualToReal

public boolean isNotEqualToReal(SealedReal<?> aValue)

Specified by:

isNotEqualToReal in interface SealedReal<REAL extends Real<REAL>>

mod

public REAL mod(BigDecimal aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to its current value modulo of the specified value

Specified by:

mod in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a modulus

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

mod

public REAL mod(BigInteger aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to its current value modulo of the specified value

Specified by:

mod in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a modulus

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

modOfNumber

public REAL modOfNumber(Number aValue)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableScalar

Set the value of this scalar to its current value modulo of the specified value

Specified by:

modOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

modOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - a modulus

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

modOfReal

public REAL modOfReal(SealedReal<?> aValue)
                                  throws UnsupportedOperationException,
                                         IllegalArgumentException,
                                         ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to its current value modulo of the specified value

Specified by:

modOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a modulus

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

or

public REAL or(BigInteger aValue)
                           throws UnsupportedOperationException,
                                  IllegalArgumentException,
                                  ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

or in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

orOfNumber

public REAL orOfNumber(Number aValue)
                                   throws UnsupportedOperationException,
                                          IllegalArgumentException,
                                          ArithmeticException

Description copied from interface: MutableScalar

Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

orOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

orOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

orOfReal

public REAL orOfReal(SealedReal<?> aValue)
                                 throws UnsupportedOperationException,
                                        IllegalArgumentException,
                                        ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

orOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

powerOfReal

public REAL powerOfReal(SealedReal<?> aValue)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableReal

Set this value to the current value, x, raised to the specified exponent, n, or xⁿ

Specified by:

powerOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an exponent

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

product

public REAL product(BigDecimal aValue)
                                throws UnsupportedOperationException,
                                       IllegalArgumentException,
                                       ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical product of its current value and the specified value

Specified by:

product in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a multiplicand

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

product

public REAL product(BigInteger aValue)
                                throws UnsupportedOperationException,
                                       IllegalArgumentException,
                                       ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical product of its current value and the specified value

Specified by:

product in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a multiplicand

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

productOfNumber

public REAL productOfNumber(Number aValue)
                                        throws UnsupportedOperationException,
                                               IllegalArgumentException,
                                               ArithmeticException

Description copied from interface: MutableScalar

Set the value of this scalar to the mathematical product of its current value and the specified value

Specified by:

productOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

productOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - a multiplicand

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

productOfReal

public REAL productOfReal(SealedReal<?> aValue)
                                      throws UnsupportedOperationException,
                                             IllegalArgumentException,
                                             ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical product of its current value and the specified value

Specified by:

productOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a multiplicand

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

quotient

public REAL quotient(BigDecimal aValue)
                                 throws UnsupportedOperationException,
                                        IllegalArgumentException,
                                        ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical quotient between its current value and the specified value

Specified by:

quotient in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a divisor

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

quotient

public REAL quotient(BigInteger aValue)
                                 throws UnsupportedOperationException,
                                        IllegalArgumentException,
                                        ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical quotient between its current value and the specified value

Specified by:

quotient in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a divisor

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

quotientOfNumber

public REAL quotientOfNumber(Number aValue)
                                         throws UnsupportedOperationException,
                                                IllegalArgumentException,
                                                ArithmeticException

Description copied from interface: MutableScalar

Set the value of this scalar to the mathematical quotient of its current value and the specified value

Specified by:

quotientOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

quotientOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - a divisor

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

quotientOfReal

public REAL quotientOfReal(SealedReal<?> aValue)
                                       throws UnsupportedOperationException,
                                              IllegalArgumentException,
                                              ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical quotient between its current value and the specified value

Specified by:

quotientOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a divisor

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

setNumber

public REAL setNumber(Number aValue)
                                  throws UnsupportedOperationException,
                                         IllegalArgumentException,
                                         ArithmeticException,
                                         NullPointerException

Description copied from interface: MutableScalar

Set this object to the specified system-supported Number and answer this object (facilitates chaining)

Specified by:

setNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

setNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - a system-supported Number

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the specified value was incommensurate with this object's specification

ArithmeticException - the numeric value provided was incompatible with with algebraic interpretation of this object

NullPointerException - a null value was provided though this object does not accept null values

setReal

public REAL setReal(SealedReal<?> aValue)
                                throws UnsupportedOperationException,
                                       IllegalArgumentException,
                                       ArithmeticException,
                                       NullPointerException

Description copied from interface: MutableReal

Set this property to the specified numeric primitive and answer this object (facilitates chaining)

Specified by:

setReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - a numeric primitive

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the specified value was incommensurate with this object's specification

ArithmeticException - the numeric value provided was incompatible with with algebraic interpretation of this object

NullPointerException - a null value was provided though this object does not accept null values

sum

public REAL sum(BigDecimal aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical sum of its current value and the specified value

Specified by:

sum in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an addend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

sum

public REAL sum(BigInteger aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical sum of its current value and the specified value

Specified by:

sum in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an addend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

sumOfNumber

public REAL sumOfNumber(Number aValue)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableScalar

Set the value of this scalar to the mathematical sum of its current value and the specified value

Specified by:

sumOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

sumOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - an addend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

sumOfReal

public REAL sumOfReal(SealedReal<?> aValue)
                                  throws UnsupportedOperationException,
                                         IllegalArgumentException,
                                         ArithmeticException

Description copied from interface: MutableReal

Set the value of this scalar to the mathematical sum of its current value and the specified value

Specified by:

sumOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an addend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

toReal

public Real<?> toReal()

Description copied from interface: RealReplicator

If this real is already a real number real then simply call its Replicator.copy() function, otherwise produce a new real number real

Specified by:

toReal in interface RealReplicator<REAL extends Real<REAL>>

Returns:

a new real number real

xor

public REAL xor(BigInteger aValue)
                            throws UnsupportedOperationException,
                                   IllegalArgumentException,
                                   ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

xor in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

xorOfNumber

public REAL xorOfNumber(Number aValue)
                                    throws UnsupportedOperationException,
                                           IllegalArgumentException,
                                           ArithmeticException

Description copied from interface: MutableScalar

Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

xorOfNumber in interface MutableScalar<REAL extends Real<REAL>>

Overrides:

xorOfNumber in class AbstractScalar<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

xorOfReal

public REAL xorOfReal(SealedReal<?> aValue)
                                  throws UnsupportedOperationException,
                                         IllegalArgumentException,
                                         ArithmeticException

Description copied from interface: MutableReal

Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Specified by:

xorOfReal in interface MutableReal<REAL extends Real<REAL>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

unlimitedIntegerModularInverse

public static final BigInteger unlimitedIntegerModularInverse(BigInteger p0,
                                        BigInteger p1)