PRIMITIVE
- this primitive type (used to facilitate operation chaining on write
operations)public abstract class AbstractTextPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>> extends AbstractPrimitive<PRIMITIVE>
NaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI
Constructor and Description |
---|
AbstractTextPrimitive() |
AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator) |
AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator,
PrimitiveAction<Primitive<?>> aRealTranslator) |
AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator,
PrimitiveAction<Primitive<?>> aRealTranslator,
PrimitiveAction<Primitive<?>> aScalarTranslator) |
Modifier and Type | Method and Description |
---|---|
PRIMITIVE |
absoluteValue()
Replace the current value with the absolute value of itself
|
PRIMITIVE |
andOfNumber(Number aNumber)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
andOfReal(SealedReal<?> aReal)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
angleWithReal(SealedReal<?> y)
Set this value to the angle formed by the rectangular coordinates given
by the current value, x, and the specified value, y.
|
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 |
clearContents()
Clear all elements of this structure and answer this object (facilitates
chaining}.
For text primitives all characters will be removed in an exact analog to clear() . |
PRIMITIVE |
clearText()
Clear all characters from this primitive and re-interpret/re-set
|
int |
compareTo(SealedPrimitive<?> aPrimitive) |
int |
compareToNumber(Number aValue)
Compares this object with the specified object for order
|
int |
compareToPrimitive(SealedPrimitive<?> aPrimitive)
Compares this object with the specified object for order
|
int |
compareToReal(SealedReal<?> aReal)
Compares this object with the specified object for order
|
PRIMITIVE |
copyUsing(BigDecimal aValue)
Using this real as a factory, produce a new real of the
same type but initialized with the value specified
|
PRIMITIVE |
copyUsing(BigInteger aValue)
Using this real as a factory, produce a new real of the
same type but initialized with the value specified
|
PRIMITIVE |
copyUsing(boolean aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(byte aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(char aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(double aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(float aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(int aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(long aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsing(short aValue)
Using this object as a factory, produce a new scalar of an
appropriately matching type but initialized with the value specified
|
PRIMITIVE |
copyUsingPrimitive(SealedPrimitive<?> aValue)
Using this primitive as a factory, produce a new primitive of the same
type but initialized with the value specified
|
PRIMITIVE |
copyUsingReal(SealedReal<?> aValue)
Using this real as a factory, produce a new real of the
same type but initialized with the value specified
|
PRIMITIVE |
copyUsingScalar(SealedScalar<?> aValue)
Using this scalar as a factory, produce a new scalar of the
same type but initialized with the value specified
|
PRIMITIVE |
cube()
Replace the current value with the cube of itself
|
PRIMITIVE |
decrement()
Replace the current value with the current value minus unity (one)
|
PRIMITIVE |
differenceOfNumber(Number aNumber)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
differenceOfReal(SealedReal<?> aReal)
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() |
boolean |
equals(Object anObject) |
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() |
PrimitiveAction<Primitive<?>> |
getPrimitiveTranslator() |
PrimitiveAction<Primitive<?>> |
getRealTranslator() |
PrimitiveAction<Primitive<?>> |
getScalarTranslator() |
StructureStrategy |
getStructureStrategy() |
int |
hashCode() |
PRIMITIVE |
increment()
Replace the current value with the current value plus unity (one)
|
<P extends Primitive<?>> |
inducePostDecrement(P aTarget)
Decrement the value of this Primitive then induce its original value into
the specified target
|
<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
|
<P extends Primitive<?>> |
inducePostIncrement(P aTarget)
Increment the value of this Primitive 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
|
<P extends Primitive<?>> |
inducePrimitiveValue(P aTarget)
Induce the current value of this Primitive 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 |
isConfigurable()
|
boolean |
isElastic()
Answer
true if this structure, in principle, can be
reduced via element removal or expanded via element addition. |
boolean |
isEqualToNumber(Number aValue) |
boolean |
isEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isEqualToReal(SealedReal<?> aReal) |
boolean |
isEqualToScalar(SealedScalar<?> aScalar) |
boolean |
isEqualToText(CharSequence aValue) |
boolean |
isExpandable() |
boolean |
isGreaterOrEqualToNumber(Number aValue) |
boolean |
isGreaterOrEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isGreaterOrEqualToReal(SealedReal<?> aReal) |
boolean |
isGreaterOrEqualToScalar(SealedScalar<?> aScalar) |
boolean |
isGreaterOrEqualToText(CharSequence aValue) |
boolean |
isGreaterThanNumber(Number aValue) |
boolean |
isGreaterThanPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isGreaterThanReal(SealedReal<?> aReal) |
boolean |
isGreaterThanScalar(SealedScalar<?> aScalar) |
boolean |
isGreaterThanText(CharSequence aValue) |
boolean |
isInfinity() |
boolean |
isInvalid() |
boolean |
isLessOrEqualToNumber(Number aValue) |
boolean |
isLessOrEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isLessOrEqualToReal(SealedReal<?> aReal) |
boolean |
isLessOrEqualToScalar(SealedScalar<?> aScalar) |
boolean |
isLessOrEqualToText(CharSequence aValue) |
boolean |
isLessThanNumber(Number aValue) |
boolean |
isLessThanPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isLessThanReal(SealedReal<?> aReal) |
boolean |
isLessThanScalar(SealedScalar<?> aScalar) |
boolean |
isLessThanText(CharSequence aValue) |
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 |
isNotEqualToNumber(Number aValue) |
boolean |
isNotEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isNotEqualToReal(SealedReal<?> aReal) |
boolean |
isNotEqualToScalar(SealedScalar<?> aScalar) |
boolean |
isNotEqualToText(CharSequence aValue) |
boolean |
isOrdered()
Answer
true if the elements of this structure necessarily
share a partial or total order between each other within the context of
this structure. |
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 |
isReducible()
Answer
true if this structure, in principle, can be
reduced via element removal. |
boolean |
isText() |
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 |
modOfNumber(Number aNumber)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
modOfReal(SealedReal<?> aReal)
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 |
orOfNumber(Number aNumber)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
orOfReal(SealedReal<?> aReal)
Set this value to the bit or of the integral boolean vector
equivalent of this value and the specified integral boolean vector
|
PRIMITIVE |
powerOfReal(SealedReal<?> aReal)
Set this value to the current value, x, raised to the specified
exponent, n, or xn
|
PRIMITIVE |
productOfNumber(Number aNumber)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
productOfReal(SealedReal<?> aReal)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
quotientOfNumber(Number aNumber)
Set the value of this scalar to the mathematical quotient of its
current value and the specified value
|
PRIMITIVE |
quotientOfReal(SealedReal<?> aReal)
Set the value of this scalar to the mathematical quotient between
its current value and the specified value
|
PRIMITIVE |
round(RoundingStrategy aRoundingStrategy)
Round the current value using the specified rounding
strategy |
PRIMITIVE |
setBoolean(Boolean aValue)
Set this property to the specified system-supported
Boolean and
answer this object (facilitates chaining) |
PRIMITIVE |
setCharacter(Character aValue)
Set this property to the specified system-supported
Character and
answer this object (facilitates chaining) |
<E extends Enum<E>> |
setEnumeration(E aValue)
Match the value of this object with the identity of the specified
enumeration instance, then answer this object (facilitates
chaining) |
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 |
setNegativeInfinity()
Replace the current value with a representation of negative infinity, if
available, otherwise replace with the implementation's
minimum value |
PRIMITIVE |
setNumber(Number aValue)
Set this object to the specified system-supported
Number and
answer this object (facilitates chaining) |
PRIMITIVE |
setPositiveInfinity()
Replace the current value with a representation of positive infinity, if
available, otherwise replace with the implementation's
maximum value |
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(BigInteger aValue)
Set this property to the specified unlimited
integer
value and answer this object (facilitates chaining) |
PRIMITIVE |
setReal(SealedReal<?> aReal)
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(short aValue)
Set this property to the specified
short value and answer this
object (facilitates chaining) |
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 |
sumOfNumber(Number aNumber)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sumOfReal(SealedReal<?> aReal)
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
|
String |
textPostDecrement()
Decrement the real value of this text then return the original text prior
to decrementing
|
String |
textPostIncrement()
Increment the real value of this text then return the original text prior
to incrementing
|
int |
toCodePoint()
Represent the value of this object as a code point
|
<E extends Enum<E>> |
toEnumeration(Class<E> anEnumerationClass)
Represent the value of this object as an appropriate member of the class
of the specified
enumeration |
static String |
toLowerFirstCamelCase(String aName) |
Number |
toNumber() |
Real<?> |
toReal()
If this real is already a
real number real
then simply call its Replicator.copy() function, otherwise produce a new
real number real |
Scalar<?> |
toScalar()
If this scalar is already a
scalar then simply
call its Replicator.copy() function, otherwise produce a new scalar
with scalar precision |
BigDecimal |
toUnlimitedDecimal() |
BigInteger |
toUnlimitedInteger() |
static String |
toUpperFirst(String aWord) |
static String |
toUpperFirstCamelCase(String aName) |
PRIMITIVE |
trim()
Remove both leading and trailing
whitespace |
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 |
xorOfNumber(Number aNumber)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
PRIMITIVE |
xorOfReal(SealedReal<?> aReal)
Set this value to the bit exclusive-or of the integral
boolean vector equivalent of this value and the specified integral
boolean vector
|
andOfPrimitive, angleWithPrimitive, compareToText, differenceOfPrimitive, hypotenuseWithPrimitive, inducePrimitiveMaximum, inducePrimitiveMinimum, induceTextSize, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, toPrimitive, xorOfPrimitive
and, compareToReal, compareToReal, difference, difference, gcd, gcdOfNumber, gcdOfReal, hypotenuseWithReal, induceRealSize, isEqual, isEqual, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isLess, isLess, isLessOrEqual, isLessOrEqual, isNotEqual, isNotEqual, mod, mod, or, product, product, quotient, quotient, sum, sum, unlimitedIntegerModularInverse, xor
and, and, and, and, and, and, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, assertDomain, assertPrecision, base10Log, boundsCheck, byteMaskAt, byteNotMaskAt, byteValue, ceiling, charMaskAt, charNotMaskAt, charValue, clearByteBitAt, clearCharBitAt, clearDoubleBitAt, clearFloatBitAt, clearIntBitAt, clearLongBitAt, clearShortBitAt, clearUnlimitedDecimalBitAt, clearUnlimitedIntegerBitAt, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, cosine, cubeRoot, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfScalar, divideByZero, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfScalar, getBooleanBitAt, getByteBitAt, getCharBitAt, getDomain, getDoubleBitAt, getFloatBitAt, getIntBitAt, getLongBitAt, getPrecision, getShortBitAt, getUnlimitedDecimalBitAt, getUnlimitedIntegerBitAt, halfDown, halfEven, halfUp, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, indexOutOfBoundsAt, induceScalarSize, intGCD, intMaskAt, intModularInverse, intModularQuotient, intNotMaskAt, intValue, isAlphabetic, isBmpCodePoint, isCountable, isDigit, isEmpty, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isFalse, isFinite, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isImaginary, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isMutable, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isSupplementaryCodePoint, isSurrogate, isTitleCase, isTrue, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUnique, isUpperCase, isValid, isValidCodePoint, isWhitespace, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longSize, longValue, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, or, or, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfScalar, promoteTo, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setPi, setScalar, setShortBitAt, setTrue, setUnity, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, setZero, shiftRightExtendZero, shortMaskAt, shortNotMaskAt, shortValue, sine, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfScalar, tangent, toBoolean, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toCharacter, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xor, xor, xor, xor, xor, xor, xorOfScalar
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
copyUsingText
compareToReal, compareToReal, isEqual, isEqual, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isLess, isLess, isLessOrEqual, isLessOrEqual, isNotEqual, isNotEqual
compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isTrue, toBoolean, toCharacter
getConcurrency, toString
isFinite, 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
isCountable, isEmpty, isUnique
copy
and, difference, difference, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, or, product, product, quotient, quotient, sum, sum, xor
and, and, and, and, and, and, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, or, or, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfScalar, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, setE, setPi, setScalar, setUnity, setZero, shiftRightExtendZero, sine, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfScalar, tangent, up, xor, xor, xor, xor, xor, xor, xorOfScalar
setFalse, setTrue
assertPrecision, promoteTo
assertDomain, clear
induceTextValue
copyUsingText
codePointAt, codePointBefore, codePointCount, indexOfText, indexOfText, substring, substring
charAt, length, subSequence, toString
isEmpty
append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, clear, delete, deleteCharAt, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, lowerCase, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, setCharAt, setLength, setText, titleCase, upperCase
public AbstractTextPrimitive()
public AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator)
public AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator, PrimitiveAction<Primitive<?>> aRealTranslator)
public AbstractTextPrimitive(PrimitiveAction<Primitive<?>> aPrimitiveTranslator, PrimitiveAction<Primitive<?>> aRealTranslator, PrimitiveAction<Primitive<?>> aScalarTranslator)
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 andOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
andOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
andOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 andOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
andOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
andOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 angleWithReal(SealedReal<?> y) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
angleWithReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
angleWithReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
y
- a y coordinate valueUnsupportedOperationException
- 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 objectMath.atan2(double, double)
public 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 clearContents() throws UnsupportedOperationException
MutableAlgebraicStructure
clear()
. For bit tuples such as scalar
primitives, this will reset all bits zero
since those elements cannot be removed. For
unlimited
primitives all bytes in the
representation will be removed, producing zero.clear()
, which does not return a value.
This function, in answering this object, facilitates operation chaining.UnsupportedOperationException
- if this object's value cannot be changedMutableAlgebraicStructure.clear()
,
Collection.clear()
,
MutableTextValue.clearText();
public final PRIMITIVE clearText() throws UnsupportedOperationException
MutableTextValue
UnsupportedOperationException
- if this object's text cannot be changedMutableTextValue.clear();
,
Collection.clear()
,
MutableAlgebraicStructure.clearContents()
public final int compareTo(SealedPrimitive<?> aPrimitive)
public final int compareToNumber(Number aValue)
SealedScalar
compareToNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- an object to be compared toComparable.compareTo(Object)
public final int compareToPrimitive(SealedPrimitive<?> aPrimitive)
SealedPrimitive
aPrimitive
- an object to be compared toComparable.compareTo(Object)
public final int compareToReal(SealedReal<?> aReal)
SealedReal
compareToReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- an object to be compared toComparable.compareTo(Object)
public final PRIMITIVE copyUsing(BigDecimal aValue)
RealReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(BigInteger aValue)
RealReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(boolean aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(byte aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(char aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(double aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(float aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(int aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(long aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsing(short aValue)
ScalarReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsingPrimitive(SealedPrimitive<?> aValue)
PrimitiveReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsingReal(SealedReal<?> aValue)
RealReplicator
aValue
- a new valuepublic final PRIMITIVE copyUsingScalar(SealedScalar<?> aValue)
ScalarReplicator
aValue
- a new valuepublic 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 decrement() 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 differenceOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
differenceOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
differenceOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 differenceOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
differenceOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
differenceOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 boolean equals(Object anObject)
equals
in interface SealedKernel
equals
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PrimitiveAction<Primitive<?>> getPrimitiveTranslator()
public final PrimitiveAction<Primitive<?>> getRealTranslator()
public final PrimitiveAction<Primitive<?>> getScalarTranslator()
public final StructureStrategy getStructureStrategy()
public final int hashCode()
hashCode
in interface SealedKernel
hashCode
in class Object
public final PRIMITIVE increment() 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 <P extends Primitive<?>> P inducePostDecrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
P
- the target typeaTarget
- a target into which the current value of this Primitive 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 inducePostDecrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
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 <P extends Primitive<?>> P inducePostIncrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
P
- the target typeaTarget
- a target into which the current value of this Primitive 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 inducePostIncrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
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 <P extends Primitive<?>> P inducePrimitiveValue(P aTarget)
PrimitiveInductor
P
- the target typeaTarget
- a target into which the current value of this Primitive will be
inducedpublic 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 final 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 boolean isConfigurable()
StructureProperties
true
if the implementation of this object can be changed.expanded
, or reduced
, or has replaceable
components. Configurable structures are necessarily
mutable
; in fact, "configurability" can be
used as a strict definition of mutability. This predicate however
overrides #isMutable
in the respect that, for some types of
objects such as Variants
, mutability can be changed by
switching from a non-mutable implementation to a mutable one (e.g., via
assertPrecision
).isConfigurable
in interface StructureProperties
isConfigurable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the implementation of this object can be changedpublic boolean isElastic()
StructureProperties
true
if this structure, in principle, can be
reduced via element removal or expanded via element addition. Empty
collections are, in principle, reducible, but read-only
collections are neither reducible or expandable.isElastic
in interface StructureProperties
isElastic
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure can be either
reduced
or expanded
public final boolean isEqualToNumber(Number aValue)
isEqualToNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqualToNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isEqualToPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isEqualToReal(SealedReal<?> aReal)
isEqualToReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqualToReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isEqualToScalar(SealedScalar<?> aScalar)
isEqualToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqualToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isEqualToText(CharSequence aValue)
public boolean isExpandable()
isExpandable
in interface StructureProperties
isExpandable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure can be expanded via element
insertionpublic final boolean isGreaterOrEqualToNumber(Number aValue)
isGreaterOrEqualToNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqualToNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterOrEqualToPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isGreaterOrEqualToReal(SealedReal<?> aReal)
isGreaterOrEqualToReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqualToReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterOrEqualToScalar(SealedScalar<?> aScalar)
isGreaterOrEqualToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqualToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterOrEqualToText(CharSequence aValue)
public final boolean isGreaterThanNumber(Number aValue)
isGreaterThanNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterThanNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterThanPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isGreaterThanReal(SealedReal<?> aReal)
isGreaterThanReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterThanReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterThanScalar(SealedScalar<?> aScalar)
isGreaterThanScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterThanScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isGreaterThanText(CharSequence aValue)
public final boolean isInfinity()
public final boolean isInvalid()
public final boolean isLessOrEqualToNumber(Number aValue)
isLessOrEqualToNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqualToNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessOrEqualToPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isLessOrEqualToReal(SealedReal<?> aReal)
isLessOrEqualToReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqualToReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessOrEqualToScalar(SealedScalar<?> aScalar)
isLessOrEqualToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqualToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessOrEqualToText(CharSequence aValue)
public final boolean isLessThanNumber(Number aValue)
isLessThanNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessThanNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessThanPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isLessThanReal(SealedReal<?> aReal)
isLessThanReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessThanReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessThanScalar(SealedScalar<?> aScalar)
isLessThanScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessThanScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isLessThanText(CharSequence aValue)
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 isNotEqualToNumber(Number aValue)
isNotEqualToNumber
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqualToNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isNotEqualToPrimitive(SealedPrimitive<?> aPrimitive)
public final boolean isNotEqualToReal(SealedReal<?> aReal)
isNotEqualToReal
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqualToReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isNotEqualToScalar(SealedScalar<?> aScalar)
isNotEqualToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqualToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isNotEqualToText(CharSequence aValue)
public final boolean isOrdered()
StructureProperties
true
if the elements of this structure necessarily
share a partial or total order between each other within the context of
this structure. Ordering does not necessarily imply a simple sequencing
between randomly selected elements, but rather a necessary sorting order
between elements independent of the sets they are related by. A
SortedSet
is ordered, not merely because its elements are de
facto sorted, but because the SortedSet
defines a universe in
which only sortable elements can exist and it defines a sorting function
which places those elements in their sorted order at the time of
iteration. An ordered
set has elements with values that are reflexive, antisymmetric, and
transitive relative to each other. Necessarily empty sets are not
considered ordered.isOrdered
in interface StructureProperties
isOrdered
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the structure has either a partial or total order
over its elementspublic final boolean isPositive()
true
if this value represents a positive valuepublic 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 isReducible()
StructureProperties
true
if this structure, in principle, can be
reduced via element removal. Empty collections are, in principle,
reducible, but read-only collections are not.isReducible
in interface StructureProperties
isReducible
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure, in principle, can be
reduced via element removalpublic final boolean isText()
true
if this object utilizes a text-based implementationpublic 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 modOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
modOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
modOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 modOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
modOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
modOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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, ArithmeticException, IllegalArgumentException
MutableScalar
double
, will be first
converted to unlimited integers
before their bits are
reversed.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 orOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
orOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
orOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 orOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
orOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
orOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 powerOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
powerOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
powerOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- an exponentUnsupportedOperationException
- 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 productOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
productOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
productOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 productOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
productOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
productOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 quotientOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
quotientOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
quotientOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 quotientOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
quotientOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
quotientOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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
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 objectpublic final PRIMITIVE setBoolean(Boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
Boolean
and
answer this object (facilitates chaining)aValue
- a system-supported Boolean
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 setCharacter(Character aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
Character
and
answer this object (facilitates chaining)aValue
- a system-supported Character
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 <E extends Enum<E>> PRIMITIVE setEnumeration(E aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException, NullPointerException
MutableScalar
enumeration
instance, then answer this object (facilitates
chaining)setEnumeration
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setEnumeration
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a system-supported enumeration
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic 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 setNegativeInfinity() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
minimum
valuesetNegativeInfinity
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setNegativeInfinity
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 PRIMITIVE setNumber(Number aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableScalar
Number
and
answer this object (facilitates chaining)setNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a system-supported Number
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 setPositiveInfinity() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
maximum
valuesetPositiveInfinity
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setPositiveInfinity
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 setPrimitive(SealedPrimitive<?> aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
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(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedIntegerValue
integer
value and answer this object (facilitates chaining)aValue
- an unlimited integer
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<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
primitive
and answer this object (facilitates chaining)setReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
setReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 objectpublic 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(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 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 sumOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sumOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sumOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 sumOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
sumOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
sumOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 String textPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
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 String textPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
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 toCodePoint()
SealedScalar
toCodePoint
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
toCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final <E extends Enum<E>> E toEnumeration(Class<E> anEnumerationClass) throws ArithmeticException, IllegalArgumentException, NullPointerException
SealedScalar
enumeration
toEnumeration
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
toEnumeration
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
anEnumerationClass
- the class of enumeration
to convert toArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final Number toNumber()
Number
objectpublic final Real<?> toReal()
RealReplicator
real
number real
then simply call its Replicator.copy()
function, otherwise produce a new
real number realtoReal
in interface RealReplicator<PRIMITIVE extends Primitive<PRIMITIVE>>
toReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public 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 BigDecimal toUnlimitedDecimal()
decimal
property valuepublic final BigInteger toUnlimitedInteger()
integer
property valuepublic final PRIMITIVE trim() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableTextValue
whitespace
UnsupportedOperationException
IllegalArgumentException
ArithmeticException
public 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 xorOfNumber(Number aNumber) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
xorOfNumber
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
xorOfNumber
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aNumber
- 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 xorOfReal(SealedReal<?> aReal) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
xorOfReal
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
xorOfReal
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aReal
- 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 static final String toLowerFirstCamelCase(String aName)
public static final String toUpperFirst(String aWord)
public static final String toUpperFirstCamelCase(String aName)
Copyright © 2006-2012 Ware-Squared Software Development. All Rights Reserved.