Package tech.units.indriya.function

Class PowersOfPiConverter

java.lang.Object

tech.units.indriya.AbstractConverter

tech.units.indriya.function.PowersOfPiConverter

All Implemented Interfaces:

Serializable, 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 final double	doubleFactor
private final int	exponent
private final int	hashCode
private static final long	serialVersionUID

Fields inherited from class tech.units.indriya.AbstractConverter

conversionSteps, IDENTITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PowersOfPiConverter(int exponent)

Method Summary

Modifier and Type	Method	Description
int	compareTo(javax.measure.UnitConverter o)
double	convertWhenNotIdentity(double value)	Non-API
BigDecimal	convertWhenNotIdentity(BigDecimal value, MathContext ctx)	Non-API
boolean	equals(Object obj)
int	getExponent()
int	hashCode()
AbstractConverter	inverseWhenNotIdentity()	Non-API
boolean	isIdentity()
boolean	isLinear()
protected boolean	isSimpleCompositionWith(AbstractConverter that)	Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)
static PowersOfPiConverter	of(int exponent)	Creates a converter with the specified exponent.
protected AbstractConverter	simpleCompose(AbstractConverter that)	Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)
final 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

Field Details

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

Constructor Details

PowersOfPiConverter

protected PowersOfPiConverter(int exponent)

Method Details

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-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:

convertWhenNotIdentity

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

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Parameters:

value -

ctx -

Returns:

transformed value

Throws:

ArithmeticException

convertWhenNotIdentity

public double convertWhenNotIdentity(double value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Parameters:

value -

Returns:

transformed value

isSimpleCompositionWith

protected boolean isSimpleCompositionWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)

Specified by:

isSimpleCompositionWith in class AbstractConverter

Parameters:

that -

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

Parameters:

that -

Returns:

a new AbstractConverter that adds no additional conversion step

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractConverter

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:

compareTo

public int compareTo(javax.measure.UnitConverter o)

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter