net.sf.jaccumulator.scalars

Interface SealedScalarBag

All Superinterfaces:

SealedAlgebraicStructure, StructureProperties

All Known Subinterfaces:

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

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

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

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

Method Summary

Methods

Modifier and Type	Method and Description
<S extends Scalar<?>> S	induceScalarSize(S aTarget) Update the target scalar with the element count in this structure

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

induceScalarSize

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

Update the target scalar with the element count in this structure

Type Parameters:

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