Package cdm.base.math.functions

Class RoundToSignificantFigures

java.lang.Object

cdm.base.math.functions.RoundToSignificantFigures

All Implemented Interfaces:

com.rosetta.model.lib.functions.RosettaFunction

Direct Known Subclasses:

RoundToSignificantFigures.RoundToSignificantFiguresDefault, RoundToSignificantFiguresImpl

public abstract class RoundToSignificantFigures
extends Object
implements com.rosetta.model.lib.functions.RosettaFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoundToSignificantFigures.RoundToSignificantFiguresDefault

Field Summary

Fields

Modifier and Type	Field	Description
protected com.rosetta.model.lib.functions.ConditionValidator	conditionValidator

Constructor Summary

Constructors

Constructor	Description
RoundToSignificantFigures()

Method Summary

Modifier and Type	Method	Description
protected abstract BigDecimal	doEvaluate(BigDecimal value, Integer significantFigures, RoundingDirectionEnum roundingMode)
BigDecimal	evaluate(BigDecimal value, Integer significantFigures, RoundingDirectionEnum roundingMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.rosetta.model.lib.functions.RosettaFunction

toBuilder, toBuilder, toBuilder

Field Details

conditionValidator

@Inject
protected com.rosetta.model.lib.functions.ConditionValidator conditionValidator

Constructor Details

RoundToSignificantFigures

public RoundToSignificantFigures()

Method Details

evaluate

public BigDecimal evaluate(BigDecimal value,
 Integer significantFigures,
 RoundingDirectionEnum roundingMode)

Parameters:

value - The original (unrounded) number.

significantFigures - The number of significant figures.

roundingMode - The method of rounding (up/down/nearest).

Returns:

roundedValue The value to the desired number of significant figures.

doEvaluate

protected abstract BigDecimal doEvaluate(BigDecimal value,
 Integer significantFigures,
 RoundingDirectionEnum roundingMode)