PRIMITIVE
- this primitive type (used to facilitate operation chaining on write
operations)public abstract class AbstractUnlimitedIntegerPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>> extends AbstractNumericPrimitive<PRIMITIVE>
NaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI
Constructor and Description |
---|
AbstractUnlimitedIntegerPrimitive() |
AbstractUnlimitedIntegerPrimitive(BigDecimal aValue) |
AbstractUnlimitedIntegerPrimitive(BigInteger aValue) |
AbstractUnlimitedIntegerPrimitive(boolean aValue) |
AbstractUnlimitedIntegerPrimitive(byte aValue) |
AbstractUnlimitedIntegerPrimitive(char aValue) |
AbstractUnlimitedIntegerPrimitive(Domain aDomain) |
AbstractUnlimitedIntegerPrimitive(Domain aDomain,
BigInteger aValue) |
AbstractUnlimitedIntegerPrimitive(double aValue) |
AbstractUnlimitedIntegerPrimitive(float aValue) |
AbstractUnlimitedIntegerPrimitive(int aValue) |
AbstractUnlimitedIntegerPrimitive(long aValue) |
AbstractUnlimitedIntegerPrimitive(SealedPrimitive<?> aValue) |
AbstractUnlimitedIntegerPrimitive(SealedReal<?> aValue) |
AbstractUnlimitedIntegerPrimitive(short aValue) |
AbstractUnlimitedIntegerPrimitive(String aValue) |
Modifier and Type | Method and Description |
---|---|
PRIMITIVE |
absoluteValue()
Replace the current value with the absolute value of itself
|
PRIMITIVE |
and(boolean aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
and(byte aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
and(char aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
and(int aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
and(long aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
and(short aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
boolean |
booleanPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
boolean |
booleanPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
boolean |
booleanValue() |
byte |
bytePostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
byte |
bytePostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
byte |
byteValue() |
char |
charPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
char |
charPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
char |
charValue() |
PRIMITIVE |
cube()
Replace the current value with the cube of itself
|
PRIMITIVE |
difference(boolean aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(byte aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(char aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(double aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(float aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(int aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(long aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(short aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
double |
doublePostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
double |
doublePostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
double |
doubleValue() |
float |
floatPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
float |
floatPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
float |
floatValue() |
StructureStrategy |
getStructureStrategy() |
int |
hashCode() |
<R extends Real<?>> |
inducePostDecrement(R aTarget)
Decrement the value of this real then induce its original value into
the specified target
|
<S extends Scalar<?>> |
inducePostDecrement(S aTarget)
Decrement the value of this scalar then induce its original value into
the specified target
|
<R extends Real<?>> |
inducePostIncrement(R aTarget)
Increment the value of this real then induce its original value into
the specified target
|
<S extends Scalar<?>> |
inducePostIncrement(S aTarget)
Increment the value of this scalar then induce its original value into
the specified target
|
<R extends Real<?>> |
induceRealMaximum(R aTarget)
Induce the maximum domain value into the target
|
<R extends Real<?>> |
induceRealMinimum(R aTarget)
Induce the minimum domain value into the target
|
<R extends Real<?>> |
induceRealValue(R aTarget)
Induce the current value of this real into the specified target
|
<S extends Scalar<?>> |
induceScalarMaximum(S aTarget)
Induce the maximum domain value into the target
|
<S extends Scalar<?>> |
induceScalarMinimum(S aTarget)
Induce the minimum domain value into the target
|
<S extends Scalar<?>> |
induceScalarValue(S aTarget)
Induce the current value of this scalar into the specified target
|
int |
intPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
int |
intPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
int |
intValue() |
PRIMITIVE |
invalidate()
Replace the current value an invalid value such
INVALID if possible, otherwise replace it with zero |
PRIMITIVE |
inverse()
Replace the current value its multiplicative inverse (
1/x ) |
boolean |
isFinite() |
boolean |
isInfinity() |
boolean |
isInvalid() |
boolean |
isMaximum() |
boolean |
isMinimum() |
boolean |
isModulo()
Answer
true if this value represents the magnitude of a vector
into a modulo set, or finite ring. |
boolean |
isNegative() |
boolean |
isNegativeFinite() |
boolean |
isNegativeInfinity() |
boolean |
isPositive() |
boolean |
isPositiveFinite() |
boolean |
isPositiveInfinity() |
boolean |
isReal()
Answer
true if this value represents the magnitude of a vector
into the set of real numbers. |
boolean |
isUnity()
Answer
true if this value represents the multiplicative
identity in its arithmetic domain. |
boolean |
isZero()
Answer
true if this value represents the additive identity
in its algebraic group. |
long |
longPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
long |
longPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
long |
longValue() |
PRIMITIVE |
mod(boolean aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(byte aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(char aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(double aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(float aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(int aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(long aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(short aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
negate()
Replace the current value with the additive inverse (sign negation) of
itself, that is transform it into a number that when added to the
original yields zero.
|
PRIMITIVE |
not()
Replace the current integral binary vector with its one's
complement.
|
PRIMITIVE |
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
|
PRIMITIVE |
or(boolean aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
or(byte aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
or(char aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
or(int aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
or(long aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
or(short aValue)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
product(boolean aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(byte aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(char aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(double aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(float aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(int aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(long aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(short aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
quotient(BigDecimal aValue)
Set the value of this scalar to the mathematical quotient between
its current value and the specified value
|
PRIMITIVE |
quotient(boolean aValue)
Set the value of this scalar to the mathematical quotient between
its current value and the specified value
|
PRIMITIVE |
quotient(byte aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotient(char aValue)
Set the value of this scalar to the mathematical quotient between
its current value and the specified value
|
PRIMITIVE |
quotient(double aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotient(float aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotient(int aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotient(long aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotient(short aValue)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
round(RoundingStrategy aRoundingStrategy)
Round the current value using the specified rounding
strategy |
PRIMITIVE |
setMaximum()
Replace the current value with maximum value available for the
implementation's numeric
precision . |
PRIMITIVE |
setMinimum()
Replace the current value with minimum value available for the
implementation's numeric
precision . |
PRIMITIVE |
setPrimitive(SealedPrimitive<?> aValue)
Set this property to the specified primitive
|
PRIMITIVE |
setReal(BigDecimal aValue)
Set this property to the specified unlimited
decimal
value and answer this object (facilitates chaining) |
PRIMITIVE |
setReal(SealedReal<?> aValue)
Set this property to the specified numeric
primitive and answer this object (facilitates chaining) |
PRIMITIVE |
setScalar(boolean aValue)
Set this property to the specified
boolean value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(byte aValue)
Set this property to the specified
byte value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(char aValue)
Set this property to the specified
char value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(double aValue)
Set this property to the specified
double value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(float aValue)
Set this property to the specified
float value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(int aValue)
Set this property to the specified
int value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(long aValue)
Set this property to the specified
long value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(SealedScalar<?> aValue)
Set this object to the specified scalar
|
PRIMITIVE |
setScalar(short aValue)
Set this property to the specified
short value and answer this
object (facilitates chaining) |
PRIMITIVE |
setUnity()
Replace the current value with the multiplicative identity appropriate
for the implementation (one)
|
PRIMITIVE |
setZero()
Replace the current value with the additive identity appropriate for the
implementation (zero)
|
PRIMITIVE |
shiftLeft(int count)
Attempt to shift the elements of this tuple to the "left" the specified
number of ordinal positions.
|
PRIMITIVE |
shiftRight(int count)
Attempt to shift the elements of this tuple to the "right" the specified
number of ordinal positions.
|
short |
shortPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
short |
shortPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
short |
shortValue() |
int |
signum() |
int |
size()
Returns the number of elements in this algebraic structure.
|
PRIMITIVE |
square()
Replace the current value with the square of itself
|
PRIMITIVE |
sum(boolean aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(byte aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(char aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(double aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(float aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(int aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(long aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(short aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
swapPrimitives(Primitive<?> aPrimitive)
Swap the value of this primitive for the specified one and set the
specified primitive's value to the current value of this primitive
|
Number |
toNumber() |
Scalar<?> |
toScalar()
If this scalar is already a
scalar then simply
call its Replicator.copy() function, otherwise produce a new scalar
with scalar precision |
String |
toString() |
BigDecimal |
toUnlimitedDecimal() |
BigDecimal |
unlimitedDecimalPostDecrement()
Decrement the real value of this object then return the original value
prior to decrementing
|
BigDecimal |
unlimitedDecimalPostIncrement()
Increment the real value of this object then return the original value
prior to incrementing
|
BigInteger |
unlimitedIntegerPostDecrement()
Decrement the real value of this object then return the original value
prior to decrementing
|
BigInteger |
unlimitedIntegerPostIncrement()
Increment the real value of this object then return the original value
prior to incrementing
|
PRIMITIVE |
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
|
PRIMITIVE |
xor(boolean aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xor(byte aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xor(char aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xor(int aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xor(long aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xor(short aValue)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, charAt, clear, clearContents, clearText, codePointAt, codePointBefore, codePointCount, compareTo, compareToPrimitive, copyUsingText, delete, deleteCharAt, equals, indexOfText, indexOfText, inducePostDecrement, inducePostIncrement, inducePrimitiveValue, induceTextValue, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, isEmpty, isEqualToPrimitive, isEqualToText, isGreaterOrEqualToPrimitive, isGreaterOrEqualToText, isGreaterThanPrimitive, isGreaterThanText, isLessOrEqualToPrimitive, isLessOrEqualToText, isLessThanPrimitive, isLessThanText, isNotEqualToPrimitive, isNotEqualToText, isText, length, lowerCase, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, setBoolean, setCharacter, setCharAt, setLength, setNumber, setText, subSequence, substring, substring, textPostDecrement, textPostIncrement, titleCase, toPrimitive, toPrimitive, trim, upperCase
andOfPrimitive, angleWithPrimitive, compareToText, differenceOfPrimitive, hypotenuseWithPrimitive, inducePrimitiveMaximum, inducePrimitiveMinimum, induceTextSize, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, toPrimitive, xorOfPrimitive
and, andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, difference, difference, differenceOfNumber, differenceOfReal, gcd, gcdOfNumber, gcdOfReal, hypotenuseWithReal, induceRealSize, isEqual, isEqual, isEqualToNumber, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToReal, isGreaterThanNumber, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToReal, isLessThanNumber, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToReal, mod, mod, modOfNumber, modOfReal, orOfNumber, orOfReal, powerOfReal, product, product, productOfNumber, productOfReal, quotient, quotientOfNumber, quotientOfReal, sum, sum, sumOfNumber, sumOfReal, toReal, unlimitedIntegerModularInverse, xorOfNumber, xorOfReal
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, 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, isAlphabetic, isBmpCodePoint, isConfigurable, isCountable, isDigit, isElastic, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isExpandable, isFalse, 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, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isOrdered, isReducible, isSupplementaryCodePoint, isSurrogate, isTitleCase, isTrue, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUnique, isUpperCase, isValid, isValidCodePoint, isWhitespace, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longSize, longValue, milliseconds, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, orOfScalar, power, power, powerOfNumber, powerOfScalar, productOfScalar, promoteTo, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setEnumeration, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setNegativeInfinity, setPi, setPositiveInfinity, setShortBitAt, setTrue, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, shiftRightExtendZero, shortMaskAt, shortNotMaskAt, shortValue, sine, squareRoot, sumOfScalar, tangent, toBoolean, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toCharacter, toCodePoint, toEnumeration, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xorOfScalar
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copyUsingPrimitive
compareToReal, compareToReal, compareToReal, isEqual, isEqual, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToReal, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToReal, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToReal
compareToNumber, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToNumber, isEqualToScalar, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToScalar, isGreaterThanNumber, isGreaterThanScalar, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToScalar, isLessThanNumber, isLessThanScalar, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToScalar, isTrue, toBoolean, toCharacter, toCodePoint, toEnumeration
getConcurrency
isImaginary, isValid
isAlphabetic, isBmpCodePoint, isDigit, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isSupplementaryCodePoint, isSurrogate, isTitleCase, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUpperCase, isValidCodePoint, isWhitespace
getPrecision
induceRealSize
induceScalarSize
getDomain, longSize
isConfigurable, isCountable, isElastic, isExpandable, isOrdered, isReducible, isUnique
copyUsing, copyUsing, copyUsingReal, toReal
copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsingScalar
copy
and, andOfReal, angleWithReal, difference, difference, differenceOfReal, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, modOfReal, orOfReal, powerOfReal, product, product, productOfReal, quotient, quotientOfReal, sum, sum, sumOfReal, xorOfReal
andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, decrement, degrees, differenceOfNumber, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, increment, milliseconds, modOfNumber, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, productOfNumber, productOfScalar, quotientOfNumber, quotientOfScalar, radians, random, setE, setEnumeration, setNegativeInfinity, setPi, setPositiveInfinity, shiftRightExtendZero, sine, squareRoot, sumOfNumber, sumOfScalar, tangent, up, xorOfNumber, xorOfScalar
setFalse, setTrue
assertPrecision, promoteTo
assertDomain
toUnlimitedInteger
setReal
public AbstractUnlimitedIntegerPrimitive()
public AbstractUnlimitedIntegerPrimitive(BigDecimal aValue)
public AbstractUnlimitedIntegerPrimitive(BigInteger aValue)
public AbstractUnlimitedIntegerPrimitive(boolean aValue)
public AbstractUnlimitedIntegerPrimitive(byte aValue)
public AbstractUnlimitedIntegerPrimitive(char aValue)
public AbstractUnlimitedIntegerPrimitive(Domain aDomain)
public AbstractUnlimitedIntegerPrimitive(Domain aDomain, BigInteger aValue)
public AbstractUnlimitedIntegerPrimitive(double aValue)
public AbstractUnlimitedIntegerPrimitive(float aValue)
public AbstractUnlimitedIntegerPrimitive(int aValue)
public AbstractUnlimitedIntegerPrimitive(long aValue)
public AbstractUnlimitedIntegerPrimitive(SealedPrimitive<?> aValue)
public AbstractUnlimitedIntegerPrimitive(SealedReal<?> aValue)
public AbstractUnlimitedIntegerPrimitive(short aValue)
public AbstractUnlimitedIntegerPrimitive(String aValue)
public final PRIMITIVE absoluteValue() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
absoluteValue
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
absoluteValue
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE and(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE and(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE and(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE and(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE and(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE and(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
and
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
and
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final boolean booleanPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final boolean booleanPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final boolean booleanValue()
boolean
public final byte bytePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final byte bytePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final byte byteValue()
byteValue
in interface SealedByteValue
byteValue
in class Number
byte
public final char charPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final char charPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final char charValue()
char
public final PRIMITIVE cube() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE difference(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
difference
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a subtrahendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final double doublePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final double doublePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final double doubleValue()
doubleValue
in interface SealedDoubleValue
doubleValue
in class Number
double
public final float floatPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final float floatPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final float floatValue()
floatValue
in interface SealedFloatValue
floatValue
in class Number
float
public final StructureStrategy getStructureStrategy()
getStructureStrategy
in interface SealedAlgebraicStructure
getStructureStrategy
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final int hashCode()
hashCode
in interface SealedKernel
hashCode
in class Object
public final <R extends Real<?>> R inducePostDecrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostDecrement
in interface RealInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostDecrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- a target into which the current value of this real will be
induced, prior to decrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <S extends Scalar<?>> S inducePostDecrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
induced, prior to decrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <R extends Real<?>> R inducePostIncrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostIncrement
in interface RealInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostIncrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- a target into which the current value of this real will be
induced, prior to incrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <S extends Scalar<?>> S inducePostIncrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
induced, prior to incrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <R extends Real<?>> R induceRealMaximum(R aTarget)
SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic final <R extends Real<?>> R induceRealMinimum(R aTarget)
SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic final <R extends Real<?>> R induceRealValue(R aTarget)
RealInductor
R
- the target typeaTarget
- a target into which the current value of this real will be
inducedpublic final <S extends Scalar<?>> S induceScalarMaximum(S aTarget)
SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic final <S extends Scalar<?>> S induceScalarMinimum(S aTarget)
SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic final <S extends Scalar<?>> S induceScalarValue(S aTarget)
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
inducedpublic final int intPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final int intPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final int intValue()
intValue
in interface SealedIntegerValue
intValue
in class Number
int
public PRIMITIVE invalidate() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
INVALID
if possible, otherwise replace it with zeroinvalidate
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
invalidate
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE inverse() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
1/x
)UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final boolean isFinite()
isFinite
in interface NumericProperties
isFinite
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this value represents a valid and finite valuepublic final boolean isInfinity()
public final boolean isInvalid()
public final boolean isMaximum()
true
if this value represents the maximum rational value
in the totally ordered set it representspublic final boolean isMinimum()
true
if this value represents the minimum rational value
in the totally ordered set it representspublic final boolean isModulo()
NumericProperties
true
if this value represents the magnitude of a vector
into a modulo set, or finite ring. This is not the same as testing
whether this object's implementation resembles the specification for the
MODULO
domain, since that is too specific to
implementation machinery. Modulo values, for instance can either be
real
or imaginary
.true
if this value represents the magnitude of a vector
into a modulo set, or finite ringpublic final boolean isNegative()
true
if this value represents a negative valuepublic final boolean isNegativeFinite()
isNegativeFinite
in interface NumericProperties
isNegativeFinite
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this value represents a valid, finite and
negative valuepublic final boolean isNegativeInfinity()
true
if this value represents negative
infinitypublic final boolean isPositive()
true
if this value represents a positive valuepublic final boolean isPositiveFinite()
isPositiveFinite
in interface NumericProperties
isPositiveFinite
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this value represents a valid, finite and
negative valuepublic final boolean isPositiveInfinity()
true
if this value represents positive
infinitypublic final boolean isReal()
NumericProperties
true
if this value represents the magnitude of a vector
into the set of real numbers. This is not the same as testing whether
this object's implementation resembles the specification for the
REAL
domain, since that is too specific to
implementation machinery. This more general test also includes real
modulo
values in its specification.true
if this value represents the magnitude of a vector
into the set of real numberspublic final boolean isUnity()
NumericProperties
true
if this value represents the multiplicative
identity in its arithmetic domain. For real numbers this is 1, for
matrices it would be the identity matrix and for functions this
would be a pass-through.true
if this value represents the multiplicative
identity in its domainpublic final boolean isZero()
NumericProperties
true
if this value represents the additive identity
in its algebraic group. For real numbers this is 0, for matrices this
would be the zero matrix and for functions this would map every
parameter to zero.true
if this value represents the additive
identity in its algebraic grouppublic final long longPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final long longPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final long longValue()
longValue
in interface SealedLongValue
longValue
in class Number
long
public final PRIMITIVE mod(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE mod(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
mod
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a modulusUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE negate() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
boolean
and char
values do not exist, these
implementations will simply fail silently.)UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this object (optional)IllegalArgumentException
- if the new value was incommensurate with this object's
specification (optional)public final PRIMITIVE not() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
double
, will be first
converted to unlimited integers
before their bits are
reversed.UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
or
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE or(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
or
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
or
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE product(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
product
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a multiplicandUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
quotient
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE quotient(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotient
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotient
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a divisorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE round(RoundingStrategy aRoundingStrategy) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableScalar
strategy
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectNullPointerException
public final PRIMITIVE setMaximum() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
precision
. Unlimited
values will be replaced with the maximum value available for the most
precise system scalar appropriate for the implementation, that is
unlimited integer
primitives will set
themselves to the maximum
long
value and
unlimited decimal
primitives will set
themselves to the maximum
double
value.UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE setMinimum() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
precision
. Unlimited
values will be replaced with the minimum value available for the most
precise system scalar appropriate for the implementation, that is
unlimited integer
primitives will set
themselves to the minimum
long
value and
unlimited decimal
primitives will set
themselves to the minimum
double
value.UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE setPrimitive(SealedPrimitive<?> aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
setPrimitive
in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
setPrimitive
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a primitiveUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setReal(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedDecimalValue
decimal
value and answer this object (facilitates chaining)aValue
- an unlimited decimal
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setReal(SealedReal<?> aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableReal
primitive
and answer this object (facilitates chaining)setReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
setReal
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a numeric primitive
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setScalar(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableBooleanValue
boolean
value and answer this
object (facilitates chaining)aValue
- a boolean
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableByteValue
byte
value and answer this
object (facilitates chaining)aValue
- a byte
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableCharacterValue
char
value and answer this
object (facilitates chaining)aValue
- a char
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableDoubleValue
double
value and answer this
object (facilitates chaining)aValue
- a double
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableFloatValue
float
value and answer this
object (facilitates chaining)aValue
- a float
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableIntegerValue
int
value and answer this
object (facilitates chaining)aValue
- an int
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableLongValue
long
value and answer this
object (facilitates chaining)aValue
- a long
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(SealedScalar<?> aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableScalar
setScalar
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalarUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setScalar(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableShortValue
short
value and answer this
object (facilitates chaining)aValue
- a short
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setUnity() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
setUnity
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setUnity
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setZero() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
setZero
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setZero
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE shiftLeft(int count) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
<<
). In other
sequences, the specified number of default values will be prepended to
the beginning of the sequence, increasing the ordinal position of all
existing elements by the specified count.count
- the number of default values to be prepended to this sequenceUnsupportedOperationException
- if this object's value cannot be changed or if this structure is
not an algebraic tupleIllegalArgumentException
- if the specified value was incommensurate with this structure's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this structurepublic final PRIMITIVE shiftRight(int count) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
>>
operator). In other sequences, the specified number of values
will be removed from the beginning of the sequence, decreasing the
ordinal position of all remaining elements by the specified count.count
- the number of values to be removed from the beginning of this
sequenceUnsupportedOperationException
- if this object's value cannot be changed or if this structure is
not an algebraic tupleIllegalArgumentException
- if the specified value was incommensurate with this structure's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this structurepublic final short shortPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final short shortPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final short shortValue()
shortValue
in interface SealedShortValue
shortValue
in class Number
short
public final int signum()
signum
in interface NumericProperties
signum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
zero
, -1 if this number
is negative
or +1 if it is
positive
public final int size()
SealedAlgebraicStructure
Integer.MAX_VALUE
elements, returns
Integer.MAX_VALUE
.size
in interface SealedAlgebraicStructure
size
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
Collection.size()
public final PRIMITIVE square() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE sum(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sum
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an addendUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE swapPrimitives(Primitive<?> aPrimitive)
Primitive
aPrimitive
- the primitive to swap withpublic final Number toNumber()
Number
objectpublic final Scalar<?> toScalar()
ScalarReplicator
scalar
then simply
call its Replicator.copy()
function, otherwise produce a new scalar
with scalar precisiontoScalar
in interface ScalarReplicator<PRIMITIVE extends Primitive<PRIMITIVE>>
toScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final String toString()
toString
in interface CharSequence
toString
in interface SealedKernel
toString
in class Object
public final BigDecimal toUnlimitedDecimal()
decimal
property valuepublic final BigDecimal unlimitedDecimalPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigDecimal unlimitedDecimalPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigInteger unlimitedIntegerPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigInteger unlimitedIntegerPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE xor(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
xor
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE xor(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xor
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xor
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an integral boolean vectorUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectCopyright © 2006-2012 Ware-Squared Software Development. All Rights Reserved.