tech.units.indriya.function

Class LogConverter

java.lang.Object

tech.units.indriya.AbstractConverter

tech.units.indriya.function.LogConverter

All Implemented Interfaces:

Serializable, Comparable<javax.measure.UnitConverter>, javax.measure.UnitConverter, tech.uom.lib.common.function.Converter<Number,Number>, tech.uom.lib.common.function.ValueSupplier<String>

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

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

Since:

1.0

Version:

1.0.1, December 28, 2017

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tech.units.indriya.AbstractConverter

AbstractConverter.Pair

Field Summary

Fields inherited from class tech.units.indriya.AbstractConverter

conversionSteps, IDENTITY

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
int	compareTo(javax.measure.UnitConverter o)
BigDecimal	convertWhenNotIdentity(BigDecimal value, MathContext ctx) Non-API
double	convertWhenNotIdentity(double amount) Non-API
boolean	equals(Object obj)
double	getBase() Returns the logarithmic base of this converter.
String	getValue()
int	hashCode()
AbstractConverter	inverseWhenNotIdentity() Non-API
boolean	isIdentity()
boolean	isLinear()
protected boolean	isSimpleCompositionWith(AbstractConverter that) Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)
protected AbstractConverter	simpleCompose(AbstractConverter that) Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)
String	transformationLiteral() Non-API

Methods inherited from class tech.units.indriya.AbstractConverter

concatenate, convert, convert, convertWhenNotIdentity, getConversionSteps, inverse, of, toString

Methods inherited from class java.lang.Object

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

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).

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface javax.measure.UnitConverter

isSimpleCompositionWith

protected boolean isSimpleCompositionWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)

Specified by:

isSimpleCompositionWith in class AbstractConverter

Returns:

whether or not a 'simple' composition of transformations is possible

simpleCompose

protected AbstractConverter simpleCompose(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)

Overrides:

simpleCompose in class AbstractConverter

Returns:

a new AbstractConverter that adds no additional conversion step

inverseWhenNotIdentity

public AbstractConverter inverseWhenNotIdentity()

Description copied from class: AbstractConverter

Non-API

Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.

Specified by:

inverseWhenNotIdentity in class AbstractConverter

Returns:

transformationLiteral

public final String transformationLiteral()

Description copied from class: AbstractConverter

Non-API

Returns a String describing the transformation that is represented by this converter. Contributes to converter's toString method. If null or empty toString output becomes simplified.

Specified by:

transformationLiteral in class AbstractConverter

Returns:

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractConverter

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter

convertWhenNotIdentity

public double convertWhenNotIdentity(double amount)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

convertWhenNotIdentity

public BigDecimal convertWhenNotIdentity(BigDecimal value,
                                         MathContext ctx)
                                  throws ArithmeticException

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

Throws:

ArithmeticException

isLinear

public boolean isLinear()

Specified by:

isLinear in interface javax.measure.UnitConverter

getValue

public String getValue()

Specified by:

getValue in interface tech.uom.lib.common.function.ValueSupplier<String>

compareTo

public int compareTo(javax.measure.UnitConverter o)

Specified by:

compareTo in interface Comparable<javax.measure.UnitConverter>