javax.measure.converter
Class LogConverter

java.lang.Object
  javax.measure.converter.UnitConverter
      javax.measure.converter.LogConverter

All Implemented Interfaces:

java.io.Serializable

public final class LogConverter
extends UnitConverter

This class represents a logarithmic converter of limited precision. Such converter is typically used to create logarithmic unit. For example:

     Unit<Dimensionless> BEL = Unit.ONE.transform(new LogConverter(10).inverse());
     

Instances of this class are immutable.

Version:

1.0, April 15, 2009

Author:

Jean-Marie Dautelle

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.measure.converter.UnitConverter

IDENTITY

Constructor Summary

LogConverter(double base)
Creates a logarithmic converter having the specified base.

Method Summary

java.math.BigDecimal	convert(java.math.BigDecimal value, java.math.MathContext ctx) Converts a BigDecimal value.
double	convert(double amount) Converts a double value.
boolean	equals(java.lang.Object obj) Indicates whether this converter is considered to be the the same as the one specified.
double	getBase() Returns the logarithmic base of this converter.
int	hashCode() Returns a hash code value for this converter.
UnitConverter	inverse() Returns the inverse of this converter.
java.lang.String	toString()

Methods inherited from class javax.measure.converter.UnitConverter

concatenate

Methods inherited from class java.lang.Object

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

Constructor Detail

LogConverter

public LogConverter(double base)

Creates 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 UnitConverter inverse()

Description copied from class: UnitConverter

Returns the inverse of this converter. If x is a valid value, then x == inverse().convert(convert(x)) to within the accuracy of computer arithmetic.

Specified by:

inverse in class UnitConverter

Returns:

the inverse of this converter.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Description copied from class: UnitConverter

Indicates whether this converter is considered to be the the same as the one specified.

Specified by:

equals in class UnitConverter

Parameters:

obj - the converter with which to compare.

Returns:

true if the specified object is a converter considered equals to this converter;false otherwise.

hashCode

public int hashCode()

Description copied from class: UnitConverter

Returns a hash code value for this converter. Equals object have equal hash codes.

Specified by:

hashCode in class UnitConverter

Returns:

this converter hash code value.

See Also:

UnitConverter.equals(java.lang.Object)

convert

public double convert(double amount)

Description copied from class: UnitConverter

Converts a double value.

Specified by:

convert in class UnitConverter

Parameters:

amount - the numeric value to convert.

Returns:

the double value after conversion.

convert

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

Description copied from class: UnitConverter

Converts a BigDecimal value.

Specified by:

convert in class UnitConverter

Parameters:

value - the numeric value to convert.

ctx - the math context being used for conversion.

Returns:

the decimal value after conversion.

Throws:

java.lang.ArithmeticException - if the result is inexact but the rounding mode is MathContext.UNNECESSARY or mathContext.precision == 0 and the quotient has a non-terminating decimal expansion.