net.sf.jaccumulator.scalars

Interface SealedScalarDomain

All Superinterfaces:

SealedAlgebraicStructure, SealedScalarBag, StructureProperties

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Real<REAL>, RealDomain<DOMAIN>, Scalar<SCALAR>, ScalarDomain<DOMAIN>, SealedAccumulator<ACCUMULATOR>, SealedPrimitive<PRIMITIVE>, SealedReal<REAL>, SealedRealDomain, SealedScalar<SCALAR>

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 SealedScalarDomain
extends SealedScalarBag

A read-only contract for an algebraic structure within which Scalars can be embedded

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
NumericPrecision	getPrecision()
<S extends Scalar<?>> S	induceScalarMaximum(S aTarget) Induce the maximum domain value into the target
<S extends Scalar<?>> S	induceScalarMinimum(S aTarget) Induce the minimum domain value into the target

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

Method Detail

getPrecision

NumericPrecision getPrecision()

Returns:

the relative size of the implementation's boolean bit tuple

induceScalarMaximum

<S extends Scalar<?>> S induceScalarMaximum(S aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Induce the maximum domain value into the target

Type Parameters:

S - the target type

Parameters:

aTarget - a target into which this domain's maximum value will be induced

Returns:

the target

Throws:

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source

induceScalarMinimum

<S extends Scalar<?>> S induceScalarMinimum(S aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Induce the minimum domain value into the target

Type Parameters:

S - the target type

Parameters:

aTarget - a target into which this domain's minimum value will be induced

Returns:

the target

Throws:

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source