net.sf.jaccumulator.primitives

Class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

java.lang.Object

java.lang.Number

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

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

net.sf.jaccumulator.primitives.AbstractPrimitive<PRIMITIVE>

Type Parameters:

PRIMITIVE - this primitive type (used to facilitate operation chaining on write operations)

All Implemented Interfaces:

Serializable, Appendable, CharSequence, Comparable<SealedPrimitive<?>>, AlgebraicStructure<PRIMITIVE>, BooleanValue<PRIMITIVE>, MutableBooleanValue<PRIMITIVE>, SealedBooleanValue, ByteValue<PRIMITIVE>, MutableByteValue<PRIMITIVE>, SealedByteValue, CharacterValue<PRIMITIVE>, MutableCharacterValue<PRIMITIVE>, SealedCharacterValue, DoubleValue<PRIMITIVE>, MutableDoubleValue<PRIMITIVE>, SealedDoubleValue, FloatValue<PRIMITIVE>, MutableFloatValue<PRIMITIVE>, SealedFloatValue, IntegerValue<PRIMITIVE>, MutableIntegerValue<PRIMITIVE>, SealedIntegerValue, LongValue<PRIMITIVE>, MutableLongValue<PRIMITIVE>, SealedLongValue, Mutable, MutableAlgebraicStructure<PRIMITIVE>, MutableKernel<PRIMITIVE>, MutablePrimitive<PRIMITIVE>, Primitive<PRIMITIVE>, PrimitiveInductor<PRIMITIVE>, PrimitiveReplicator<PRIMITIVE>, SealedPrimitive<PRIMITIVE>, MutableReal<PRIMITIVE>, MutableRealDomain<PRIMITIVE>, Real<PRIMITIVE>, RealDomain<PRIMITIVE>, RealInductor<PRIMITIVE>, RealReplicator<PRIMITIVE>, SealedReal<PRIMITIVE>, SealedRealBag, SealedRealDomain, Replicator<PRIMITIVE>, CharacterProperties, MutableScalar<PRIMITIVE>, MutableScalarDomain<PRIMITIVE>, NumericProperties, Scalar<PRIMITIVE>, ScalarDomain<PRIMITIVE>, ScalarInductor<PRIMITIVE>, ScalarReplicator<PRIMITIVE>, SealedScalar<PRIMITIVE>, SealedScalarBag, SealedScalarDomain, SealedAlgebraicStructure, SealedKernel, MutableShortValue<PRIMITIVE>, SealedShortValue, ShortValue<PRIMITIVE>, StructureProperties, MutableText<PRIMITIVE>, MutableTextValue<PRIMITIVE>, SealedText<PRIMITIVE>, SealedTextValue, Text<PRIMITIVE>, TextInductor, TextProperties, TextReplicator<PRIMITIVE>, TextValue<PRIMITIVE>, MutableUnlimitedDecimalValue<PRIMITIVE>, MutableUnlimitedIntegerValue<PRIMITIVE>, SealedUnlimitedDecimalValue, SealedUnlimitedIntegerValue, UnlimitedDecimalValue<PRIMITIVE>, UnlimitedIntegerValue<PRIMITIVE>

Direct Known Subclasses:

AbstractNumericPrimitive, AbstractPrimitiveWrapper, AbstractTextPrimitive

public abstract class AbstractPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
extends AbstractReal<PRIMITIVE>
implements Primitive<PRIMITIVE>

Common read and write behavior for primitive representations

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

See Also:

Serialized Form

Field Summary

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

NaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
PRIMITIVE	andOfPrimitive(SealedPrimitive<?> aValue) Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector
PRIMITIVE	angleWithPrimitive(SealedPrimitive<?> aValue) Set this value to the angle formed by the rectangular coordinates given by the current value, x, and the specified value, y.
int	compareToText(CharSequence text) Compares this object's text equivalent with the specified text for order
PRIMITIVE	differenceOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value.
PRIMITIVE	hypotenuseWithPrimitive(SealedPrimitive<?> aValue) Set this value to the hypotenuse formed by the square root of the sum of the square of the current value, x, and the square of the specified value, y, without intermediate overflow or underflow
<P extends Primitive<?>> P	inducePrimitiveMaximum(P aTarget) Induce the maximum numeric value of the Primitive into the specified target
<P extends Primitive<?>> P	inducePrimitiveMinimum(P aTarget) Induce the minimum numeric value of the Primitive into the specified target
<SCALAR extends Scalar<?>> SCALAR	induceTextSize(SCALAR aTarget) Induce the current value of this text into the scalar target
PRIMITIVE	modOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to its current value modulo of the specified value
PRIMITIVE	orOfPrimitive(SealedPrimitive<?> aValue) Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector
PRIMITIVE	powerOfPrimitive(SealedPrimitive<?> aValue) Set this value to the current value, x, raised to the specified exponent, n, or xn
PRIMITIVE	productOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to the mathematical product of its current value and the specified value.
PRIMITIVE	quotientOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to the mathematical quotient between its current value and the specified value.
PRIMITIVE	sumOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value.
Primitive<?>	toPrimitive() If this object is already primitive then simply call its Replicator.copy() function, otherwise convert it to a new Primitive instance
PRIMITIVE	xorOfPrimitive(SealedPrimitive<?> aValue) Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Methods inherited from class net.sf.jaccumulator.reals.AbstractReal

and, andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, difference, difference, differenceOfNumber, differenceOfReal, equals, gcd, gcdOfNumber, gcdOfReal, hypotenuseWithReal, induceRealSize, isEqual, isEqual, isEqualToNumber, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToReal, isGreaterThanNumber, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToReal, isLessThanNumber, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToReal, mod, mod, modOfNumber, modOfReal, or, orOfNumber, orOfReal, powerOfReal, product, product, productOfNumber, productOfReal, quotient, quotient, quotientOfNumber, quotientOfReal, setNumber, setReal, sum, sum, sumOfNumber, sumOfReal, toReal, unlimitedIntegerModularInverse, xor, xorOfNumber, xorOfReal

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

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

Methods inherited from class java.lang.Number

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jaccumulator.primitives.Primitive

swapPrimitives

Methods inherited from interface net.sf.jaccumulator.primitives.PrimitiveInductor

inducePostDecrement, inducePostIncrement, inducePrimitiveValue

Methods inherited from interface net.sf.jaccumulator.primitives.SealedPrimitive

compareToPrimitive, isEqualToPrimitive, isGreaterOrEqualToPrimitive, isGreaterThanPrimitive, isLessOrEqualToPrimitive, isLessThanPrimitive, isNotEqualToPrimitive

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.sf.jaccumulator.primitives.PrimitiveReplicator

copyUsingPrimitive, copyUsingText

Methods inherited from interface net.sf.jaccumulator.primitives.MutablePrimitive

setBoolean, setCharacter, setPrimitive

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

inducePostDecrement, inducePostIncrement, induceRealValue

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

inducePostDecrement, inducePostIncrement, induceScalarValue

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

compareToReal, compareToReal, compareToReal, isEqual, isEqual, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToReal, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToReal, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToReal

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

compareToNumber, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToNumber, isEqualToScalar, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToScalar, isGreaterThanNumber, isGreaterThanScalar, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToScalar, isLessThanNumber, isLessThanScalar, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToScalar, isTrue, toBoolean, toCharacter, toCodePoint, toEnumeration, toNumber

Methods inherited from interface net.sf.jaccumulator.SealedKernel

equals, getConcurrency, hashCode, toString

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

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

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

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

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

booleanValue

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

byteValue

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

charValue

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

doubleValue

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

floatValue

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

intValue

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

longValue

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

shortValue

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

induceRealMaximum, induceRealMinimum

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

getPrecision, induceScalarMaximum, induceScalarMinimum

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

induceRealSize

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

induceScalarSize

Methods inherited from interface net.sf.jaccumulator.SealedAlgebraicStructure

getDomain, getStructureStrategy, longSize, size

Methods inherited from interface net.sf.jaccumulator.StructureProperties

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

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

copyUsing, copyUsing, copyUsingReal, toReal

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

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

Methods inherited from interface net.sf.jaccumulator.Replicator

copy

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

and, andOfReal, angleWithReal, difference, difference, differenceOfReal, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, modOfReal, or, orOfReal, powerOfReal, product, product, productOfReal, quotient, quotient, quotientOfReal, setReal, sum, sum, sumOfReal, xor, xorOfReal

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

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

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

booleanPostDecrement, booleanPostIncrement, setFalse, setScalar, setTrue

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

bytePostDecrement, bytePostIncrement, setScalar

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

charPostDecrement, charPostIncrement, setScalar

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

doublePostDecrement, doublePostIncrement, setScalar

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

floatPostDecrement, floatPostIncrement, setScalar

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

intPostDecrement, intPostIncrement, setScalar

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

longPostDecrement, longPostIncrement, setScalar

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

setScalar, shortPostDecrement, shortPostIncrement

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

assertPrecision, promoteTo

Methods inherited from interface net.sf.jaccumulator.MutableAlgebraicStructure

assertDomain, clear, clearContents

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

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

toUnlimitedInteger

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

setReal, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement

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

toUnlimitedDecimal

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

setReal, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement

Methods inherited from interface net.sf.jaccumulator.texts.TextInductor

induceTextValue

Methods inherited from interface net.sf.jaccumulator.texts.SealedText

isEqualToText, isGreaterOrEqualToText, isGreaterThanText, isLessOrEqualToText, isLessThanText, isNotEqualToText

Methods inherited from interface net.sf.jaccumulator.texts.TextReplicator

copyUsingText

Methods inherited from interface net.sf.jaccumulator.texts.SealedTextValue

codePointAt, codePointBefore, codePointCount, indexOfText, indexOfText, substring, substring

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence, toString

Methods inherited from interface net.sf.jaccumulator.texts.TextProperties

isEmpty, isText

Methods inherited from interface net.sf.jaccumulator.texts.MutableTextValue

append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, clear, clearText, delete, deleteCharAt, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, lowerCase, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, setCharAt, setLength, setText, textPostDecrement, textPostIncrement, titleCase, trim, upperCase

Constructor Detail

AbstractPrimitive

public AbstractPrimitive()

AbstractPrimitive

public AbstractPrimitive(Domain aDomain,
                 NumericPrecision aPrecision)

AbstractPrimitive

public AbstractPrimitive(NumericPrecision aPrecision)

Method Detail

andOfPrimitive

public final PRIMITIVE andOfPrimitive(SealedPrimitive<?> aValue)
                                                            throws UnsupportedOperationException,
                                                                   IllegalArgumentException,
                                                                   ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

andOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

angleWithPrimitive

public final PRIMITIVE angleWithPrimitive(SealedPrimitive<?> aValue)
                                                                throws UnsupportedOperationException,
                                                                       IllegalArgumentException,
                                                                       ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

angleWithPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a y coordinate value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

See Also:

Math.atan2(double, double)

compareToText

public int compareToText(CharSequence text)

Description copied from interface: SealedText

Compares this object's text equivalent with the specified text for order

Specified by:

compareToText in interface SealedText<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

text - text to compare against

Returns:

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

See Also:

Comparable.compareTo(Object)

differenceOfPrimitive

public final PRIMITIVE differenceOfPrimitive(SealedPrimitive<?> aValue)
                                                                   throws UnsupportedOperationException,
                                                                          IllegalArgumentException,
                                                                          ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

differenceOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a subtrahend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

hypotenuseWithPrimitive

public final PRIMITIVE hypotenuseWithPrimitive(SealedPrimitive<?> aValue)
                                                                     throws UnsupportedOperationException,
                                                                            IllegalArgumentException,
                                                                            ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

hypotenuseWithPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a y value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

See Also:

Math.hypot(double, double)

inducePrimitiveMaximum

public <P extends Primitive<?>> P inducePrimitiveMaximum(P aTarget)
                                           throws NullPointerException,
                                                  NoSuchElementException,
                                                  UnsupportedOperationException,
                                                  IllegalStateException

Description copied from interface: PrimitiveInductor

Induce the maximum numeric value of the Primitive into the specified target

Specified by:

inducePrimitiveMaximum in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>

Type Parameters:

P - the target type

Parameters:

aTarget - a target into which the maximum numeric value of the Primitive will be induced

Returns:

the target

Throws:

NullPointerException

NoSuchElementException

UnsupportedOperationException

IllegalStateException

inducePrimitiveMinimum

public <P extends Primitive<?>> P inducePrimitiveMinimum(P aTarget)
                                           throws NullPointerException,
                                                  NoSuchElementException,
                                                  UnsupportedOperationException,
                                                  IllegalStateException

Description copied from interface: PrimitiveInductor

Induce the minimum numeric value of the Primitive into the specified target

Specified by:

inducePrimitiveMinimum in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>

Type Parameters:

P - the target type

Parameters:

aTarget - a target into which the minimum numeric value of the Primitive will be induced

Returns:

the target

Throws:

NullPointerException - a null value was provided when none was expected

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

UnsupportedOperationException - this target Primitive cannot be changed

IllegalStateException - this target Primitive cannot be changed at this time

induceTextSize

public <SCALAR extends Scalar<?>> SCALAR induceTextSize(SCALAR aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Description copied from interface: TextInductor

Induce the current value of this text into the scalar target

Specified by:

induceTextSize in interface TextInductor

Type Parameters:

SCALAR - the scalar target type

Parameters:

aTarget - a scalar target into which the current size of this text will be induced

Returns:

the target

Throws:

NullPointerException - a null value was provided when none was expected

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

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

modOfPrimitive

public final PRIMITIVE modOfPrimitive(SealedPrimitive<?> aValue)
                                                            throws UnsupportedOperationException,
                                                                   IllegalArgumentException,
                                                                   ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

modOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a modulus

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

orOfPrimitive

public final PRIMITIVE orOfPrimitive(SealedPrimitive<?> aValue)
                                                           throws UnsupportedOperationException,
                                                                  IllegalArgumentException,
                                                                  ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

orOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

powerOfPrimitive

public final PRIMITIVE powerOfPrimitive(SealedPrimitive<?> aValue)
                                                              throws UnsupportedOperationException,
                                                                     IllegalArgumentException,
                                                                     ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

powerOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - an exponent

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

productOfPrimitive

public final PRIMITIVE productOfPrimitive(SealedPrimitive<?> aValue)
                                                                throws UnsupportedOperationException,
                                                                       IllegalArgumentException,
                                                                       ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

productOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a multiplicand

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

quotientOfPrimitive

public final PRIMITIVE quotientOfPrimitive(SealedPrimitive<?> aValue)
                                                                 throws UnsupportedOperationException,
                                                                        IllegalArgumentException,
                                                                        ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

quotientOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - a divisor

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

sumOfPrimitive

public final PRIMITIVE sumOfPrimitive(SealedPrimitive<?> aValue)
                                                            throws UnsupportedOperationException,
                                                                   IllegalArgumentException,
                                                                   ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

sumOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - an addend

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

toPrimitive

public Primitive<?> toPrimitive()

Description copied from interface: PrimitiveReplicator

If this object is already primitive then simply call its Replicator.copy() function, otherwise convert it to a new Primitive instance

Specified by:

toPrimitive in interface PrimitiveReplicator<PRIMITIVE extends Primitive<PRIMITIVE>>

Returns:

a new Primitive

xorOfPrimitive

public final PRIMITIVE xorOfPrimitive(SealedPrimitive<?> aValue)
                                                            throws UnsupportedOperationException,
                                                                   IllegalArgumentException,
                                                                   ArithmeticException

Description copied from interface: MutablePrimitive

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

Specified by:

xorOfPrimitive in interface MutablePrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>

Parameters:

aValue - an integral boolean vector

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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