net.sf.jaccumulator.longs

Class LongPrimitive

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.longs.AbstractLongPrimitive<LongPrimitive>

net.sf.jaccumulator.longs.LongPrimitive

All Implemented Interfaces:

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

public final class LongPrimitive
extends AbstractLongPrimitive<LongPrimitive>

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

Method Summary

Methods

Modifier and Type	Method and Description
LongPrimitive	and(long aValue) Set this value to the bit and of the integral boolean vector equivalent of this value and the specified integral boolean vector
LongPrimitive	copy() Produce a replica of this object
LongPrimitive	copyUsing(long aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
LongPrimitive	decrement() Replace the current value with the current value minus unity (one)
LongPrimitive	difference(long aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
ConcurrencyStrategy	getConcurrency()
LongPrimitive	increment() Replace the current value with the current value plus unity (one)
long	longPostDecrement() Decrement the scalar value of this object then return the original value prior to decrementing
long	longPostIncrement() Increment the scalar value of this object then return the original value prior to incrementing
long	longValue()
LongPrimitive	mod(long aValue) Set the value of this scalar to its current value modulo of the specified value
LongPrimitive	not() Replace the current integral binary vector with its one's complement.
LongPrimitive	or(long aValue) Set this value to the bit or of the integral boolean vector equivalent of this value and the specified integral boolean vector
LongPrimitive	product(long aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
LongPrimitive	quotient(long aValue) Set the value of this scalar to the mathematical quotient of its current value and the specified value
LongPrimitive	setScalar(long aValue) Set this property to the specified long value and answer this object (facilitates chaining)
LongPrimitive	shiftLeft(int count) Attempt to shift the elements of this tuple to the "left" the specified number of ordinal positions.
LongPrimitive	shiftRight(int count) Attempt to shift the elements of this tuple to the "right" the specified number of ordinal positions.
LongPrimitive	shiftRightExtendZero(int count) Attempt to shift the elements of this tuple to the "right" the specified number of ordinal positions without sign extension.
LongPrimitive	sum(long aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value
LongPrimitive	xor(long aValue) Set this value to the bit exclusive-or of the integral boolean vector equivalent of this value and the specified integral boolean vector

Methods inherited from class net.sf.jaccumulator.longs.AbstractLongPrimitive

absoluteValue, and, and, 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, difference, difference, doublePostDecrement, doublePostIncrement, doubleValue, floatPostDecrement, floatPostIncrement, floatValue, inducePostDecrement, inducePostIncrement, induceRealMaximum, induceRealMinimum, induceRealValue, induceScalarMaximum, induceScalarMinimum, induceScalarValue, intPostDecrement, intPostIncrement, intValue, inverse, isFinite, isInfinity, isInvalid, isMaximum, isMinimum, isModulo, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isUnity, isZero, negate, or, or, or, or, or, product, product, product, product, product, quotient, quotient, quotient, quotient, quotient, round, setMaximum, setMinimum, setNumber, setPrimitive, setReal, setReal, setReal, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setUnity, setZero, shortPostDecrement, shortPostIncrement, shortValue, square, sum, sum, sum, sum, sum, swapPrimitives, toNumber, toString, toUnlimitedDecimal, toUnlimitedInteger, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement, xor, xor, 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, lowerCase, 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, titleCase, toPrimitive, toPrimitive, trim, upperCase

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

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, 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, 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, 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, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isOrdered, 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, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, productOfScalar, promoteTo, 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, sumOfScalar, tangent, toBoolean, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toCharacter, toCodePoint, toEnumeration, toScalar, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xorOfScalar

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, 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.SealedKernel

hashCode

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

isImaginary, isValid, 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.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

andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, degrees, 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, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, productOfNumber, productOfScalar, quotient, quotient, quotientOfNumber, quotientOfScalar, radians, random, setE, setEnumeration, setNegativeInfinity, setPi, setPositiveInfinity, sine, squareRoot, sum, sum, sumOfNumber, sumOfScalar, tangent, up, 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

LongPrimitive

public LongPrimitive()

LongPrimitive

public LongPrimitive(BigDecimal aValue)

LongPrimitive

public LongPrimitive(BigInteger aValue)

LongPrimitive

public LongPrimitive(boolean aValue)

LongPrimitive

public LongPrimitive(byte aValue)

LongPrimitive

public LongPrimitive(char aValue)

LongPrimitive

public LongPrimitive(double aValue)

LongPrimitive

public LongPrimitive(float aValue)

LongPrimitive

public LongPrimitive(int aValue)

LongPrimitive

public LongPrimitive(long aValue)

LongPrimitive

public LongPrimitive(SealedScalar<?> aValue)

LongPrimitive

public LongPrimitive(short aValue)

LongPrimitive

public LongPrimitive(String aValue)

Method Detail

and

public final LongPrimitive and(long 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<LongPrimitive>

Overrides:

and in class AbstractScalar<LongPrimitive>

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 LongPrimitive copy()

Description copied from interface: Replicator

Produce a replica of this object

Returns:

a replica of this object

copyUsing

public final LongPrimitive copyUsing(long 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 LongPrimitive 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 LongPrimitive difference(long 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<LongPrimitive>

Overrides:

difference in class AbstractScalar<LongPrimitive>

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 LongPrimitive 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

longPostDecrement

public final long longPostDecrement()
                             throws UnsupportedOperationException,
                                    ArithmeticException,
                                    IllegalArgumentException

Description copied from interface: MutableLongValue

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

longPostIncrement

public final long longPostIncrement()
                             throws UnsupportedOperationException,
                                    ArithmeticException,
                                    IllegalArgumentException

Description copied from interface: MutableLongValue

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

longValue

public final long longValue()

Specified by:

longValue in interface SealedLongValue

Specified by:

longValue in class Number

Returns:

the property value as a system long

mod

public final LongPrimitive mod(long 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<LongPrimitive>

Overrides:

mod in class AbstractScalar<LongPrimitive>

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 LongPrimitive 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 LongPrimitive or(long 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<LongPrimitive>

Overrides:

or in class AbstractScalar<LongPrimitive>

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 LongPrimitive product(long 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<LongPrimitive>

Overrides:

product in class AbstractScalar<LongPrimitive>

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 LongPrimitive quotient(long 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<LongPrimitive>

Overrides:

quotient in class AbstractScalar<LongPrimitive>

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 LongPrimitive setScalar(long aValue)
                              throws UnsupportedOperationException,
                                     IllegalArgumentException,
                                     ArithmeticException

Description copied from interface: MutableLongValue

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

Parameters:

aValue - a long 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 LongPrimitive 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 LongPrimitive 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 LongPrimitive 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<LongPrimitive>

Overrides:

shiftRightExtendZero in class AbstractScalar<LongPrimitive>

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

sum

public final LongPrimitive sum(long 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<LongPrimitive>

Overrides:

sum in class AbstractScalar<LongPrimitive>

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 LongPrimitive xor(long 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<LongPrimitive>

Overrides:

xor in class AbstractScalar<LongPrimitive>

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