NumericProperties (Java Accumulators and Variants)

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, PrimitiveProperties, Real<REAL>, Scalar<SCALAR>, SealedAccumulator<ACCUMULATOR>, SealedPrimitive<PRIMITIVE>, SealedReal<REAL>, 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 NumericProperties
```
Algebraic predicates indicating properties of a specific number

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isFinite()`
`boolean`	`isImaginary()` Answer `true` if this value represents the magnitude of a vector into the set of imaginary numbers.
`boolean`	`isInfinity()`
`boolean`	`isInvalid()`
`boolean`	`isMaximum()`
`boolean`	`isMinimum()`
`boolean`	`isModulo()` Answer `true` if this value represents the magnitude of a vector into a modulo set, or finite ring.
`boolean`	`isNegative()`
`boolean`	`isNegativeFinite()`
`boolean`	`isNegativeInfinity()`
`boolean`	`isPositive()`
`boolean`	`isPositiveFinite()`
`boolean`	`isPositiveInfinity()`
`boolean`	`isReal()` Answer `true` if this value represents the magnitude of a vector into the set of real numbers.
`boolean`	`isUnity()` Answer `true` if this value represents the multiplicative identity in its arithmetic domain.
`boolean`	`isValid()`
`boolean`	`isZero()` Answer `true` if this value represents the additive identity in its algebraic group.
`int`	`signum()`

- Method Detail
  - isFinite
```
boolean isFinite()
```
    Returns:
    true if this value represents a valid and finite value
  - isImaginary
```
boolean isImaginary()
```
    Answer true if this value represents the magnitude of a vector into the set of imaginary numbers. This is not the same as testing whether this object's implementation resembles the specification for the IMAGINARY domain, since that is too specific to implementation machinery. This more general test also includes imaginary modulo values in its specification.
    
    Returns:
    true if this value represents the magnitude of a vector into the set of imaginary numbers
  - isInfinity
```
boolean isInfinity()
```
    Returns:
    true if this number represents either positive or negative infinity
  - isInvalid
```
boolean isInvalid()
```
    Returns:
    true if this value does not represent a valid number, such as 0/0 (INVALID)
    See Also:
    INVALID at Wikipedia
  - isMaximum
```
boolean isMaximum()
```
    Returns:
    true if this value represents the maximum rational value in the totally ordered set it represents
  - isMinimum
```
boolean isMinimum()
```
    Returns:
    true if this value represents the minimum rational value in the totally ordered set it represents
  - isModulo
```
boolean isModulo()
```
    Answer true if this value represents the magnitude of a vector into a modulo set, or finite ring. This is not the same as testing whether this object's implementation resembles the specification for the MODULO domain, since that is too specific to implementation machinery. Modulo values, for instance can either be real or imaginary.
    
    Returns:
    true if this value represents the magnitude of a vector into a modulo set, or finite ring
  - isNegative
```
boolean isNegative()
```
    Returns:
    true if this value represents a negative value
  - isNegativeFinite
```
boolean isNegativeFinite()
```
    Returns:
    true if this value represents a valid, finite and negative value
  - isNegativeInfinity
```
boolean isNegativeInfinity()
```
    Returns:
    true if this value represents negative infinity
  - isPositive
```
boolean isPositive()
```
    Returns:
    true if this value represents a positive value
  - isPositiveFinite
```
boolean isPositiveFinite()
```
    Returns:
    true if this value represents a valid, finite and negative value
  - isPositiveInfinity
```
boolean isPositiveInfinity()
```
    Returns:
    true if this value represents positive infinity
  - isReal
```
boolean isReal()
```
    Answer true if this value represents the magnitude of a vector into the set of real numbers. This is not the same as testing whether this object's implementation resembles the specification for the REAL domain, since that is too specific to implementation machinery. This more general test also includes real modulo values in its specification.
    
    Returns:
    true if this value represents the magnitude of a vector into the set of real numbers
  - isUnity
```
boolean isUnity()
```
    Answer true if this value represents the multiplicative identity in its arithmetic domain. For real numbers this is 1, for matrices it would be the identity matrix and for functions this would be a pass-through.
    
    Returns:
    true if this value represents the multiplicative identity in its domain
  - isValid
```
boolean isValid()
```
    Returns:
    true if this value represents a valid number (not INVALID)
    See Also:
    INVALID at Wikipedia
  - isZero
```
boolean isZero()
```
    Answer true if this value represents the additive identity in its algebraic group. For real numbers this is 0, for matrices this would be the zero matrix and for functions this would map every parameter to zero.
    
    Returns:
    true if this value represents the additive identity in its algebraic group
  - signum
```
int signum()
```
    Returns:
    zero if this number is zero, -1 if this number is negative or +1 if it is positive

Interface NumericProperties

Method Summary

Method Detail

isFinite

isImaginary

isInfinity

isInvalid

isMaximum

isMinimum

isModulo

isNegative

isNegativeFinite

isNegativeInfinity

isPositive

isPositiveFinite

isPositiveInfinity

isReal

isUnity

isValid

isZero

signum