tec.uom.se.function

Class LogConverter

java.lang.Object

tec.uom.se.AbstractConverter

tec.uom.se.function.LogConverter

All Implemented Interfaces:

java.io.Serializable, javax.measure.UnitConverter, tec.uom.lib.common.function.ValueSupplier<java.lang.String>, Converter<java.lang.Number,java.lang.Number>

public final class LogConverter
extends AbstractConverter
implements tec.uom.lib.common.function.ValueSupplier<java.lang.String>

This class represents a logarithmic converter of limited precision. Such converter is typically used to create logarithmic unit. For example:[code] Unit BEL = Unit.ONE.transform(new LogConverter(10).inverse()); [/code]

Version:

1.0, October 10, 2016

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tec.uom.se.AbstractConverter

AbstractConverter.Pair

Field Summary

Fields

Modifier and Type	Field and Description
private double	base Holds the logarithmic base.
private double	logOfBase Holds the natural logarithm of the base.
private static long	serialVersionUID

Fields inherited from class tec.uom.se.AbstractConverter

IDENTITY, PI

Constructor Summary

Constructors

Constructor and Description
LogConverter(double base) Returns a logarithmic converter having the specified base.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	convert(java.math.BigDecimal value, java.math.MathContext ctx)
double	convert(double amount)
boolean	equals(java.lang.Object obj)
double	getBase() Returns the logarithmic base of this converter.
java.lang.String	getValue()
int	hashCode()
AbstractConverter	inverse()
boolean	isLinear()
java.lang.String	toString()

Methods inherited from class tec.uom.se.AbstractConverter

concatenate, concatenate, convert, getConversionSteps, isIdentity

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

base

private final double base

Holds the logarithmic base.

logOfBase

private final double logOfBase

Holds the natural logarithm of the base.

Constructor Detail

LogConverter

public LogConverter(double base)

Returns a logarithmic converter having the specified base.

Parameters:

base - the logarithmic base (e.g. Math.E for the Natural Logarithm).

Method Detail

getBase

public double getBase()

Returns the logarithmic base of this converter.

Returns:

the logarithmic base (e.g. Math.E for the Natural Logarithm).

inverse

public AbstractConverter inverse()

Specified by:

inverse in interface javax.measure.UnitConverter

Specified by:

inverse in class AbstractConverter

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in class AbstractConverter

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter

convert

public double convert(double amount)

Specified by:

convert in interface javax.measure.UnitConverter

Specified by:

convert in class AbstractConverter

convert

public java.math.BigDecimal convert(java.math.BigDecimal value,
                                    java.math.MathContext ctx)
                             throws java.lang.ArithmeticException

Specified by:

convert in class AbstractConverter

Throws:

java.lang.ArithmeticException

isLinear

public boolean isLinear()

Specified by:

isLinear in interface javax.measure.UnitConverter

getValue

public java.lang.String getValue()

Specified by:

getValue in interface tec.uom.lib.common.function.ValueSupplier<java.lang.String>