Enum Combiner.Type
- All Implemented Interfaces:
Serializable
,Comparable<Combiner.Type>
,java.lang.constant.Constable
- Enclosing class:
- Combiner
Defines the scaling properties of a combiner.
This also provides information on how the results of the
populated bin list should be interpreted.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptiondouble
getBinFactor
(double binExtent) Returns a scaling factor which ought to be applied to bin values.boolean
Indicates whether the bin values scale to first order with the number of submitted values per bin.static Combiner.Type
Returns the enum constant of this type with the specified name.static Combiner.Type[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
EXTENSIVE
Sum-like aggregation. To first order, the bin result quantities scale linearly with the number of values submitted. If a bin value is NaN because no values have been submitted, it can be interpreted as zero. -
INTENSIVE
Average-like aggregation. To first order, the bin result quantities are not dependent on the number of values submitted. No numeric value can be assumed if a bin value is NaN because no values have been submitted. -
DENSITY
Density-like aggregation. This is likeEXTENSIVE
, but results should be divided by bin size; thegetBinFactor
method in general will return a value that is not unity.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
isExtensive
public boolean isExtensive()Indicates whether the bin values scale to first order with the number of submitted values per bin.- Returns:
- true iff no submitted values corresponds to a zero bin value
-
getBinFactor
public double getBinFactor(double binExtent) Returns a scaling factor which ought to be applied to bin values. This may be unity, or it may depend on the supplied bin extent.- Parameters:
binExtent
- bin size in some natural units- Returns:
- factor to multiply bin contents by before use
-