net.sf.jaccumulator.reals

Interface SealedRealBag

All Superinterfaces:

SealedAlgebraicStructure, SealedScalarBag, StructureProperties

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Real<REAL>, RealDomain<DOMAIN>, SealedAccumulator<ACCUMULATOR>, SealedPrimitive<PRIMITIVE>, SealedReal<REAL>, SealedRealDomain

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

A read-only algebraic structure with a real ordinality (element count)

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

Method Summary

Methods

Modifier and Type	Method and Description
<R extends Real<?>> R	induceRealSize(R aTarget) Update the target scalar with the element count in this structure

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

induceRealSize

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

Update the target scalar with the element count in this structure

Type Parameters:

R - the target type

Parameters:

aTarget - the target to update

Returns:

the target scalar (facilitates operation chaining)

Throws:

UnsupportedOperationException - this target cannot be changed

IllegalStateException - this target 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