org.ojalgo.type.context

Class NumberContext

java.lang.Object

org.ojalgo.type.context.NumberContext

All Implemented Interfaces:

TypeContext<Number>

public final class NumberContext
extends Object

Think of this as a MathContext that specifies both precision and scale. Numeric data types (non-integers) in databases are specified using precison and scale. While doing maths the precision is all that matters, but before sending a number to a database, or printing/displaying it, rounding to a specified scale is desireable.

The enforce methods first enforce the precision and then set the scale. It is possible that this will create a number with trailing zeros and more digits than the precision allows. It is also possible to define a context with a scale that is larger than the precision. This is NOT how precision and scale is used with numeric types in databases.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NumberContext.Enforceable<T>
static interface	NumberContext.FormatPattern

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	NBSP Use 'Non-Breaking SPace' character instead of ardinary 'space' character.

Constructor Summary

Constructors

Constructor and Description
NumberContext()
NumberContext(int precision, int scale)
NumberContext(int precision, int scale, RoundingMode mode)
NumberContext(int scale, RoundingMode mode)
NumberContext(NumberFormat format, int precision, int scale, RoundingMode mode)
NumberContext(RoundingMode mode)

Method Summary

Modifier and Type	Method and Description
static int	compare(double arg1, double arg2) Variation of Double.compare(double, double) that returns 0 if arg1 == arg2.
static int	compare(float arg1, float arg2) Variation of Float.compare(float, float) that returns 0 if arg1 == arg2.
protected void	configureFormat(NumberFormat format, Object object)
BigDecimal	enforce(BigDecimal number) Will first enforce the precision, and then the scale.
double	enforce(double number) Does not enforce the precision and does not use the specified rounding mode.
Number	enforce(Number object) Will force the object to conform to the context's specification.
double	epsilon()
boolean	equals(Object obj)
String	format(double number)
String	format(long number)
String	format(Object object)
static NumberContext	getCurrency(Locale locale)
F	getFormat()
<N extends Number> UnaryFunction<N>	getFunction(FunctionSet<N> functions)
static NumberContext	getGeneral(int scale)
static NumberContext	getGeneral(int precision, int scale)
static NumberContext	getGeneral(int scale, RoundingMode roundingMode)
static NumberContext	getGeneral(MathContext context) The scale will be set to half the precision.
static NumberContext	getInteger(Locale locale)
static NumberContext	getMath(int precisionAndScale)
static NumberContext	getMath(int precisionAndScale, RoundingMode roundingMode)
static NumberContext	getMath(MathContext context) The scale will be undefined/unlimited.
MathContext	getMathContext()
static NumberContext	getPercent(int scale, Locale locale)
static NumberContext	getPercent(Locale locale)
int	getPrecision()
RoundingMode	getRoundingMode()
int	getScale()
protected String	handleFormatException(NumberFormat format, Object object)
protected Number	handleParseException(NumberFormat format, String string)
int	hashCode()
boolean	isDifferent(double expected, double actual)
boolean	isLessThan(BigDecimal reference, BigDecimal value)
boolean	isMoreThan(BigDecimal reference, BigDecimal value)
boolean	isSmall(double comparedTo, double value)
boolean	isZero(double value)
<G> TypeContext<G>	newFormat(F format)
NumberContext	newFormat(NumberStyle style, Locale locale) Deprecated. v48 Use withFormat(NumberStyle,Locale) instead
NumberContext	newMathContext(MathContext context) Deprecated. v48 Use withMathContext(MathContext) instead
NumberContext	newPrecision(int precision) Deprecated. v48 Use withPrecision(int) instead
NumberContext	newRoundingMode(RoundingMode mode) Deprecated. v48 Use withRoundingMode(RoundingMode) instead
NumberContext	newScale(int scale) Deprecated. v48 Use withScale(int) instead
T	parse(CharSequence string)
BigDecimal	toBigDecimal(double number) Will create an "enforced" BigDecimal instance.
static Format	toFormat(NumberStyle style, Locale locale)
String	toLocalizedPattern() Works with DecimalFormat and NumberContext.FormatPattern implementations.
String	toPattern() Works with DecimalFormat and NumberContext.FormatPattern implementations.
String	toString()
NumberContext	withFormat(NumberStyle style, Locale locale)
NumberContext	withMathContext(MathContext context)
NumberContext	withoutPrecision()
NumberContext	withoutScale()
NumberContext	withPrecision(int precision)
NumberContext	withRoundingMode(RoundingMode mode)
NumberContext	withScale(int scale)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NBSP

public static final boolean NBSP

Use 'Non-Breaking SPace' character instead of ardinary 'space' character.

See Also:

Constant Field Values

Constructor Detail

NumberContext

public NumberContext()

NumberContext

public NumberContext(int precision,
                     int scale)

NumberContext

public NumberContext(int precision,
                     int scale,
                     RoundingMode mode)

NumberContext

public NumberContext(int scale,
                     RoundingMode mode)

NumberContext

public NumberContext(NumberFormat format,
                     int precision,
                     int scale,
                     RoundingMode mode)

NumberContext

public NumberContext(RoundingMode mode)

Method Detail

compare

public static int compare(double arg1,
                          double arg2)

Variation of Double.compare(double, double) that returns 0 if arg1 == arg2.

compare

public static int compare(float arg1,
                          float arg2)

Variation of Float.compare(float, float) that returns 0 if arg1 == arg2.

getCurrency

public static NumberContext getCurrency(Locale locale)

getGeneral

public static NumberContext getGeneral(int scale)

getGeneral

public static NumberContext getGeneral(int precision,
                                       int scale)

getGeneral

public static NumberContext getGeneral(int scale,
                                       RoundingMode roundingMode)

getGeneral

public static NumberContext getGeneral(MathContext context)

The scale will be set to half the precision.

getInteger

public static NumberContext getInteger(Locale locale)

getMath

public static NumberContext getMath(int precisionAndScale)

getMath

public static NumberContext getMath(int precisionAndScale,
                                    RoundingMode roundingMode)

getMath

public static NumberContext getMath(MathContext context)

The scale will be undefined/unlimited.

getPercent

public static NumberContext getPercent(int scale,
                                       Locale locale)

getPercent

public static NumberContext getPercent(Locale locale)

toFormat

public static Format toFormat(NumberStyle style,
                              Locale locale)

enforce

public BigDecimal enforce(BigDecimal number)

Will first enforce the precision, and then the scale. Both operations will comply with the rounding mode.

enforce

public double enforce(double number)

Does not enforce the precision and does not use the specified rounding mode. The precision is given by the type double and the rounding mode is always "half even" as given by StrictMath.rint(double).

enforce

public Number enforce(Number object)

Description copied from interface: TypeContext

Will force the object to conform to the context's specification.

epsilon

public double epsilon()

Returns:

the epsilon

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

format

public String format(double number)

format

public String format(long number)

getFunction

public <N extends Number> UnaryFunction<N> getFunction(FunctionSet<N> functions)

getMathContext

public MathContext getMathContext()

getPrecision

public int getPrecision()

getRoundingMode

public RoundingMode getRoundingMode()

getScale

public int getScale()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

isDifferent

public boolean isDifferent(double expected,
                           double actual)

isLessThan

public boolean isLessThan(BigDecimal reference,
                          BigDecimal value)

isMoreThan

public boolean isMoreThan(BigDecimal reference,
                          BigDecimal value)

isSmall

public boolean isSmall(double comparedTo,
                       double value)

isZero

public boolean isZero(double value)

newFormat

@Deprecated
public NumberContext newFormat(NumberStyle style,
                                           Locale locale)

Deprecated. v48 Use withFormat(NumberStyle,Locale) instead

newMathContext

@Deprecated
public NumberContext newMathContext(MathContext context)

Deprecated. v48 Use withMathContext(MathContext) instead

newPrecision

@Deprecated
public NumberContext newPrecision(int precision)

Deprecated. v48 Use withPrecision(int) instead

newRoundingMode

@Deprecated
public NumberContext newRoundingMode(RoundingMode mode)

Deprecated. v48 Use withRoundingMode(RoundingMode) instead

newScale

@Deprecated
public NumberContext newScale(int scale)

Deprecated. v48 Use withScale(int) instead

toBigDecimal

public BigDecimal toBigDecimal(double number)

Will create an "enforced" BigDecimal instance.

toLocalizedPattern

public String toLocalizedPattern()

Works with DecimalFormat and NumberContext.FormatPattern implementations. In other cases it returns null.

toPattern

public String toPattern()

Works with DecimalFormat and NumberContext.FormatPattern implementations. In other cases it returns null.

toString

public String toString()

Overrides:

toString in class Object

withFormat

public NumberContext withFormat(NumberStyle style,
                                Locale locale)

withMathContext

public NumberContext withMathContext(MathContext context)

withoutPrecision

public NumberContext withoutPrecision()

withoutScale

public NumberContext withoutScale()

withPrecision

public NumberContext withPrecision(int precision)

withRoundingMode

public NumberContext withRoundingMode(RoundingMode mode)

withScale

public NumberContext withScale(int scale)

configureFormat

protected void configureFormat(NumberFormat format,
                               Object object)

handleFormatException

protected String handleFormatException(NumberFormat format,
                                       Object object)

handleParseException

protected Number handleParseException(NumberFormat format,
                                      String string)

format

public final String format(Object object)

Specified by:

format in interface TypeContext<T>

See Also:

TypeContext.format(java.lang.Object)

getFormat

public final F getFormat()

newFormat

public final <G> TypeContext<G> newFormat(F format)

parse

public final T parse(CharSequence string)

Specified by:

parse in interface TypeContext<T>

See Also:

TypeContext.parse(CharSequence)