Package 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.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
- Since:
- 1.0
- Version:
- 1.0.1, December 28, 2017
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class tech.units.indriya.AbstractConverter
AbstractConverter.Pair
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final double
Holds the logarithmic base.private final double
Holds the natural logarithm of the base.private static final long
Fields inherited from class tech.units.indriya.AbstractConverter
conversionSteps, IDENTITY
-
Constructor Summary
ConstructorsConstructorDescriptionLogConverter
(double base) Returns a logarithmic converter having the specified base. -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(javax.measure.UnitConverter o) double
convertWhenNotIdentity
(double amount) Non-APIconvertWhenNotIdentity
(BigDecimal value, MathContext ctx) Non-APIboolean
double
getBase()
Returns the logarithmic base of this converter.getValue()
int
hashCode()
Non-APIboolean
boolean
isLinear()
protected boolean
Non-API Guard forAbstractConverter.simpleCompose(AbstractConverter)
protected AbstractConverter
Non-API Guarded byAbstractConverter.isSimpleCompositionWith(AbstractConverter)
final String
Non-APIMethods inherited from class tech.units.indriya.AbstractConverter
concatenate, convert, convert, convertWhenNotIdentity, getConversionSteps, inverse, of, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
base
private final double baseHolds the logarithmic base. -
logOfBase
private final double logOfBaseHolds the natural logarithm of the base.
-
-
Constructor Details
-
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 Details
-
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 interfacejavax.measure.UnitConverter
-
isSimpleCompositionWith
Description copied from class:AbstractConverter
Non-API Guard forAbstractConverter.simpleCompose(AbstractConverter)
- Specified by:
isSimpleCompositionWith
in classAbstractConverter
- Parameters:
that
-- Returns:
- whether or not a 'simple' composition of transformations is possible
-
simpleCompose
Description copied from class:AbstractConverter
Non-API Guarded byAbstractConverter.isSimpleCompositionWith(AbstractConverter)
- Overrides:
simpleCompose
in classAbstractConverter
- Parameters:
that
-- Returns:
- a new AbstractConverter that adds no additional conversion step
-
inverseWhenNotIdentity
Description copied from class:AbstractConverter
Non-APIReturns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.
- Specified by:
inverseWhenNotIdentity
in classAbstractConverter
- Returns:
-
transformationLiteral
Description copied from class:AbstractConverter
Non-APIReturns a String describing the transformation that is represented by this converter. Contributes to converter's
toString
method. If null or emptytoString
output becomes simplified.- Specified by:
transformationLiteral
in classAbstractConverter
- Returns:
-
equals
- Specified by:
equals
in classAbstractConverter
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractConverter
-
convertWhenNotIdentity
public double convertWhenNotIdentity(double amount) Description copied from class:AbstractConverter
Non-API- Specified by:
convertWhenNotIdentity
in classAbstractConverter
- Parameters:
amount
-- Returns:
- transformed value
-
convertWhenNotIdentity
public BigDecimal convertWhenNotIdentity(BigDecimal value, MathContext ctx) throws ArithmeticException Description copied from class:AbstractConverter
Non-API- Specified by:
convertWhenNotIdentity
in classAbstractConverter
- Parameters:
value
-ctx
-- Returns:
- transformed value
- Throws:
ArithmeticException
-
isLinear
public boolean isLinear()- Specified by:
isLinear
in interfacejavax.measure.UnitConverter
-
getValue
- Specified by:
getValue
in interfacetech.uom.lib.common.function.ValueSupplier<String>
-
compareTo
public int compareTo(javax.measure.UnitConverter o) - Specified by:
compareTo
in interfaceComparable<javax.measure.UnitConverter>
-