net.sf.jaccumulator.shorts

Class ShortPrimitive

java.lang.Object

java.lang.Number

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

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

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

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

net.sf.jaccumulator.shorts.AbstractShortPrimitive<ShortPrimitive>

net.sf.jaccumulator.shorts.ShortPrimitive

All Implemented Interfaces:

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

public final class ShortPrimitive
extends AbstractShortPrimitive<ShortPrimitive>

A short precision primitive implementation

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
ShortPrimitive()
ShortPrimitive(BigDecimal aValue)
ShortPrimitive(BigInteger aValue)
ShortPrimitive(boolean aValue)
ShortPrimitive(byte aValue)
ShortPrimitive(char aValue)
ShortPrimitive(double aValue)
ShortPrimitive(float aValue)
ShortPrimitive(int aValue)
ShortPrimitive(long aValue)
ShortPrimitive(SealedScalar<?> aValue)
ShortPrimitive(short aValue)
ShortPrimitive(String aValue)

Method Summary

Methods

Modifier and Type	Method and Description
ShortPrimitive	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
ShortPrimitive	copy() Produce a replica of this object
ShortPrimitive	copyUsing(short aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ShortPrimitive	decrement() Replace the current value with the current value minus unity (one)
ShortPrimitive	difference(short aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
ConcurrencyStrategy	getConcurrency()
ShortPrimitive	increment() Replace the current value with the current value plus unity (one)
ShortPrimitive	mod(short aValue) Set the value of this scalar to its current value modulo of the specified value
ShortPrimitive	not() Replace the current integral binary vector with its one's complement.
ShortPrimitive	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
ShortPrimitive	product(short aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
ShortPrimitive	quotient(short aValue) Set the value of this scalar to the mathematical quotient of its current value and the specified value
ShortPrimitive	setScalar(short aValue) Set this property to the specified short value and answer this object (facilitates chaining)
ShortPrimitive	shiftLeft(int count) Attempt to shift the elements of this tuple to the "left" the specified number of ordinal positions.
ShortPrimitive	shiftRight(int count) Attempt to shift the elements of this tuple to the "right" the specified number of ordinal positions.
ShortPrimitive	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()
ShortPrimitive	sum(short aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
ShortPrimitive	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

Methods inherited from class net.sf.jaccumulator.shorts.AbstractShortPrimitive

absoluteValue, and, and, and, booleanPostDecrement, booleanPostIncrement, booleanValue, bytePostDecrement, bytePostIncrement, byteValue, charPostDecrement, charPostIncrement, charValue, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsingPrimitive, copyUsingReal, copyUsingScalar, cube, difference, difference, difference, doublePostDecrement, doublePostIncrement, doubleValue, floatPostDecrement, floatPostIncrement, floatValue, hashCode, inducePostDecrement, inducePostIncrement, induceRealMaximum, induceRealMinimum, induceRealValue, induceScalarMaximum, induceScalarMinimum, induceScalarValue, intPostDecrement, intPostIncrement, intValue, inverse, isDigit, isFinite, isIdentifierIgnorable, isInfinity, isInvalid, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLetter, isLetterOrDigit, isLowerCase, isMaximum, isMinimum, isMirrored, isModulo, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isTitleCase, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUnity, isUpperCase, isWhitespace, isZero, longPostDecrement, longPostIncrement, longValue, lowerCase, negate, or, or, or, product, product, product, quotient, quotient, quotient, round, setMaximum, setMinimum, setNumber, setPrimitive, setReal, setReal, setReal, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setUnity, setZero, square, sum, sum, sum, swapPrimitives, titleCase, toNumber, toString, toUnlimitedDecimal, toUnlimitedInteger, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement, upperCase, xor, xor, xor

Methods inherited from class net.sf.jaccumulator.primitives.AbstractNumericPrimitive

append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, charAt, clear, clearContents, clearText, codePointAt, codePointBefore, codePointCount, compareTo, compareToPrimitive, copyUsingText, delete, deleteCharAt, equals, getStructureStrategy, indexOfText, indexOfText, inducePostDecrement, inducePostDecrement, inducePostIncrement, inducePostIncrement, inducePrimitiveValue, induceTextValue, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, isEmpty, isEqualToPrimitive, isEqualToText, isGreaterOrEqualToPrimitive, isGreaterOrEqualToText, isGreaterThanPrimitive, isGreaterThanText, isLessOrEqualToPrimitive, isLessOrEqualToText, isLessThanPrimitive, isLessThanText, isNotEqualToPrimitive, isNotEqualToText, isText, length, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, setBoolean, setCharacter, setCharAt, setLength, setText, subSequence, substring, substring, textPostDecrement, textPostIncrement, toPrimitive, toPrimitive, trim

Methods inherited from class net.sf.jaccumulator.primitives.AbstractPrimitive

andOfPrimitive, angleWithPrimitive, compareToText, differenceOfPrimitive, hypotenuseWithPrimitive, inducePrimitiveMaximum, inducePrimitiveMinimum, induceTextSize, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, toPrimitive, xorOfPrimitive

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

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

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

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, 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, isElastic, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isExpandable, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToScalar, isGreaterThanScalar, isHighSurrogate, isIdeographic, isImaginary, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToScalar, isLessThanScalar, isLowSurrogate, isMutable, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isOrdered, isReducible, isSupplementaryCodePoint, isSurrogate, isTrue, isUnique, isValid, isValidCodePoint, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longSize, longValue, milliseconds, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, productOfScalar, promoteTo, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setEnumeration, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setNegativeInfinity, setPi, setPositiveInfinity, setShortBitAt, setTrue, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, shortMaskAt, shortNotMaskAt, shortValue, signum, sine, size, squareRoot, 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, xorOfScalar

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

isImaginary, isValid, signum

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

isAlphabetic, isBmpCodePoint, isHighSurrogate, isIdeographic, isLowSurrogate, isSupplementaryCodePoint, isSurrogate, isValidCodePoint

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

getPrecision

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, longSize, size

Methods inherited from interface net.sf.jaccumulator.StructureProperties

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

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

toReal

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

toScalar

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, sum, sum, sumOfReal, xor, xorOfReal

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

and, and, andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, degrees, 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, invalidate, milliseconds, mod, mod, mod, mod, mod, mod, mod, modOfNumber, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, productOfNumber, productOfScalar, quotient, quotient, quotient, quotient, quotientOfNumber, quotientOfScalar, radians, random, setE, setEnumeration, setNegativeInfinity, setPi, setPositiveInfinity, sine, squareRoot, sum, sum, sum, sum, sumOfNumber, sumOfScalar, tangent, up, xor, xor, xorOfNumber, xorOfScalar

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

setFalse, setTrue

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

assertPrecision, promoteTo

Methods inherited from interface net.sf.jaccumulator.MutableAlgebraicStructure

assertDomain

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

Constructor Detail

ShortPrimitive

public ShortPrimitive()

ShortPrimitive

public ShortPrimitive(BigDecimal aValue)

ShortPrimitive

public ShortPrimitive(BigInteger aValue)

ShortPrimitive

public ShortPrimitive(boolean aValue)

ShortPrimitive

public ShortPrimitive(byte aValue)

ShortPrimitive

public ShortPrimitive(char aValue)

ShortPrimitive

public ShortPrimitive(double aValue)

ShortPrimitive

public ShortPrimitive(float aValue)

ShortPrimitive

public ShortPrimitive(int aValue)

ShortPrimitive

public ShortPrimitive(long aValue)

ShortPrimitive

public ShortPrimitive(SealedScalar<?> aValue)

ShortPrimitive

public ShortPrimitive(short aValue)

ShortPrimitive

public ShortPrimitive(String aValue)

Method Detail

and

public final ShortPrimitive and(short aValue)
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

and in interface MutableScalar<ShortPrimitive>

Overrides:

and in class AbstractScalar<ShortPrimitive>

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

copy

public final ShortPrimitive copy()

Description copied from interface: Replicator

Produce a replica of this object

Returns:

a replica of this object

copyUsing

public final ShortPrimitive copyUsing(short aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

decrement

public ShortPrimitive decrement()
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

Replace the current value with the current value minus unity (one)

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

difference

public final ShortPrimitive difference(short aValue)
                                throws UnsupportedOperationException,
                                       IllegalArgumentException,
                                       ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

difference in interface MutableScalar<ShortPrimitive>

Overrides:

difference in class AbstractScalar<ShortPrimitive>

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

getConcurrency

public final ConcurrencyStrategy getConcurrency()

Returns:

the supported threading strategy

increment

public ShortPrimitive increment()
                         throws UnsupportedOperationException,
                                ArithmeticException,
                                IllegalArgumentException

Description copied from interface: MutableScalar

Replace the current value with the current value plus unity (one)

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

mod

public final ShortPrimitive mod(short aValue)
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

mod in interface MutableScalar<ShortPrimitive>

Overrides:

mod in class AbstractScalar<ShortPrimitive>

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

not

public final ShortPrimitive not()
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

Replace the current integral binary vector with its one's complement. Decimal values, such as double, will be first converted to unlimited integers before their bits are reversed.

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

or

public final ShortPrimitive or(short aValue)
                        throws UnsupportedOperationException,
                               IllegalArgumentException,
                               ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

or in interface MutableScalar<ShortPrimitive>

Overrides:

or in class AbstractScalar<ShortPrimitive>

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

product

public final ShortPrimitive product(short aValue)
                             throws UnsupportedOperationException,
                                    IllegalArgumentException,
                                    ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

product in interface MutableScalar<ShortPrimitive>

Overrides:

product in class AbstractScalar<ShortPrimitive>

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

quotient

public final ShortPrimitive quotient(short aValue)
                              throws UnsupportedOperationException,
                                     IllegalArgumentException,
                                     ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

quotient in interface MutableScalar<ShortPrimitive>

Overrides:

quotient in class AbstractScalar<ShortPrimitive>

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

setScalar

public final ShortPrimitive setScalar(short aValue)
                               throws UnsupportedOperationException,
                                      IllegalArgumentException,
                                      ArithmeticException

Description copied from interface: MutableShortValue

Set this property to the specified short value and answer this object (facilitates chaining)

Parameters:

aValue - a short value

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

shiftLeft

public final ShortPrimitive shiftLeft(int count)
                               throws UnsupportedOperationException,
                                      IllegalArgumentException,
                                      ArithmeticException

Description copied from interface: MutableScalar

Attempt to shift the elements of this tuple to the "left" the specified number of ordinal positions. In a bit sequence this functions resorts to the familiar "left shift" process (e.g., Java <<). 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.

Parameters:

count - the number of default values to be prepended to this sequence

Returns:

this structure (facilitates chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed or if this structure is not an algebraic tuple

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

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

shiftRight

public final ShortPrimitive shiftRight(int count)
                                throws UnsupportedOperationException,
                                       IllegalArgumentException,
                                       ArithmeticException

Description copied from interface: MutableScalar

Attempt to shift the elements of this tuple to the "right" the specified number of ordinal positions. In a bit sequence this functions resorts to the familiar "right shift" process, with sign extension (e.g., the Java >> 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.

Parameters:

count - the number of values to be removed from the beginning of this sequence

Returns:

this structure (facilitates chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed or if this structure is not an algebraic tuple

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

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

shiftRightExtendZero

public final ShortPrimitive shiftRightExtendZero(int count)
                                          throws UnsupportedOperationException,
                                                 IllegalArgumentException,
                                                 ArithmeticException

Description copied from interface: MutableScalar

Attempt to shift the elements of this tuple to the "right" the specified number of ordinal positions without sign extension. In a bit sequence this functions resorts to the familiar "right shift" process, with zero extension (e.g., the Java >>> 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.

Specified by:

shiftRightExtendZero in interface MutableScalar<ShortPrimitive>

Overrides:

shiftRightExtendZero in class AbstractScalar<ShortPrimitive>

Parameters:

count - the number of values to be removed from the beginning of this sequence

Returns:

this structure (facilitates chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed or if this structure is not an algebraic tuple

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

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

shortPostDecrement

public final short shortPostDecrement()
                               throws UnsupportedOperationException,
                                      ArithmeticException,
                                      IllegalArgumentException

Description copied from interface: MutableShortValue

Decrement the scalar value of this object then return the original value prior to decrementing

Returns:

the original value of this scalar

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

shortPostIncrement

public final short shortPostIncrement()
                               throws UnsupportedOperationException,
                                      ArithmeticException,
                                      IllegalArgumentException

Description copied from interface: MutableShortValue

Increment the scalar value of this object then return the original value prior to incrementing

Returns:

the original value of this scalar

Throws:

UnsupportedOperationException - if this object's value cannot be changed

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

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

shortValue

public final short shortValue()

Specified by:

shortValue in interface SealedShortValue

Overrides:

shortValue in class Number

Returns:

the property value as a system short

sum

public final ShortPrimitive sum(short aValue)
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

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

Specified by:

sum in interface MutableScalar<ShortPrimitive>

Overrides:

sum in class AbstractScalar<ShortPrimitive>

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

xor

public final ShortPrimitive xor(short aValue)
                         throws UnsupportedOperationException,
                                IllegalArgumentException,
                                ArithmeticException

Description copied from interface: MutableScalar

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:

xor in interface MutableScalar<ShortPrimitive>

Overrides:

xor in class AbstractScalar<ShortPrimitive>

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