net.sf.jaccumulator.floats

Class FloatPrimitive

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.floats.AbstractFloatPrimitive<FloatPrimitive>

net.sf.jaccumulator.floats.FloatPrimitive

All Implemented Interfaces:

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

public final class FloatPrimitive
extends AbstractFloatPrimitive<FloatPrimitive>

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

Method Summary

Methods

Modifier and Type	Method and Description
FloatPrimitive	copy() Produce a replica of this object
FloatPrimitive	copyUsing(float aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
FloatPrimitive	decrement() Replace the current value with the current value minus unity (one)
FloatPrimitive	difference(float aValue) Set the value of this scalar to the mathematical difference between its current value and the specified value
float	floatPostDecrement() Decrement the scalar value of this object then return the original value prior to decrementing
float	floatPostIncrement() Increment the scalar value of this object then return the original value prior to incrementing
float	floatValue()
ConcurrencyStrategy	getConcurrency()
FloatPrimitive	increment() Replace the current value with the current value plus unity (one)
FloatPrimitive	mod(float aValue) Set the value of this scalar to its current value modulo of the specified value
FloatPrimitive	product(float aValue) Set the value of this scalar to the mathematical product of its current value and the specified value
FloatPrimitive	quotient(float aValue) Set the value of this scalar to the mathematical quotient of its current value and the specified value
FloatPrimitive	setScalar(float aValue) Set this property to the specified float value and answer this object (facilitates chaining)
FloatPrimitive	sum(float aValue) Set the value of this scalar to the mathematical sum of its current value and the specified value

Methods inherited from class net.sf.jaccumulator.floats.AbstractFloatPrimitive

absoluteValue, and, and, 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, difference, difference, difference, doublePostDecrement, doublePostIncrement, doubleValue, inducePostDecrement, inducePostIncrement, induceRealMaximum, induceRealMinimum, induceRealValue, induceScalarMaximum, induceScalarMinimum, induceScalarValue, intPostDecrement, intPostIncrement, intValue, invalidate, inverse, isInfinity, isInvalid, isMaximum, isMinimum, isModulo, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isUnity, isZero, longPostDecrement, longPostIncrement, longValue, negate, not, or, or, or, or, or, or, or, product, product, product, product, product, product, product, product, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, round, setMaximum, setMinimum, setNegativeInfinity, setNumber, setPositiveInfinity, setPrimitive, setReal, setReal, setReal, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setUnity, setZero, shiftLeft, shiftRight, shiftRightExtendZero, shortPostDecrement, shortPostIncrement, shortValue, signum, square, sum, sum, sum, sum, sum, sum, sum, sum, swapPrimitives, toNumber, toString, toUnlimitedDecimal, toUnlimitedInteger, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement, xor, xor, 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

andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, 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, orOfNumber, orOfReal, powerOfReal, productOfNumber, productOfReal, quotientOfNumber, quotientOfReal, sumOfNumber, sumOfReal, toReal, unlimitedIntegerModularInverse, 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, 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, isAlphabetic, isBmpCodePoint, isConfigurable, isCountable, isDigit, isElastic, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isExpandable, isFalse, isFinite, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToScalar, isGreaterThanScalar, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isImaginary, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToScalar, isLessThanScalar, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isMutable, 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, productOfScalar, promoteTo, quotient, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setEnumeration, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setPi, setShortBitAt, setTrue, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, shortMaskAt, shortNotMaskAt, shortValue, sine, size, squareRoot, 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

isFinite, isImaginary, isValid

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

andOfReal, angleWithReal, differenceOfReal, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, modOfReal, orOfReal, powerOfReal, productOfReal, quotientOfReal, sumOfReal, xorOfReal

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

andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, degrees, difference, differenceOfNumber, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, milliseconds, mod, mod, mod, mod, mod, mod, mod, modOfNumber, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, productOfNumber, productOfScalar, quotient, quotientOfNumber, quotientOfScalar, radians, random, setE, setEnumeration, setPi, sine, squareRoot, 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

FloatPrimitive

public FloatPrimitive()

FloatPrimitive

public FloatPrimitive(BigDecimal aValue)

FloatPrimitive

public FloatPrimitive(BigInteger aValue)

FloatPrimitive

public FloatPrimitive(boolean aValue)

FloatPrimitive

public FloatPrimitive(byte aValue)

FloatPrimitive

public FloatPrimitive(char aValue)

FloatPrimitive

public FloatPrimitive(double aValue)

FloatPrimitive

public FloatPrimitive(float aValue)

FloatPrimitive

public FloatPrimitive(int aValue)

FloatPrimitive

public FloatPrimitive(long aValue)

FloatPrimitive

public FloatPrimitive(SealedScalar<?> aValue)

FloatPrimitive

public FloatPrimitive(short aValue)

FloatPrimitive

public FloatPrimitive(String aValue)

Method Detail

copy

public final FloatPrimitive copy()

Description copied from interface: Replicator

Produce a replica of this object

Returns:

a replica of this object

copyUsing

public final FloatPrimitive copyUsing(float 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 FloatPrimitive 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 FloatPrimitive difference(float 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<FloatPrimitive>

Overrides:

difference in class AbstractScalar<FloatPrimitive>

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

floatPostDecrement

public final float floatPostDecrement()
                               throws UnsupportedOperationException,
                                      ArithmeticException,
                                      IllegalArgumentException

Description copied from interface: MutableFloatValue

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

floatPostIncrement

public float floatPostIncrement()
                         throws UnsupportedOperationException,
                                ArithmeticException,
                                IllegalArgumentException

Description copied from interface: MutableFloatValue

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

floatValue

public final float floatValue()

Specified by:

floatValue in interface SealedFloatValue

Specified by:

floatValue in class Number

Returns:

the property value as a system float

getConcurrency

public final ConcurrencyStrategy getConcurrency()

Returns:

the supported threading strategy

increment

public FloatPrimitive 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 FloatPrimitive mod(float 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<FloatPrimitive>

Overrides:

mod in class AbstractScalar<FloatPrimitive>

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

product

public final FloatPrimitive product(float 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<FloatPrimitive>

Overrides:

product in class AbstractScalar<FloatPrimitive>

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 FloatPrimitive quotient(float 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<FloatPrimitive>

Overrides:

quotient in class AbstractScalar<FloatPrimitive>

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

Description copied from interface: MutableFloatValue

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

Parameters:

aValue - a float 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

sum

public final FloatPrimitive sum(float 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<FloatPrimitive>

Overrides:

sum in class AbstractScalar<FloatPrimitive>

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