PRIMITIVE
- this primitive type (used to facilitate operation chaining on write
operations)public abstract class AbstractPrimitiveWrapper<PRIMITIVE extends Primitive<PRIMITIVE>> extends AbstractPrimitive<PRIMITIVE> implements Primitive<PRIMITIVE>
primitive
wrapper, ready to be overridden and
missing only the protected getTarget()
and the explicit
copy
functionsNaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI
Constructor and Description |
---|
AbstractPrimitiveWrapper() |
Modifier and Type | Method and Description |
---|---|
PRIMITIVE |
absoluteValue()
Replace the current value with the absolute value of itself
|
PRIMITIVE |
and(BigInteger aValue)
Set this value to the bit and of the integral boolean
vector equivalent of this value and the specified integral boolean vector
|
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
|
PRIMITIVE |
angleWith(double aValue)
Set this value to the angle formed by the rectangular coordinates given
by the current value, x, and the specified value, y.
|
PRIMITIVE |
append(boolean aValue) |
PRIMITIVE |
append(char c) |
PRIMITIVE |
append(char[] content) |
PRIMITIVE |
append(char[] content,
int contentIndex) |
PRIMITIVE |
append(char[] content,
int contentIndex,
int contentLength) |
PRIMITIVE |
append(CharSequence s) |
PRIMITIVE |
append(CharSequence content,
int contentStartIndex) |
PRIMITIVE |
append(CharSequence s,
int start,
int end) |
PRIMITIVE |
append(double aValue) |
PRIMITIVE |
append(float aValue) |
PRIMITIVE |
append(int aValue) |
PRIMITIVE |
append(long aValue) |
PRIMITIVE |
append(Object aValue) |
PRIMITIVE |
append(StringBuffer sb) |
PRIMITIVE |
appendCodePoint(int codePoint) |
PRIMITIVE |
arcCosine()
Replace the current value with its arc
cosine |
PRIMITIVE |
arcSine()
Replace the current value with its arc
sine |
PRIMITIVE |
arcTangent()
Replace the current value with its arc
tangent |
PRIMITIVE |
assertDomain(Domain aDomain)
Attempt to convert the implementation
domain of this
structure to the closest available match for the proposed domain. |
PRIMITIVE |
assertPrecision(NumericPrecision prec)
Convert the numeric
precision of this
implementation to the closest available match for the proposed precision. |
PRIMITIVE |
base10Log()
Replace the current value with its base 10 logarithm
|
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 |
charAt(int index) |
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() |
void |
clear()
Same as
Collection.clear() . |
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 |
codePointAt(int index) |
int |
codePointBefore(int index) |
int |
codePointCount(int beginIndex,
int endIndex) |
int |
compareTo(SealedPrimitive<?> o) |
int |
compareToPrimitive(SealedPrimitive<?> aPrimitive)
Compares this object with the specified object for order
|
int |
compareToScalar(boolean aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(byte aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(char aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(double aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(float aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(int aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(long aValue)
Compares this object with the specified scalar for order
|
int |
compareToScalar(short aValue)
Compares this object with the specified scalar for order
|
int |
compareToText(CharSequence text)
Compares this object's
text equivalent with the specified
text for order |
int |
compareToZero()
Compares this object with zero for order
|
PRIMITIVE |
cosine()
Replace the current value, assumed to be an angle in radians, to its
cosine |
PRIMITIVE |
cube()
Replace the current value with the cube of itself
|
PRIMITIVE |
cubeRoot()
Replace the current value with the cube root of itself
|
PRIMITIVE |
decrement()
Replace the current value with the current value minus unity (one)
|
PRIMITIVE |
degrees()
Replace the current value, assumed to be an angle in radians, to its
equivalent angle in degrees
|
PRIMITIVE |
delete(int start,
int end) |
PRIMITIVE |
deleteCharAt(int anIndex) |
PRIMITIVE |
difference(BigDecimal aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
PRIMITIVE |
difference(BigInteger aValue)
Set the value of this scalar to the mathematical difference
between its current value and the specified value
|
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() |
boolean |
equals(Object anObject) |
PRIMITIVE |
exponential()
Replace the current value with e (Napier's constant) raised to the
current value (en)
|
PRIMITIVE |
exponentialLessOne()
Replace the current value with e (Napier's constant) raised to the
current value, less 1 (en-1)
|
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() |
PRIMITIVE |
gcd(BigInteger aValue)
Replace the current value with the greatest common denonimator between
this value and the specific one
|
PRIMITIVE |
gcd(byte aValue)
Replace the current value with the greatest common factor between this
value and the specific one
|
PRIMITIVE |
gcd(char aValue)
Replace the current value with the greatest common factor between this
value and the specific one
|
PRIMITIVE |
gcd(int aValue)
Replace the current value with the greatest common factor between this
value and the specific one
|
PRIMITIVE |
gcd(long aValue)
Replace the current value with the greatest common factor between this
value and the specific one
|
PRIMITIVE |
gcd(short aValue)
Replace the current value with the greatest common factor between this
value and the specific one
|
ConcurrencyStrategy |
getConcurrency() |
Domain |
getDomain() |
NumericPrecision |
getPrecision() |
StructureStrategy |
getStructureStrategy() |
protected abstract Primitive<?> |
getTarget() |
int |
hashCode() |
PRIMITIVE |
hyperbolicCosine()
Replace the current value, assumed to be an angle in radians, to its
hyperbolic
cosine |
PRIMITIVE |
hyperbolicSine()
Replace the current value, assumed to be an angle in radians, to its
hyperbolic
sine |
PRIMITIVE |
hyperbolicTangent()
Replace the current value, assumed to be an angle in radians, to its
hyperbolic
tangent |
PRIMITIVE |
increment()
Replace the current value with the current value plus unity (one)
|
int |
indexOfText(CharSequence str) |
int |
indexOfText(CharSequence str,
int beginIndex) |
<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<?>> |
inducePrimitiveMaximum(P aTarget)
Induce the maximum numeric value of the Primitive into the specified
target
|
<P extends Primitive<?>> |
inducePrimitiveMinimum(P aTarget)
Induce the minimum numeric value of the Primitive 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<?>> |
induceRealSize(R aTarget)
Update the target
scalar with the element count in this
structure |
<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
|
<R extends Scalar<?>> |
induceScalarSize(R aTarget)
Update the target
scalar with the element count in this
structure |
<S extends Scalar<?>> |
induceScalarValue(S aTarget)
Induce the current value of this scalar into the specified target
|
<SCALAR extends Scalar<?>> |
induceTextSize(SCALAR aTarget)
Induce the current value of this text into the
scalar
target |
<TEXT extends Text<?>> |
induceTextValue(TEXT aTarget)
Induce the current value of this text into the specified target
|
PRIMITIVE |
insert(int anIndex,
boolean aValue) |
PRIMITIVE |
insert(int anIndex,
char aValue) |
PRIMITIVE |
insert(int anIndex,
char[] content) |
PRIMITIVE |
insert(int targetIndex,
char[] content,
int contentIndex,
int contentLength) |
PRIMITIVE |
insert(int anIndex,
CharSequence content) |
PRIMITIVE |
insert(int targetIndex,
CharSequence content,
int contentIndex) |
PRIMITIVE |
insert(int targetIndex,
CharSequence content,
int contentStartIndex,
int contentEndIndexPlusOne) |
PRIMITIVE |
insert(int anIndex,
double aValue) |
PRIMITIVE |
insert(int anIndex,
float aValue) |
PRIMITIVE |
insert(int anIndex,
int aValue) |
PRIMITIVE |
insert(int anIndex,
long aValue) |
PRIMITIVE |
insert(int anIndex,
Object aValue) |
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 |
isAlphabetic() |
boolean |
isBmpCodePoint() |
boolean |
isConfigurable()
|
boolean |
isCountable()
Answer
true if this structure contains a countable number of
elements. |
boolean |
isDigit()
Determine if this
char -width or int -width
character is a digit within Unicode |
boolean |
isElastic()
Answer
true if this structure, in principle, can be
reduced via element removal or expanded via element addition. |
boolean |
isEmpty()
Answer
true if this structure contains no elements. |
boolean |
isEqual(BigDecimal aValue) |
boolean |
isEqual(BigInteger aValue) |
boolean |
isEqual(boolean aValue) |
boolean |
isEqual(byte aValue) |
boolean |
isEqual(char aValue) |
boolean |
isEqual(double aValue) |
boolean |
isEqual(float aValue) |
boolean |
isEqual(int aValue) |
boolean |
isEqual(long aValue) |
boolean |
isEqual(short aValue) |
boolean |
isEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isEqualToText(CharSequence aValue) |
boolean |
isExpandable() |
boolean |
isFinite() |
boolean |
isGreater(BigDecimal aValue) |
boolean |
isGreater(BigInteger aValue) |
boolean |
isGreater(boolean aValue) |
boolean |
isGreater(byte aValue) |
boolean |
isGreater(char aValue) |
boolean |
isGreater(double aValue) |
boolean |
isGreater(float aValue) |
boolean |
isGreater(int aValue) |
boolean |
isGreater(long aValue) |
boolean |
isGreater(short aValue) |
boolean |
isGreaterOrEqual(BigDecimal aValue) |
boolean |
isGreaterOrEqual(BigInteger aValue) |
boolean |
isGreaterOrEqual(boolean aValue) |
boolean |
isGreaterOrEqual(byte aValue) |
boolean |
isGreaterOrEqual(char aValue) |
boolean |
isGreaterOrEqual(double aValue) |
boolean |
isGreaterOrEqual(float aValue) |
boolean |
isGreaterOrEqual(int aValue) |
boolean |
isGreaterOrEqual(long aValue) |
boolean |
isGreaterOrEqual(short aValue) |
boolean |
isGreaterOrEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isGreaterOrEqualToText(CharSequence aValue) |
boolean |
isGreaterThanPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isGreaterThanText(CharSequence aValue) |
boolean |
isHighSurrogate() |
boolean |
isIdentifierIgnorable()
Determine if this
char -width or int -width
character ignorable character in a Java identifier or a Unicode
identifier |
boolean |
isIdeographic() |
boolean |
isImaginary()
Answer
true if this value represents the magnitude of a vector
into the set of imaginary numbers. |
boolean |
isInfinity() |
boolean |
isInvalid() |
boolean |
isISOControl()
Determine if this
char -width or int -width
character is an ISO control character within Unicode |
boolean |
isJavaIdentifierPart()
Determine if this
char -width or int -width
character is a part of a Java identifier as other than the first
character |
boolean |
isJavaIdentifierStart()
Determine if this
char -width or int -width
character is permissible as the first character in a Java identifier |
boolean |
isLess(BigDecimal aValue) |
boolean |
isLess(BigInteger aValue) |
boolean |
isLess(boolean aValue) |
boolean |
isLess(byte aValue) |
boolean |
isLess(char aValue) |
boolean |
isLess(double aValue) |
boolean |
isLess(float aValue) |
boolean |
isLess(int aValue) |
boolean |
isLess(long aValue) |
boolean |
isLess(short aValue) |
boolean |
isLessOrEqual(BigDecimal aValue) |
boolean |
isLessOrEqual(BigInteger aValue) |
boolean |
isLessOrEqual(boolean aValue) |
boolean |
isLessOrEqual(byte aValue) |
boolean |
isLessOrEqual(char aValue) |
boolean |
isLessOrEqual(double aValue) |
boolean |
isLessOrEqual(float aValue) |
boolean |
isLessOrEqual(int aValue) |
boolean |
isLessOrEqual(long aValue) |
boolean |
isLessOrEqual(short aValue) |
boolean |
isLessOrEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isLessOrEqualToText(CharSequence aValue) |
boolean |
isLessThanPrimitive(SealedPrimitive<?> aPrimitive) |
boolean |
isLessThanText(CharSequence aValue) |
boolean |
isLetter()
Determine if this
char -width or int -width
character is a letter within Unicode |
boolean |
isLetterOrDigit()
Determine if this
char -width or int -width
character is a letter or digit within Unicode |
boolean |
isLowerCase()
Determine if this
char -width or int -width
character is a lower case character within Unicode |
boolean |
isLowSurrogate() |
boolean |
isMaximum() |
boolean |
isMinimum() |
boolean |
isMirrored()
Determine if this
char -width or int -width
character is "mirrored" within Unicode |
boolean |
isModulo()
Answer
true if this value represents the magnitude of a vector
into a modulo set, or finite ring. |
boolean |
isMutable() |
boolean |
isNegative() |
boolean |
isNegativeFinite() |
boolean |
isNegativeInfinity() |
boolean |
isNotEqual(BigDecimal aValue) |
boolean |
isNotEqual(BigInteger aValue) |
boolean |
isNotEqual(boolean aValue) |
boolean |
isNotEqual(byte aValue) |
boolean |
isNotEqual(char aValue) |
boolean |
isNotEqual(double aValue) |
boolean |
isNotEqual(float aValue) |
boolean |
isNotEqual(int aValue) |
boolean |
isNotEqual(long aValue) |
boolean |
isNotEqual(short aValue) |
boolean |
isNotEqualToPrimitive(SealedPrimitive<?> aPrimitive) |
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 |
isSupplementaryCodePoint() |
boolean |
isSurrogate() |
boolean |
isText() |
boolean |
isTitleCase()
Determine if this
char -width or int -width
character is a title case character within Unicode |
boolean |
isUnicode()
Determine if this
char -width or int -width
character is defined within Unicode |
boolean |
isUnicodeIdentifierPart()
Determine if this
char -width or int -width
character is a part of a Unicode identifier as other than the first
character |
boolean |
isUnicodeIdentifierStart()
Determine if this
char -width or int -width
character is permissible as the first character in a Unicode identifier |
boolean |
isUnique() |
boolean |
isUnity()
Answer
true if this value represents the multiplicative
identity in its arithmetic domain. |
boolean |
isUpperCase()
Determine if this
char -width or int -width
character is an upper case character within Unicode |
boolean |
isValidCodePoint() |
boolean |
isWhitespace()
Determine if this
char -width or int -width
character is whitespace within Unicode |
boolean |
isZero()
Answer
true if this value represents the additive identity
in its algebraic group. |
int |
length() |
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 |
longSize()
Returns the number of elements in this algebraic structure as a
long scalar. |
long |
longValue() |
PRIMITIVE |
lowerCase()
For text-based objects, convert all characters in the text to lower case.
|
PRIMITIVE |
milliseconds()
Set the value of this object to the current millisecond-precision system
time |
PRIMITIVE |
mod(BigDecimal aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
PRIMITIVE |
mod(BigInteger aValue)
Set the value of this scalar to its current value modulo of the
specified value
|
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 |
nanoseconds()
Set the value of this object to the current nanosecond-precision system
time |
PRIMITIVE |
naturalLog()
Replace the current value with its base e (Napier's constant)
logarithm (loge(n))
|
PRIMITIVE |
naturalLogPlusOne()
Replace the current value, plus 1, with its base e (Napier's
constant) logarithm (loge(n+1))
|
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 |
power(double n)
Set this value to the current value, x, raised to the specified
exponent, n, or xn
|
PRIMITIVE |
power(int n)
Set this value to the current value, x, raised to the specified
exponent, n, or xn
|
PRIMITIVE |
prepend(boolean aValue) |
PRIMITIVE |
prepend(char aValue) |
PRIMITIVE |
prepend(char[] content) |
PRIMITIVE |
prepend(char[] content,
int contentIndex) |
PRIMITIVE |
prepend(char[] content,
int contentIndex,
int contentLength) |
PRIMITIVE |
prepend(CharSequence content) |
PRIMITIVE |
prepend(CharSequence content,
int contentIndex) |
PRIMITIVE |
prepend(CharSequence content,
int contentStartIndex,
int contentEndIndexPlusOne) |
PRIMITIVE |
prepend(double aValue) |
PRIMITIVE |
prepend(float aValue) |
PRIMITIVE |
prepend(int aValue) |
PRIMITIVE |
prepend(long aValue) |
PRIMITIVE |
prepend(Object aValue) |
PRIMITIVE |
product(BigDecimal aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
PRIMITIVE |
product(BigInteger aValue)
Set the value of this scalar to the mathematical product of its
current value and the specified value
|
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 |
promoteTo(NumericPrecision prec)
If this object's implementation is less
precise
than the specified numeric precision, then convert this implementation to
the closest available match for the proposed precision. |
PRIMITIVE |
quotient(BigDecimal aValue)
Set the value of this scalar to the mathematical quotient between
its current value and the specified value
|
PRIMITIVE |
quotient(BigInteger 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 |
radians()
Replace the current value, assumed to be an angle in degrees, to its
equivalent angle in radians
|
PRIMITIVE |
random()
Replace the current value with an evenly-distributed
random value between zero (inclusive) and unity
(exclusive for floating point, inclusive for integrals) |
PRIMITIVE |
replace(CharSequence target,
CharSequence replacement) |
PRIMITIVE |
replace(int start,
int end,
String str) |
PRIMITIVE |
replaceAll(String regex,
String replacement) |
PRIMITIVE |
replaceCharacter(char oldChar,
char newChar) |
PRIMITIVE |
replaceFirst(String regex,
String replacement) |
PRIMITIVE |
reverse() |
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) |
PRIMITIVE |
setCharAt(int index,
char ch) |
PRIMITIVE |
setE()
Replace the current value with e, or Napier's constant
|
<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 |
setFalse()
Set this property to its equivalent of
true and answer this
object (facilitates chaining) |
PRIMITIVE |
setLength(int newLength) |
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 |
setPi()
Replace the current value with Pi
|
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 |
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 |
setText(CharSequence content)
Set this property to the specified
text value and answer
this object (facilitates chaining) |
PRIMITIVE |
setTrue()
Set this property to its equivalent of
true 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.
|
PRIMITIVE |
shiftRightExtendZero(int count)
Attempt to shift the elements of this tuple to the "right" the specified
number of ordinal positions without sign extension.
|
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() |
PRIMITIVE |
sine()
Replace the current value, assumed to be an angle in radians, to its
sine |
int |
size()
Returns the number of elements in this algebraic structure.
|
PRIMITIVE |
square()
Replace the current value with the square of itself
|
PRIMITIVE |
squareRoot()
Replace the current value with the square root of itself
|
CharSequence |
subSequence(int start,
int end) |
String |
substring(int beginIndex) |
String |
substring(int beginIndex,
int endIndex) |
PRIMITIVE |
sum(BigDecimal aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
PRIMITIVE |
sum(BigInteger aValue)
Set the value of this scalar to the mathematical sum of its
current value and the specified value
|
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<?> aValue)
Swap the value of this primitive for the specified one and set the
specified primitive's value to the current value of this primitive
|
PRIMITIVE |
tangent()
Replace the current value, assumed to be an angle in radians, to its
tangent |
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
|
PRIMITIVE |
titleCase()
For text-based objects, convert all characters in the text to
title case. |
Boolean |
toBoolean() |
Character |
toCharacter() |
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 |
Number |
toNumber() |
Primitive<?> |
toPrimitive()
If this object is already
primitive then simply call
its Replicator.copy() function, otherwise convert it to a new Primitive
instance |
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 |
String |
toString() |
BigDecimal |
toUnlimitedDecimal() |
BigInteger |
toUnlimitedInteger() |
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 |
upperCase()
For text-based objects, convert all characters in the text to upper case.
|
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
|
andOfPrimitive, angleWithPrimitive, differenceOfPrimitive, hypotenuseWithPrimitive, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, xorOfPrimitive
andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, differenceOfNumber, differenceOfReal, gcdOfNumber, gcdOfReal, hypotenuseWithReal, isEqualToNumber, isEqualToReal, isGreaterOrEqualToNumber, isGreaterOrEqualToReal, isGreaterThanNumber, isGreaterThanReal, isLessOrEqualToNumber, isLessOrEqualToReal, isLessThanNumber, isLessThanReal, isNotEqualToNumber, isNotEqualToReal, modOfNumber, modOfReal, orOfNumber, orOfReal, powerOfReal, productOfNumber, productOfReal, quotientOfNumber, quotientOfReal, setNumber, setReal, sumOfNumber, sumOfReal, unlimitedIntegerModularInverse, xorOfNumber, xorOfReal
andOfScalar, angleWithNumber, angleWithScalar, 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, differenceOfScalar, divideByZero, down, floor, gcdOfScalar, getBooleanBitAt, getByteBitAt, getCharBitAt, getDoubleBitAt, getFloatBitAt, getIntBitAt, getLongBitAt, getShortBitAt, getUnlimitedDecimalBitAt, getUnlimitedIntegerBitAt, halfDown, halfEven, halfUp, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, indexOutOfBoundsAt, intGCD, intMaskAt, intModularInverse, intModularQuotient, intNotMaskAt, intValue, isEqualToScalar, isFalse, isGreaterOrEqualToScalar, isGreaterThanScalar, isLessOrEqualToScalar, isLessThanScalar, isNotEqualToScalar, isTrue, isValid, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longValue, modOfScalar, orOfScalar, powerOfNumber, powerOfScalar, productOfScalar, quotientOfScalar, setByteBitAt, setCharBitAt, setDoubleBitAt, setFloatBitAt, setIntBitAt, setLongBitAt, setShortBitAt, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, shortMaskAt, shortNotMaskAt, shortValue, sumOfScalar, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xorOfScalar
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copyUsingPrimitive, copyUsingText
andOfPrimitive, angleWithPrimitive, differenceOfPrimitive, hypotenuseWithPrimitive, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, xorOfPrimitive
compareToReal, compareToReal, compareToReal, isEqualToReal, isGreaterOrEqualToReal, isGreaterThanReal, isLessOrEqualToReal, isLessThanReal, isNotEqualToReal
compareToNumber, compareToScalar, isEqualToNumber, isEqualToScalar, isFalse, isGreaterOrEqualToNumber, isGreaterOrEqualToScalar, isGreaterThanNumber, isGreaterThanScalar, isLessOrEqualToNumber, isLessOrEqualToScalar, isLessThanNumber, isLessThanScalar, isNotEqualToNumber, isNotEqualToScalar, isTrue
isValid
copyUsing, copyUsing, copyUsingReal
copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsingScalar
copy
andOfReal, angleWithReal, differenceOfReal, gcdOfReal, hypotenuseWithReal, modOfReal, orOfReal, powerOfReal, productOfReal, quotientOfReal, setReal, sumOfReal, xorOfReal
andOfNumber, andOfScalar, angleWithNumber, angleWithScalar, ceiling, differenceOfNumber, differenceOfScalar, down, floor, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, modOfNumber, modOfScalar, orOfNumber, orOfScalar, powerOfNumber, powerOfScalar, productOfNumber, productOfScalar, quotientOfNumber, quotientOfScalar, setNumber, sumOfNumber, sumOfScalar, up, xorOfNumber, xorOfScalar
copyUsingText
public AbstractPrimitiveWrapper()
public PRIMITIVE absoluteValue() throws UnsupportedOperationException
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 changedpublic PRIMITIVE and(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
and
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
and
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 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 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 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 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 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 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 PRIMITIVE angleWith(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
angleWith
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
angleWith
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- 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 PRIMITIVE append(boolean aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(char c) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(char[] content) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(char[] content, int contentIndex) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(char[] content, int contentIndex, int contentLength) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(CharSequence s) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(CharSequence content, int contentStartIndex) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(CharSequence s, int start, int end) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(double aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(float aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(int aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(long aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(Object aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE append(StringBuffer sb) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE appendCodePoint(int codePoint) throws UnsupportedOperationException
appendCodePoint
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE arcCosine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
cosine
arcCosine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
arcCosine
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 PRIMITIVE arcSine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sine
arcSine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
arcSine
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 PRIMITIVE arcTangent() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
tangent
arcTangent
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
arcTangent
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 PRIMITIVE assertDomain(Domain aDomain)
MutableAlgebraicStructure
domain
of this
structure to the closest available match for the proposed domain. Note
that the domain of this implementation may not change as a result
of calling this function if an available internal conversion is not
available.assertDomain
in interface MutableAlgebraicStructure<PRIMITIVE extends Primitive<PRIMITIVE>>
assertDomain
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aDomain
- the proposed domainthis
object (facilitates operation chaining)StructureProperties.isConfigurable()
public PRIMITIVE assertPrecision(NumericPrecision prec)
MutableScalarDomain
precision
of this
implementation to the closest available match for the proposed precision.
Note that the precision of this implementation may not change as a
result of calling this function if this structure is not configurable.assertPrecision
in interface MutableScalarDomain<PRIMITIVE extends Primitive<PRIMITIVE>>
assertPrecision
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
prec
- the proposed precisionthis
object (facilitates operation chaining)public PRIMITIVE base10Log() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
base10Log
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
base10Log
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 boolean booleanPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
booleanPostDecrement
in interface MutableBooleanValue<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 boolean booleanPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
booleanPostIncrement
in interface MutableBooleanValue<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 boolean booleanValue()
booleanValue
in interface SealedBooleanValue
boolean
public byte bytePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
bytePostDecrement
in interface MutableByteValue<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 byte bytePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
bytePostIncrement
in interface MutableByteValue<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 byte byteValue()
byteValue
in interface SealedByteValue
byteValue
in class Number
byte
public char charAt(int index)
charAt
in interface CharSequence
public char charPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
charPostDecrement
in interface MutableCharacterValue<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 char charPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
charPostIncrement
in interface MutableCharacterValue<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 char charValue()
charValue
in interface SealedCharacterValue
char
public void clear() throws UnsupportedOperationException
MutableTextValue
Collection.clear()
. So as to maintain compatibility, this
function will not return the customary reference back to this primitive.
In text primitives, this function will clear the current text contentsclear
in interface MutableAlgebraicStructure<PRIMITIVE extends Primitive<PRIMITIVE>>
clear
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this text cannot be clearedMutableTextValue.clearText();
,
Collection.clear()
,
MutableAlgebraicStructure.clearContents()
public 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.clearContents
in interface MutableAlgebraicStructure<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedMutableAlgebraicStructure.clear()
,
Collection.clear()
,
MutableTextValue.clearText();
public PRIMITIVE clearText() throws UnsupportedOperationException
MutableTextValue
clearText
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's text cannot be changedMutableTextValue.clear();
,
Collection.clear()
,
MutableAlgebraicStructure.clearContents()
public int codePointAt(int index)
codePointAt
in interface SealedTextValue
public int codePointBefore(int index)
codePointBefore
in interface SealedTextValue
public int codePointCount(int beginIndex, int endIndex)
codePointCount
in interface SealedTextValue
public int compareTo(SealedPrimitive<?> o)
compareTo
in interface Comparable<SealedPrimitive<?>>
public int compareToPrimitive(SealedPrimitive<?> aPrimitive)
SealedPrimitive
compareToPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
aPrimitive
- an object to be compared toComparable.compareTo(Object)
public int compareToScalar(boolean aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(byte aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(char aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(double aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(float aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(int aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(long aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToScalar(short aValue)
SealedScalar
compareToScalar
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToScalar
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a scalar to be compared toComparable.compareTo(Object)
public int compareToText(CharSequence text)
SealedText
text
equivalent with the specified
text for ordercompareToText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToText
in class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
text
- text to compare againstComparable.compareTo(Object)
public int compareToZero()
SealedScalar
compareToZero
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
compareToZero
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
Comparable.compareTo(Object)
public PRIMITIVE cosine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
cosine
cosine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
cosine
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 PRIMITIVE cube() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
cube
in interface MutableScalar<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 PRIMITIVE cubeRoot() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
cubeRoot
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
cubeRoot
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 PRIMITIVE decrement() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
decrement
in interface MutableScalar<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 PRIMITIVE degrees() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
degrees
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
degrees
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 PRIMITIVE delete(int start, int end) throws UnsupportedOperationException
delete
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE deleteCharAt(int anIndex) throws UnsupportedOperationException
deleteCharAt
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE difference(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
difference
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractReal<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 PRIMITIVE difference(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
difference
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
difference
in class AbstractReal<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 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 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 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 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 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 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 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 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 double doublePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
doublePostDecrement
in interface MutableDoubleValue<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 double doublePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
doublePostIncrement
in interface MutableDoubleValue<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 double doubleValue()
doubleValue
in interface SealedDoubleValue
doubleValue
in class Number
double
public boolean equals(Object anObject)
equals
in interface SealedKernel
equals
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE exponential() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
exponential
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
exponential
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 PRIMITIVE exponentialLessOne() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
exponentialLessOne
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
exponentialLessOne
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 float floatPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
floatPostDecrement
in interface MutableFloatValue<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 float floatPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
floatPostIncrement
in interface MutableFloatValue<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 float floatValue()
floatValue
in interface SealedFloatValue
floatValue
in class Number
float
public PRIMITIVE gcd(BigInteger aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableReal
gcd
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 gcd(byte aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
gcd
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 gcd(char aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
gcd
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 gcd(int aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
gcd
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 gcd(long aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
gcd
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 gcd(short aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
gcd
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
gcd
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a valueUnsupportedOperationException
- 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 ConcurrencyStrategy getConcurrency()
getConcurrency
in interface SealedKernel
public Domain getDomain()
getDomain
in interface SealedAlgebraicStructure
getDomain
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public NumericPrecision getPrecision()
getPrecision
in interface SealedScalarDomain
getPrecision
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
boolean
bit tuplepublic StructureStrategy getStructureStrategy()
getStructureStrategy
in interface SealedAlgebraicStructure
public int hashCode()
hashCode
in interface SealedKernel
hashCode
in class Object
public PRIMITIVE hyperbolicCosine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
cosine
hyperbolicCosine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
hyperbolicCosine
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 PRIMITIVE hyperbolicSine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sine
hyperbolicSine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
hyperbolicSine
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 PRIMITIVE hyperbolicTangent() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
tangent
hyperbolicTangent
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
hyperbolicTangent
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 PRIMITIVE increment() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
increment
in interface MutableScalar<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 int indexOfText(CharSequence str)
indexOfText
in interface SealedTextValue
public int indexOfText(CharSequence str, int beginIndex)
indexOfText
in interface SealedTextValue
public <P extends Primitive<?>> P inducePostDecrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
inducePostDecrement
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
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 <R extends Real<?>> R inducePostDecrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostDecrement
in interface RealInductor<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 <S extends Scalar<?>> S inducePostDecrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
inducePostDecrement
in interface ScalarInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
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 <P extends Primitive<?>> P inducePostIncrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
inducePostIncrement
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
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 <R extends Real<?>> R inducePostIncrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostIncrement
in interface RealInductor<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 <S extends Scalar<?>> S inducePostIncrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
inducePostIncrement
in interface ScalarInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
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 <P extends Primitive<?>> P inducePrimitiveMaximum(P aTarget)
PrimitiveInductor
inducePrimitiveMaximum
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePrimitiveMaximum
in class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
P
- the target typeaTarget
- a target into which the maximum numeric value of the Primitive
will be inducedpublic <P extends Primitive<?>> P inducePrimitiveMinimum(P aTarget)
PrimitiveInductor
inducePrimitiveMinimum
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePrimitiveMinimum
in class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
P
- the target typeaTarget
- a target into which the minimum numeric value of the Primitive
will be inducedpublic <P extends Primitive<?>> P inducePrimitiveValue(P aTarget)
PrimitiveInductor
inducePrimitiveValue
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
P
- the target typeaTarget
- a target into which the current value of this Primitive will be
inducedpublic <R extends Real<?>> R induceRealMaximum(R aTarget)
SealedRealDomain
induceRealMaximum
in interface SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic <R extends Real<?>> R induceRealMinimum(R aTarget)
SealedRealDomain
induceRealMinimum
in interface SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic <R extends Real<?>> R induceRealSize(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
SealedRealBag
scalar
with the element count in this
structureinduceRealSize
in interface SealedRealBag
induceRealSize
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- the target to updateNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target cannot be changedIllegalStateException
- this target cannot be changed at this timepublic <R extends Real<?>> R induceRealValue(R aTarget)
RealInductor
induceRealValue
in interface RealInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- a target into which the current value of this real will be
inducedpublic <S extends Scalar<?>> S induceScalarMaximum(S aTarget)
SealedScalarDomain
induceScalarMaximum
in interface SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic <S extends Scalar<?>> S induceScalarMinimum(S aTarget)
SealedScalarDomain
induceScalarMinimum
in interface SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic <R extends Scalar<?>> R induceScalarSize(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
SealedScalarBag
scalar
with the element count in this
structureinduceScalarSize
in interface SealedScalarBag
induceScalarSize
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- the target to updateNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target cannot be changedIllegalStateException
- this target cannot be changed at this timepublic <S extends Scalar<?>> S induceScalarValue(S aTarget)
ScalarInductor
induceScalarValue
in interface ScalarInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
S
- the target typeaTarget
- a target into which the current value of this scalar will be
inducedpublic <SCALAR extends Scalar<?>> SCALAR induceTextSize(SCALAR aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
TextInductor
scalar
targetinduceTextSize
in interface TextInductor
induceTextSize
in class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
SCALAR
- the scalar target typeaTarget
- a scalar
target into which the current size of this
text will be inducedNullPointerException
- 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 <TEXT extends Text<?>> TEXT induceTextValue(TEXT aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
TextInductor
induceTextValue
in interface TextInductor
TEXT
- the target typeaTarget
- a target into which the current value of this text will be
inducedNullPointerException
- 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 PRIMITIVE insert(int anIndex, boolean aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, char aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, char[] content) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int targetIndex, char[] content, int contentIndex, int contentLength) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, CharSequence content) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int targetIndex, CharSequence content, int contentIndex) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int targetIndex, CharSequence content, int contentStartIndex, int contentEndIndexPlusOne) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, double aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, float aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, int aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, long aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE insert(int anIndex, Object aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public int intPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
intPostDecrement
in interface MutableIntegerValue<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 int intPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
intPostIncrement
in interface MutableIntegerValue<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 int intValue()
intValue
in interface SealedIntegerValue
intValue
in class Number
int
public PRIMITIVE invalidate() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
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 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 PRIMITIVE inverse() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
1/x
)inverse
in interface MutableScalar<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 boolean isAlphabetic()
isAlphabetic
in interface CharacterProperties
isAlphabetic
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the int
value of this object is a
proper alphabetical
value in
UnicodeCharacter.isAlphabetic(int)
public boolean isBmpCodePoint()
isBmpCodePoint
in interface CharacterProperties
isBmpCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the int
value of this object is a
BMP
(Basic Multi-lingual
Plane) code point in UnicodeCharacter.isBmpCodePoint(int)
public 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 isCountable()
StructureProperties
true
if this structure contains a countable number of
elements. A countable set is a set with the same cardinality as some
subset of the set of natural numbers. A set that is not countable
contains an infinite number of elements.isCountable
in interface StructureProperties
isCountable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure contains a countable number
of elements, otherwise false
if it contains an infinite
number of elementspublic boolean isDigit()
CharacterProperties
char
-width or int
-width
character is a digit within UnicodeisDigit
in interface CharacterProperties
isDigit
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a digit in UnicodeCharacter.isDigit(char)
,
Character.isDigit(int)
public 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 boolean isEmpty()
StructureProperties
true
if this structure contains no elements. For
strings
this would indicate an empty string (no characters
in an empty array). For scalars this would indicate an empty set, or a
zero bit count, which would be the case of null
values. Note
that, although the null
constant technically contains zero
elements, its string
value evaluates to "null", which from
a String perspective is not empty.isEmpty
in interface StructureProperties
isEmpty
in interface TextProperties
isEmpty
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure contains no elementspublic boolean isEqual(BigDecimal aValue)
isEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(BigInteger aValue)
isEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(boolean aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(byte aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(char aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(double aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(float aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(int aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(long aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqual(short aValue)
isEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqualToPrimitive(SealedPrimitive<?> aPrimitive)
isEqualToPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isEqualToText(CharSequence aValue)
isEqualToText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
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 boolean isFinite()
isFinite
in interface NumericProperties
isFinite
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this value represents a valid and finite valuepublic boolean isGreater(BigDecimal aValue)
isGreater
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(BigInteger aValue)
isGreater
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(boolean aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(byte aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(char aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(double aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(float aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(int aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(long aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreater(short aValue)
isGreater
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreater
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(BigDecimal aValue)
isGreaterOrEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(BigInteger aValue)
isGreaterOrEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(boolean aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(byte aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(char aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(double aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(float aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(int aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(long aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqual(short aValue)
isGreaterOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isGreaterOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqualToPrimitive(SealedPrimitive<?> aPrimitive)
isGreaterOrEqualToPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterOrEqualToText(CharSequence aValue)
isGreaterOrEqualToText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterThanPrimitive(SealedPrimitive<?> aPrimitive)
isGreaterThanPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isGreaterThanText(CharSequence aValue)
isGreaterThanText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isHighSurrogate()
isHighSurrogate
in interface CharacterProperties
isHighSurrogate
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the char
value of this object is a
high
surrogate in UTF-16
Unicode encodingCharacter.isHighSurrogate(char)
public boolean isIdentifierIgnorable()
CharacterProperties
char
-width or int
-width
character ignorable character in a Java identifier or a Unicode
identifierisIdentifierIgnorable
in interface CharacterProperties
isIdentifierIgnorable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, ignorable character in a Java
identifier or a Unicode identifier as other than the first
characterCharacter.isIdentifierIgnorable(char)
,
Character.isIdentifierIgnorable(int)
public boolean isIdeographic()
isIdeographic
in interface CharacterProperties
isIdeographic
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the int
value of this object is a
Unicode ideographic
symbolCharacter.isIdeographic(int)
public boolean isImaginary()
NumericProperties
true
if this value represents the magnitude of a vector
into the set of imaginary numbers. This is not the same as testing
whether this object's implementation resembles the specification for the
IMAGINARY
domain, since that is too specific to
implementation machinery. This more general test also includes imaginary
modulo
values in its specification.isImaginary
in interface NumericProperties
isImaginary
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this value represents the magnitude of a vector
into the set of imaginary numberspublic boolean isInfinity()
isInfinity
in interface NumericProperties
true
if this number represents either
positive
or
negative
infinitypublic boolean isInvalid()
isInvalid
in interface NumericProperties
true
if this value does not represent a valid number,
such as 0/0 (INVALID
)public boolean isISOControl()
CharacterProperties
char
-width or int
-width
character is an ISO control character within UnicodeisISOControl
in interface CharacterProperties
isISOControl
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is an ISO control character in
UnicodeCharacter.isISOControl(char)
,
Character.isISOControl(int)
public boolean isJavaIdentifierPart()
CharacterProperties
char
-width or int
-width
character is a part of a Java identifier as other than the first
characterisJavaIdentifierPart
in interface CharacterProperties
isJavaIdentifierPart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a part of a Java identifier as
other than the first characterCharacter.isJavaIdentifierPart(char)
,
Character.isJavaIdentifierPart(int)
public boolean isJavaIdentifierStart()
CharacterProperties
char
-width or int
-width
character is permissible as the first character in a Java identifierisJavaIdentifierStart
in interface CharacterProperties
isJavaIdentifierStart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is permissible as the first
character in a Java identifierCharacter.isJavaIdentifierStart(char)
,
Character.isJavaIdentifierStart(int)
public boolean isLess(BigDecimal aValue)
isLess
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(BigInteger aValue)
isLess
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(boolean aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(byte aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(char aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(double aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(float aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(int aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(long aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLess(short aValue)
isLess
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLess
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(BigDecimal aValue)
isLessOrEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(BigInteger aValue)
isLessOrEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(boolean aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(byte aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(char aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(double aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(float aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(int aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(long aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqual(short aValue)
isLessOrEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isLessOrEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqualToPrimitive(SealedPrimitive<?> aPrimitive)
isLessOrEqualToPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessOrEqualToText(CharSequence aValue)
isLessOrEqualToText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessThanPrimitive(SealedPrimitive<?> aPrimitive)
isLessThanPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLessThanText(CharSequence aValue)
isLessThanText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isLetter()
CharacterProperties
char
-width or int
-width
character is a letter within UnicodeisLetter
in interface CharacterProperties
isLetter
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a letter in UnicodeCharacter.isLetter(char)
,
Character.isLetter(int)
public boolean isLetterOrDigit()
CharacterProperties
char
-width or int
-width
character is a letter or digit within UnicodeisLetterOrDigit
in interface CharacterProperties
isLetterOrDigit
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a letter or digit in UnicodeCharacter.isLetterOrDigit(char)
,
Character.isLetterOrDigit(int)
public boolean isLowerCase()
CharacterProperties
char
-width or int
-width
character is a lower case character within UnicodeisLowerCase
in interface CharacterProperties
isLowerCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a lower case character in
UnicodeCharacter.isLowerCase(char)
,
Character.isLowerCase(int)
public boolean isLowSurrogate()
isLowSurrogate
in interface CharacterProperties
isLowSurrogate
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the char
value of this object is a
low
surrogate in UTF-16
Unicode encodingCharacter.isLowSurrogate(char)
public boolean isMaximum()
isMaximum
in interface NumericProperties
true
if this value represents the maximum rational value
in the totally ordered set it representspublic boolean isMinimum()
isMinimum
in interface NumericProperties
true
if this value represents the minimum rational value
in the totally ordered set it representspublic boolean isMirrored()
CharacterProperties
char
-width or int
-width
character is "mirrored" within UnicodeisMirrored
in interface CharacterProperties
isMirrored
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is "mirrored" in UnicodeCharacter.isMirrored(char)
,
Character.isMirrored(int)
public 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
.isModulo
in interface NumericProperties
true
if this value represents the magnitude of a vector
into a modulo set, or finite ringpublic boolean isMutable()
isMutable
in interface Mutable
isMutable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if modification of the implementation is allowed and
that none of the modification functions will, in principle, throw
UnsupportedOperationExceptions
public boolean isNegative()
isNegative
in interface NumericProperties
true
if this value represents a negative valuepublic 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 boolean isNegativeInfinity()
isNegativeInfinity
in interface NumericProperties
true
if this value represents negative
infinitypublic boolean isNotEqual(BigDecimal aValue)
isNotEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(BigInteger aValue)
isNotEqual
in interface SealedReal<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractReal<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(boolean aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(byte aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(char aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(double aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(float aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(int aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(long aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqual(short aValue)
isNotEqual
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
isNotEqual
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqualToPrimitive(SealedPrimitive<?> aPrimitive)
isNotEqualToPrimitive
in interface SealedPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public boolean isNotEqualToText(CharSequence aValue)
isNotEqualToText
in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>
public 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 boolean isPositive()
isPositive
in interface NumericProperties
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 boolean isPositiveInfinity()
isPositiveInfinity
in interface NumericProperties
true
if this value represents positive
infinitypublic 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.isReal
in interface NumericProperties
true
if this value represents the magnitude of a vector
into the set of real numberspublic 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 boolean isSupplementaryCodePoint()
isSupplementaryCodePoint
in interface CharacterProperties
isSupplementaryCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the int
value of this object is a
supplementary
code point in UnicodeCharacter.isSupplementaryCodePoint(int)
public boolean isSurrogate()
isSurrogate
in interface CharacterProperties
isSurrogate
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the char
value of this object is a
surrogate
value (high or low)
in UnicodeCharacter.isSurrogate(char)
public boolean isText()
isText
in interface TextProperties
true
if this object utilizes a text-based implementationpublic boolean isTitleCase()
CharacterProperties
char
-width or int
-width
character is a title case character within UnicodeisTitleCase
in interface CharacterProperties
isTitleCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a title case character in
UnicodeCharacter.isTitleCase(char)
,
Character.isTitleCase(int)
public boolean isUnicode()
CharacterProperties
char
-width or int
-width
character is defined within UnicodeisUnicode
in interface CharacterProperties
isUnicode
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is defined in UnicodeCharacter.isDefined(char)
,
Character.isDefined(int)
public boolean isUnicodeIdentifierPart()
CharacterProperties
char
-width or int
-width
character is a part of a Unicode identifier as other than the first
characterisUnicodeIdentifierPart
in interface CharacterProperties
isUnicodeIdentifierPart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a part of a Unicode identifier
as other than the first characterCharacter.isUnicodeIdentifierPart(char)
,
Character.isUnicodeIdentifierPart(int)
public boolean isUnicodeIdentifierStart()
CharacterProperties
char
-width or int
-width
character is permissible as the first character in a Unicode identifierisUnicodeIdentifierStart
in interface CharacterProperties
isUnicodeIdentifierStart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is permissible as the first
character in a Unicode identifierCharacter.isUnicodeIdentifierStart(char)
,
Character.isUnicodeIdentifierStart(int)
public boolean isUnique()
isUnique
in interface StructureProperties
isUnique
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the elements in this structure are, by definition
of the structure's algebra, unique (e.g., sets
)public 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.isUnity
in interface NumericProperties
true
if this value represents the multiplicative
identity in its domainpublic boolean isUpperCase()
CharacterProperties
char
-width or int
-width
character is an upper case character within UnicodeisUpperCase
in interface CharacterProperties
isUpperCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is an upper case character in
UnicodeCharacter.isUpperCase(char)
,
Character.isUpperCase(int)
public boolean isValidCodePoint()
isValidCodePoint
in interface CharacterProperties
isValidCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the int
value of this object is a
valid
code point in
UnicodeCharacter.isValidCodePoint(int)
public boolean isWhitespace()
CharacterProperties
char
-width or int
-width
character is whitespace within UnicodeisWhitespace
in interface CharacterProperties
isWhitespace
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is whitespace in UnicodeCharacter.isWhitespace(char)
,
Character.isWhitespace(int)
public 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.isZero
in interface NumericProperties
true
if this value represents the additive
identity in its algebraic grouppublic int length()
length
in interface CharSequence
public long longPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
longPostDecrement
in interface MutableLongValue<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 long longPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
longPostIncrement
in interface MutableLongValue<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 long longSize()
SealedAlgebraicStructure
long
scalar. If the structure contains more than
Long.MAX_VALUE
elements, returns Long.MAX_VALUE
.longSize
in interface SealedAlgebraicStructure
longSize
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
long
scalarCollection.size()
,
SealedAlgebraicStructure.size()
public long longValue()
longValue
in interface SealedLongValue
longValue
in class Number
long
public PRIMITIVE lowerCase()
MutableTextValue
lowerCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE milliseconds() throws UnsupportedOperationException
MutableScalar
time
milliseconds
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
milliseconds
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedpublic PRIMITIVE mod(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
mod
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractReal<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 PRIMITIVE mod(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
mod
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
mod
in class AbstractReal<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 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 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 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 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 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 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 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 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 PRIMITIVE nanoseconds() throws UnsupportedOperationException
MutableScalar
time
nanoseconds
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
nanoseconds
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedpublic PRIMITIVE naturalLog() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
naturalLog
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
naturalLog
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 PRIMITIVE naturalLogPlusOne() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
naturalLogPlusOne
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
naturalLogPlusOne
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 PRIMITIVE negate() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
boolean
and char
values do not exist, these
implementations will simply fail silently.)negate
in interface MutableScalar<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 object (optional)IllegalArgumentException
- if the new value was incommensurate with this object's
specification (optional)public PRIMITIVE not() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
double
, will be first
converted to unlimited integers
before their bits are
reversed.not
in interface MutableScalar<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 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 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 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 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 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 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 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 PRIMITIVE power(double n) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
power
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
power
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
n
- 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 PRIMITIVE power(int n) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
power
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
power
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
n
- 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 PRIMITIVE prepend(boolean aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(char aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(char[] content) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(char[] content, int contentIndex) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(char[] content, int contentIndex, int contentLength) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(CharSequence content) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(CharSequence content, int contentIndex) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(CharSequence content, int contentStartIndex, int contentEndIndexPlusOne) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(double aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(float aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(int aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(long aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE prepend(Object aValue) throws UnsupportedOperationException
prepend
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE product(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
product
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractReal<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 PRIMITIVE product(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
product
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
product
in class AbstractReal<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 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 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 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 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 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 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 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 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 PRIMITIVE promoteTo(NumericPrecision prec)
MutableScalarDomain
precise
than the specified numeric precision, then convert this implementation to
the closest available match for the proposed precision. Note that the
precision of this implementation may not change as a result of
calling this function if the proposed precision is less precise than the
this object's current precision level or if this structure is not
{@link StructureProperties#isConfigurable() configurable).promoteTo
in interface MutableScalarDomain<PRIMITIVE extends Primitive<PRIMITIVE>>
promoteTo
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
prec
- the proposed precisionthis
object (facilitates operation chaining)StructureProperties.isConfigurable()
public 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 PRIMITIVE quotient(BigInteger 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 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 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 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 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 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 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 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 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 PRIMITIVE radians() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
radians
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
radians
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 PRIMITIVE random() throws UnsupportedOperationException
MutableScalar
random
value between zero (inclusive) and unity
(exclusive for floating point, inclusive for integrals)random
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
random
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedpublic PRIMITIVE replace(CharSequence target, CharSequence replacement)
replace
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE replace(int start, int end, String str) throws UnsupportedOperationException
replace
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE replaceAll(String regex, String replacement)
replaceAll
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE replaceCharacter(char oldChar, char newChar)
replaceCharacter
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE replaceFirst(String regex, String replacement)
replaceFirst
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public PRIMITIVE reverse() throws UnsupportedOperationException
reverse
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE round(RoundingStrategy aRoundingStrategy) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableScalar
strategy
round
in interface MutableScalar<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 objectNullPointerException
public PRIMITIVE setBoolean(Boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
Boolean
and
answer this object (facilitates chaining)setBoolean
in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setCharacter(Character aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutablePrimitive
Character
and
answer this object (facilitates chaining)setCharacter
in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setCharAt(int index, char ch) throws UnsupportedOperationException
setCharAt
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public PRIMITIVE setE() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
setE
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setE
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 <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 PRIMITIVE setFalse() throws UnsupportedOperationException, ArithmeticException
MutableBooleanValue
true
and answer this
object (facilitates chaining)setFalse
in interface MutableBooleanValue<PRIMITIVE extends Primitive<PRIMITIVE>>
setFalse
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new value was incompatible with with algebraic interpretation
of this objectpublic PRIMITIVE setLength(int newLength) throws UnsupportedOperationException
setLength
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public 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.setMaximum
in interface MutableScalar<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 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.setMinimum
in interface MutableScalar<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 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 setPi() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
setPi
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setPi
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 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
setPrimitive
in interface MutablePrimitive<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 PRIMITIVE setReal(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedDecimalValue
decimal
value and answer this object (facilitates chaining)setReal
in interface MutableUnlimitedDecimalValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setReal(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedIntegerValue
integer
value and answer this object (facilitates chaining)setReal
in interface MutableUnlimitedIntegerValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableBooleanValue
boolean
value and answer this
object (facilitates chaining)setScalar
in interface MutableBooleanValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableByteValue
byte
value and answer this
object (facilitates chaining)setScalar
in interface MutableByteValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableCharacterValue
char
value and answer this
object (facilitates chaining)setScalar
in interface MutableCharacterValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableDoubleValue
double
value and answer this
object (facilitates chaining)setScalar
in interface MutableDoubleValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableFloatValue
float
value and answer this
object (facilitates chaining)setScalar
in interface MutableFloatValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableIntegerValue
int
value and answer this
object (facilitates chaining)setScalar
in interface MutableIntegerValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setScalar(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableLongValue
long
value and answer this
object (facilitates chaining)setScalar
in interface MutableLongValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 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 PRIMITIVE setScalar(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableShortValue
short
value and answer this
object (facilitates chaining)setScalar
in interface MutableShortValue<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE setText(CharSequence content) throws UnsupportedOperationException, IllegalArgumentException, NullPointerException
MutableTextValue
text
value and answer
this object (facilitates chaining)setText
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
content
- a text
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationNullPointerException
- a null
value was provided and this implementation does
not accept null
valuespublic PRIMITIVE setTrue() throws UnsupportedOperationException, ArithmeticException
MutableBooleanValue
true
and answer this
object (facilitates chaining)setTrue
in interface MutableBooleanValue<PRIMITIVE extends Primitive<PRIMITIVE>>
setTrue
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new value was incompatible with with algebraic interpretation
of this objectpublic 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 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 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.shiftLeft
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
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 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.shiftRight
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
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 PRIMITIVE shiftRightExtendZero(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.shiftRightExtendZero
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
shiftRightExtendZero
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
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 short shortPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
shortPostDecrement
in interface MutableShortValue<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 short shortPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
shortPostIncrement
in interface MutableShortValue<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 short shortValue()
shortValue
in interface SealedShortValue
shortValue
in class Number
short
public 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 PRIMITIVE sine() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
sine
sine
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
sine
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 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 PRIMITIVE square() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
square
in interface MutableScalar<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 PRIMITIVE squareRoot() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
squareRoot
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
squareRoot
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 CharSequence subSequence(int start, int end)
subSequence
in interface CharSequence
public String substring(int beginIndex) throws IndexOutOfBoundsException
substring
in interface SealedTextValue
IndexOutOfBoundsException
public String substring(int beginIndex, int endIndex) throws IndexOutOfBoundsException
substring
in interface SealedTextValue
IndexOutOfBoundsException
public PRIMITIVE sum(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
sum
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractReal<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 PRIMITIVE sum(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableReal
sum
in interface MutableReal<PRIMITIVE extends Primitive<PRIMITIVE>>
sum
in class AbstractReal<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 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 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 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 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 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 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 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 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 PRIMITIVE swapPrimitives(Primitive<?> aValue)
Primitive
swapPrimitives
in interface Primitive<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- the primitive to swap withpublic PRIMITIVE tangent() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
tangent
tangent
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
tangent
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 String textPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
textPostDecrement
in interface MutableTextValue<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 String textPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
textPostIncrement
in interface MutableTextValue<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 titleCase()
MutableTextValue
title
case. For numeric objects,
convert their character (BMP) or integer value (Unicode) to title case,
depending on the object's precision leveltitleCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public Character toCharacter()
toCharacter
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
toCharacter
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
Boolean
objectpublic int toCodePoint()
SealedScalar
toCodePoint
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
toCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public <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 Primitive<?> toPrimitive()
PrimitiveReplicator
primitive
then simply call
its Replicator.copy()
function, otherwise convert it to a new Primitive
instancetoPrimitive
in interface PrimitiveReplicator<PRIMITIVE extends Primitive<PRIMITIVE>>
toPrimitive
in class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public 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 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 String toString()
toString
in interface CharSequence
toString
in interface SealedKernel
toString
in class Object
public BigDecimal toUnlimitedDecimal()
toUnlimitedDecimal
in interface SealedUnlimitedDecimalValue
decimal
property valuepublic BigInteger toUnlimitedInteger()
toUnlimitedInteger
in interface SealedUnlimitedIntegerValue
integer
property valuepublic PRIMITIVE trim()
MutableTextValue
whitespace
trim
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public BigDecimal unlimitedDecimalPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
unlimitedDecimalPostDecrement
in interface MutableUnlimitedDecimalValue<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 BigDecimal unlimitedDecimalPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
unlimitedDecimalPostIncrement
in interface MutableUnlimitedDecimalValue<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 BigInteger unlimitedIntegerPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
unlimitedIntegerPostDecrement
in interface MutableUnlimitedIntegerValue<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 BigInteger unlimitedIntegerPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
unlimitedIntegerPostIncrement
in interface MutableUnlimitedIntegerValue<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 upperCase()
MutableTextValue
upperCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
public 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 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 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 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 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 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 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.