net.sf.jaccumulator.scalars

Interface SealedScalar<SCALAR extends SealedScalar<SCALAR>>

Type Parameters:

SCALAR - the type of scalar to produce from the Replicator.copy() function

All Superinterfaces:

CharacterProperties, NumericProperties, Replicator<SCALAR>, ScalarReplicator<SCALAR>, SealedAlgebraicStructure, SealedBooleanValue, SealedByteValue, SealedCharacterValue, SealedDoubleValue, SealedFloatValue, SealedIntegerValue, SealedKernel, SealedLongValue, SealedScalarBag, SealedScalarDomain, SealedShortValue, StructureProperties

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Real<REAL>, Scalar<SCALAR>, SealedAccumulator<ACCUMULATOR>, SealedPrimitive<PRIMITIVE>, SealedReal<REAL>

All Known Implementing Classes:

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

public interface SealedScalar<SCALAR extends SealedScalar<SCALAR>>
extends SealedScalarDomain, SealedKernel, NumericProperties, CharacterProperties, ScalarReplicator<SCALAR>, SealedBooleanValue, SealedByteValue, SealedCharacterValue, SealedDoubleValue, SealedFloatValue, SealedIntegerValue, SealedLongValue, SealedShortValue

Read operations for all system supported "scalar" values, or binary vectors optimized for processing and generally participate in arithmetic operators supported by the host programming language

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareToNumber(Number aValue) Compares this object with the specified object for order
int	compareToScalar(boolean aValue) Compares this object with the specified scalar for order
int	compareToScalar(byte aValue) Compares this object with the specified scalar for order
int	compareToScalar(char aValue) Compares this object with the specified scalar for order
int	compareToScalar(double aValue) Compares this object with the specified scalar for order
int	compareToScalar(float aValue) Compares this object with the specified scalar for order
int	compareToScalar(int aValue) Compares this object with the specified scalar for order
int	compareToScalar(long aValue) Compares this object with the specified scalar for order
int	compareToScalar(SealedScalar<?> aValue) Compares this object with the specified object for order
int	compareToScalar(short aValue) Compares this object with the specified scalar for order
int	compareToZero() Compares this object with zero for order
boolean	isEqual(boolean aScalar)
boolean	isEqual(byte aScalar)
boolean	isEqual(char aScalar)
boolean	isEqual(double aScalar)
boolean	isEqual(float aScalar)
boolean	isEqual(int aScalar)
boolean	isEqual(long aScalar)
boolean	isEqual(short aScalar)
boolean	isEqualToNumber(Number aValue)
boolean	isEqualToScalar(SealedScalar<?> aScalar)
boolean	isFalse()
boolean	isGreater(boolean aScalar)
boolean	isGreater(byte aScalar)
boolean	isGreater(char aScalar)
boolean	isGreater(double aScalar)
boolean	isGreater(float aScalar)
boolean	isGreater(int aScalar)
boolean	isGreater(long aScalar)
boolean	isGreater(short aScalar)
boolean	isGreaterOrEqual(boolean aScalar)
boolean	isGreaterOrEqual(byte aScalar)
boolean	isGreaterOrEqual(char aScalar)
boolean	isGreaterOrEqual(double aScalar)
boolean	isGreaterOrEqual(float aScalar)
boolean	isGreaterOrEqual(int aScalar)
boolean	isGreaterOrEqual(long aScalar)
boolean	isGreaterOrEqual(short aScalar)
boolean	isGreaterOrEqualToNumber(Number aValue)
boolean	isGreaterOrEqualToScalar(SealedScalar<?> aScalar)
boolean	isGreaterThanNumber(Number aValue)
boolean	isGreaterThanScalar(SealedScalar<?> aScalar)
boolean	isLess(boolean aScalar)
boolean	isLess(byte aScalar)
boolean	isLess(char aScalar)
boolean	isLess(double aScalar)
boolean	isLess(float aScalar)
boolean	isLess(int aScalar)
boolean	isLess(long aScalar)
boolean	isLess(short aScalar)
boolean	isLessOrEqual(boolean aScalar)
boolean	isLessOrEqual(byte aScalar)
boolean	isLessOrEqual(char aScalar)
boolean	isLessOrEqual(double aScalar)
boolean	isLessOrEqual(float aScalar)
boolean	isLessOrEqual(int aScalar)
boolean	isLessOrEqual(long aScalar)
boolean	isLessOrEqual(short aScalar)
boolean	isLessOrEqualToNumber(Number aValue)
boolean	isLessOrEqualToScalar(SealedScalar<?> aScalar)
boolean	isLessThanNumber(Number aValue)
boolean	isLessThanScalar(SealedScalar<?> aScalar)
boolean	isNotEqual(boolean aScalar)
boolean	isNotEqual(byte aScalar)
boolean	isNotEqual(char aScalar)
boolean	isNotEqual(double aScalar)
boolean	isNotEqual(float aScalar)
boolean	isNotEqual(int aScalar)
boolean	isNotEqual(long aScalar)
boolean	isNotEqual(short aScalar)
boolean	isNotEqualToNumber(Number aValue)
boolean	isNotEqualToScalar(SealedScalar<?> aScalar)
boolean	isTrue()
Boolean	toBoolean()
Character	toCharacter()
int	toCodePoint() Represent the value of this object as a code point
<E extends Enum<E>> E	toEnumeration(Class<E> anEnumerationClass) Represent the value of this object as an appropriate member of the class of the specified enumeration
Number	toNumber()

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

getPrecision, induceScalarMaximum, induceScalarMinimum

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

induceScalarSize

Methods inherited from interface net.sf.jaccumulator.SealedAlgebraicStructure

getDomain, getStructureStrategy, longSize, size

Methods inherited from interface net.sf.jaccumulator.StructureProperties

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

Methods inherited from interface net.sf.jaccumulator.SealedKernel

equals, getConcurrency, hashCode, toString

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

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

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

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

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

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

Methods inherited from interface net.sf.jaccumulator.Replicator

copy

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

booleanValue

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

byteValue

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

charValue

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

doubleValue

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

floatValue

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

intValue

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

longValue

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

shortValue

Method Detail

compareToNumber

int compareToNumber(Number aValue)

Compares this object with the specified object for order

Parameters:

aValue - an object to be compared to

Returns:

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

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(boolean aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(byte aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(char aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(double aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(float aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(int aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(long aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(SealedScalar<?> aValue)

Compares this object with the specified object for order

Parameters:

aValue - an object to be compared to

Returns:

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

See Also:

Comparable.compareTo(Object)

compareToScalar

int compareToScalar(short aValue)

Compares this object with the specified scalar for order

Parameters:

aValue - a scalar to be compared to

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified scalar.

See Also:

Comparable.compareTo(Object)

compareToZero

int compareToZero()

Compares this object with zero for order

Returns:

a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than zero

See Also:

Comparable.compareTo(Object)

isEqual

boolean isEqual(boolean aScalar)

isEqual

boolean isEqual(byte aScalar)

isEqual

boolean isEqual(char aScalar)

isEqual

boolean isEqual(double aScalar)

isEqual

boolean isEqual(float aScalar)

isEqual

boolean isEqual(int aScalar)

isEqual

boolean isEqual(long aScalar)

isEqual

boolean isEqual(short aScalar)

isEqualToNumber

boolean isEqualToNumber(Number aValue)

isEqualToScalar

boolean isEqualToScalar(SealedScalar<?> aScalar)

isFalse

boolean isFalse()

Returns:

this object represents a false value if boolean, or the additive identity otherwise

isGreater

boolean isGreater(boolean aScalar)

isGreater

boolean isGreater(byte aScalar)

isGreater

boolean isGreater(char aScalar)

isGreater

boolean isGreater(double aScalar)

isGreater

boolean isGreater(float aScalar)

isGreater

boolean isGreater(int aScalar)

isGreater

boolean isGreater(long aScalar)

isGreater

boolean isGreater(short aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(boolean aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(byte aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(char aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(double aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(float aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(int aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(long aScalar)

isGreaterOrEqual

boolean isGreaterOrEqual(short aScalar)

isGreaterOrEqualToNumber

boolean isGreaterOrEqualToNumber(Number aValue)

isGreaterOrEqualToScalar

boolean isGreaterOrEqualToScalar(SealedScalar<?> aScalar)

isGreaterThanNumber

boolean isGreaterThanNumber(Number aValue)

isGreaterThanScalar

boolean isGreaterThanScalar(SealedScalar<?> aScalar)

isLess

boolean isLess(boolean aScalar)

isLess

boolean isLess(byte aScalar)

isLess

boolean isLess(char aScalar)

isLess

boolean isLess(double aScalar)

isLess

boolean isLess(float aScalar)

isLess

boolean isLess(int aScalar)

isLess

boolean isLess(long aScalar)

isLess

boolean isLess(short aScalar)

isLessOrEqual

boolean isLessOrEqual(boolean aScalar)

isLessOrEqual

boolean isLessOrEqual(byte aScalar)

isLessOrEqual

boolean isLessOrEqual(char aScalar)

isLessOrEqual

boolean isLessOrEqual(double aScalar)

isLessOrEqual

boolean isLessOrEqual(float aScalar)

isLessOrEqual

boolean isLessOrEqual(int aScalar)

isLessOrEqual

boolean isLessOrEqual(long aScalar)

isLessOrEqual

boolean isLessOrEqual(short aScalar)

isLessOrEqualToNumber

boolean isLessOrEqualToNumber(Number aValue)

isLessOrEqualToScalar

boolean isLessOrEqualToScalar(SealedScalar<?> aScalar)

isLessThanNumber

boolean isLessThanNumber(Number aValue)

isLessThanScalar

boolean isLessThanScalar(SealedScalar<?> aScalar)

isNotEqual

boolean isNotEqual(boolean aScalar)

isNotEqual

boolean isNotEqual(byte aScalar)

isNotEqual

boolean isNotEqual(char aScalar)

isNotEqual

boolean isNotEqual(double aScalar)

isNotEqual

boolean isNotEqual(float aScalar)

isNotEqual

boolean isNotEqual(int aScalar)

isNotEqual

boolean isNotEqual(long aScalar)

isNotEqual

boolean isNotEqual(short aScalar)

isNotEqualToNumber

boolean isNotEqualToNumber(Number aValue)

isNotEqualToScalar

boolean isNotEqualToScalar(SealedScalar<?> aScalar)

isTrue

boolean isTrue()

Returns:

this object represents a true value if boolean, or the multiplicative identity otherwise

toBoolean

Boolean toBoolean()

Returns:

this object as a best-match, system-supported Boolean object

toCharacter

Character toCharacter()

Returns:

this object as a best-match, system-supported Boolean object

toCodePoint

int toCodePoint()

Represent the value of this object as a code point

Returns:

the value of this object represented as a single code point

toEnumeration

<E extends Enum<E>> E toEnumeration(Class<E> anEnumerationClass)
                             throws ArithmeticException,
                                    IllegalArgumentException,
                                    NullPointerException

Represent the value of this object as an appropriate member of the class of the specified enumeration

Parameters:

anEnumerationClass - the class of enumeration to convert to

Returns:

this object (facilitates operation chaining)

Throws:

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

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

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

toNumber

Number toNumber()

Returns:

this object as a best-match, system-supported Number object