Package tech.units.indriya.function
Class PowersOfPiConverter
- java.lang.Object
-
- tech.units.indriya.AbstractConverter
-
- tech.units.indriya.function.PowersOfPiConverter
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<javax.measure.UnitConverter>
,javax.measure.UnitConverter
public final class PowersOfPiConverter extends AbstractConverter
This class represents a converter multiplying numeric values by a factor of Pi to the power of an integer exponent (π^exponent).- Since:
- 2.0
- Version:
- 1.0, April 24, 2018
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class tech.units.indriya.AbstractConverter
AbstractConverter.Pair
-
-
Field Summary
Fields Modifier and Type Field Description private double
doubleFactor
private int
exponent
private int
hashCode
private static long
serialVersionUID
-
Fields inherited from class tech.units.indriya.AbstractConverter
conversionSteps, IDENTITY
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PowersOfPiConverter(int exponent)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(javax.measure.UnitConverter o)
double
convertWhenNotIdentity(double value)
Non-APIjava.math.BigDecimal
convertWhenNotIdentity(java.math.BigDecimal value, java.math.MathContext ctx)
Non-APIboolean
equals(java.lang.Object obj)
int
getExponent()
int
hashCode()
AbstractConverter
inverseWhenNotIdentity()
Non-APIboolean
isIdentity()
boolean
isLinear()
protected boolean
isSimpleCompositionWith(AbstractConverter that)
Non-API Guard forAbstractConverter.simpleCompose(AbstractConverter)
static PowersOfPiConverter
of(int exponent)
Creates a converter with the specified exponent.protected AbstractConverter
simpleCompose(AbstractConverter that)
Non-API Guarded byAbstractConverter.isSimpleCompositionWith(AbstractConverter)
java.lang.String
transformationLiteral()
Non-API-
Methods inherited from class tech.units.indriya.AbstractConverter
concatenate, convert, convert, convertWhenNotIdentity, getConversionSteps, inverse, of, toString
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
exponent
private final int exponent
-
hashCode
private final int hashCode
-
doubleFactor
private final double doubleFactor
-
-
Method Detail
-
of
public static PowersOfPiConverter of(int exponent)
Creates a converter with the specified exponent.- Parameters:
exponent
- the exponent for the factor π^exponent.
-
getExponent
public int getExponent()
-
isIdentity
public boolean isIdentity()
-
isLinear
public boolean isLinear()
-
inverseWhenNotIdentity
public AbstractConverter 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:
-
convertWhenNotIdentity
public java.math.BigDecimal convertWhenNotIdentity(java.math.BigDecimal value, java.math.MathContext ctx) throws java.lang.ArithmeticException
Description copied from class:AbstractConverter
Non-API- Specified by:
convertWhenNotIdentity
in classAbstractConverter
- Returns:
- transformed value
- Throws:
java.lang.ArithmeticException
-
convertWhenNotIdentity
public double convertWhenNotIdentity(double value)
Description copied from class:AbstractConverter
Non-API- Specified by:
convertWhenNotIdentity
in classAbstractConverter
- Returns:
- transformed value
-
isSimpleCompositionWith
protected boolean isSimpleCompositionWith(AbstractConverter that)
Description copied from class:AbstractConverter
Non-API Guard forAbstractConverter.simpleCompose(AbstractConverter)
- Specified by:
isSimpleCompositionWith
in classAbstractConverter
- 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 byAbstractConverter.isSimpleCompositionWith(AbstractConverter)
- Overrides:
simpleCompose
in classAbstractConverter
- Returns:
- a new AbstractConverter that adds no additional conversion step
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in classAbstractConverter
-
transformationLiteral
public final java.lang.String 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:
-
compareTo
public int compareTo(javax.measure.UnitConverter o)
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classAbstractConverter
-
-