net.sf.jaccumulator.reals

Interface SealedRealDomain

All Superinterfaces:

SealedAlgebraicStructure, SealedRealBag, SealedScalarBag, SealedScalarDomain, StructureProperties

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Real<REAL>, RealDomain<DOMAIN>, 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, 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 SealedRealDomain
extends SealedScalarDomain, SealedRealBag

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

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
<R extends Real<?>> R	induceRealMaximum(R aTarget) Induce the maximum domain value into the target
<R extends Real<?>> R	induceRealMinimum(R aTarget) Induce the minimum domain value into the target

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

getPrecision, induceScalarMaximum, induceScalarMinimum

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

Methods inherited from interface net.sf.jaccumulator.StructureProperties

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

Method Detail

induceRealMaximum

<R extends Real<?>> R induceRealMaximum(R aTarget)
                                 throws NullPointerException,
                                        NoSuchElementException,
                                        UnsupportedOperationException,
                                        IllegalStateException

Induce the maximum domain value into the target

Type Parameters:

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

induceRealMinimum

<R extends Real<?>> R induceRealMinimum(R aTarget)
                                 throws NullPointerException,
                                        NoSuchElementException,
                                        UnsupportedOperationException,
                                        IllegalStateException

Induce the minimum domain value into the target

Type Parameters:

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