net.sf.jaccumulator.primitives

Interface MutablePrimitive<PRIMITIVE extends MutablePrimitive<PRIMITIVE>>

Type Parameters:

PRIMITIVE - this type (used to facilitate operation chaining)

All Superinterfaces:

Appendable, Mutable, MutableAlgebraicStructure<PRIMITIVE>, MutableBooleanValue<PRIMITIVE>, MutableByteValue<PRIMITIVE>, MutableCharacterValue<PRIMITIVE>, MutableDoubleValue<PRIMITIVE>, MutableFloatValue<PRIMITIVE>, MutableIntegerValue<PRIMITIVE>, MutableKernel<PRIMITIVE>, MutableLongValue<PRIMITIVE>, MutableReal<PRIMITIVE>, MutableRealDomain<PRIMITIVE>, MutableScalar<PRIMITIVE>, MutableScalarDomain<PRIMITIVE>, MutableShortValue<PRIMITIVE>, MutableText<PRIMITIVE>, MutableTextValue<PRIMITIVE>, MutableUnlimitedDecimalValue<PRIMITIVE>, MutableUnlimitedIntegerValue<PRIMITIVE>

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, MutableAccumulator<ACCUMULATOR>, Primitive<PRIMITIVE>

All Known Implementing Classes:

AbstractAccumulator, AbstractBooleanPrimitive, AbstractBytePrimitive, AbstractCharacterPrimitive, AbstractConstant, AbstractConstantAccumulator, AbstractDoublePrimitive, AbstractFloatPrimitive, AbstractIntegerPrimitive, AbstractLongPrimitive, AbstractModuloIntegerPrimitive, AbstractNumericPrimitive, AbstractPrimitive, AbstractPrimitiveWrapper, AbstractShortPrimitive, AbstractSimpleAccumulator, AbstractStickyTarget, AbstractTextPrimitive, AbstractUnlimitedDecimalPrimitive, AbstractUnlimitedIntegerPrimitive, BooleanArrayCursor, BooleanPrimitive, ByteArrayCursor, BytePrimitive, CharacterArrayCursor, CharacterPrimitive, Constant, ConstantAccumulator, DoublePrimitive, EnumerationPrimitive, FloatPrimitive, GaussianRandomPrimitive, IntegerPrimitive, LongPrimitive, Milliseconds, ModuloIntegerPrimitive, Nanoseconds, RandomPrimitive, ShortPrimitive, SimpleAccumulator, TextPrimitive, UnlimitedDecimalPrimitive, UnlimitedIntegerPrimitive, Variant

public interface MutablePrimitive<PRIMITIVE extends MutablePrimitive<PRIMITIVE>>
extends MutableText<PRIMITIVE>, MutableReal<PRIMITIVE>, MutableScalar<PRIMITIVE>

Write operations for system supported primitives. "Primitives", as defined in the UML 2.1 specification, are:

• boolean
• byte
• char
• int
• long
• float
• double
• short
• unlimited integer
• unlimited decimal
• text

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

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<?> y) Set this value to the angle formed by the rectangular coordinates given by the current value, x, and the specified value, y.
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<?> y) 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
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	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	setPrimitive(SealedPrimitive<?> aValue) Set this property to the specified primitive
PRIMITIVE	sumOfPrimitive(SealedPrimitive<?> aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value.
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 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

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.MutableUnlimitedIntegerValue

setReal, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement

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

setReal, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement

Method Detail

andOfPrimitive

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

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

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

PRIMITIVE angleWithPrimitive(SealedPrimitive<?> y)
                                                                 throws UnsupportedOperationException,
                                                                        IllegalArgumentException,
                                                                        ArithmeticException

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).

Parameters:

y - 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)

differenceOfPrimitive

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

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

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

PRIMITIVE hypotenuseWithPrimitive(SealedPrimitive<?> y)
                                                                      throws UnsupportedOperationException,
                                                                             IllegalArgumentException,
                                                                             ArithmeticException

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

Parameters:

y - 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)

modOfPrimitive

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setBoolean

PRIMITIVE setBoolean(Boolean aValue)
                                                         throws UnsupportedOperationException,
                                                                IllegalArgumentException,
                                                                ArithmeticException,
                                                                NullPointerException

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

Parameters:

aValue - a system-supported Boolean

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

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

setCharacter

PRIMITIVE setCharacter(Character aValue)
                                                           throws UnsupportedOperationException,
                                                                  IllegalArgumentException,
                                                                  ArithmeticException,
                                                                  NullPointerException

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

Parameters:

aValue - a system-supported Character

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

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

setPrimitive

PRIMITIVE setPrimitive(SealedPrimitive<?> aValue)
                                                           throws UnsupportedOperationException,
                                                                  IllegalArgumentException,
                                                                  ArithmeticException,
                                                                  NullPointerException

Set this property to the specified primitive

Parameters:

aValue - a primitive

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

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

sumOfPrimitive

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

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

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

xorOfPrimitive

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

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

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