tech.units.indriya.function

Class AbstractConverter.Pair

java.lang.Object

tech.units.indriya.function.AbstractConverter

tech.units.indriya.function.AbstractConverter.Pair

All Implemented Interfaces:

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

Enclosing class:

AbstractConverter

public static final class AbstractConverter.Pair
extends AbstractConverter
implements Serializable

This class represents converters made up of two or more separate converters (in matrix notation [pair] = [left] x [right]).

See Also:

Serialized Form

Nested Class Summary

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

AbstractConverter.Pair

Field Summary

Fields inherited from class tech.units.indriya.function.AbstractConverter

conversionSteps, IDENTITY, UNIT_COMPOSITION_HANDLER

Constructor Summary

Constructors

Constructor and Description
Pair(javax.measure.UnitConverter left, javax.measure.UnitConverter right) Creates a pair converter resulting from the combined transformation of the specified converters.

Method Summary

Modifier and Type	Method and Description
protected boolean	canReduceWith(AbstractConverter that) Non-API Guard for AbstractConverter.reduce(AbstractConverter)
int	compareTo(javax.measure.UnitConverter obj)
protected Number	convertWhenNotIdentity(Number value) Non-API
protected List<? extends javax.measure.UnitConverter>	createConversionSteps()
boolean	equals(Object obj)
javax.measure.UnitConverter	getLeft()
javax.measure.UnitConverter	getRight()
int	hashCode()
AbstractConverter.Pair	inverseWhenNotIdentity() Non-API Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.
boolean	isIdentity()
boolean	isLinear()
Optional<Number>	linearFactor() Even though transformations may be composed of addition and multiplication, the first derivative might just be a linear function.
protected String	transformationLiteral() Non-API Returns a String describing the transformation that is represented by this converter.

Methods inherited from class tech.units.indriya.function.AbstractConverter

concatenate, convert, convert, getConversionSteps, inverse, reduce, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(javax.measure.UnitConverter left,
            javax.measure.UnitConverter right)

Creates a pair converter resulting from the combined transformation of the specified converters.

Parameters:

left - the left converter, not null.

right - the right converter.

Throws:

IllegalArgumentException - if either the left or right converter are null

Method Detail

isLinear

public boolean isLinear()

Specified by:

isLinear in interface javax.measure.UnitConverter

linearFactor

public Optional<Number> linearFactor()

Description copied from class: AbstractConverter

Even though transformations may be composed of addition and multiplication, the first derivative might just be a linear function. This is strictly required for Quantities that are expressed with RELATIVE scope. Eg. Δ2°C or Δ2°F. Otherwise such deltas cannot be converted to ABSOLUTE scope without additional information.

Overrides:

linearFactor in class AbstractConverter

Returns:

optionally the linear factor of this transformation's first derivative, based on whether this transformation allows for RELATIVE scaled Quantities

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface javax.measure.UnitConverter

createConversionSteps

protected List<? extends javax.measure.UnitConverter> createConversionSteps()

inverseWhenNotIdentity

public AbstractConverter.Pair 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

protected Number convertWhenNotIdentity(Number value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractConverter

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter

getLeft

public javax.measure.UnitConverter getLeft()

getRight

public javax.measure.UnitConverter getRight()

compareTo

public int compareTo(javax.measure.UnitConverter obj)

Specified by:

compareTo in interface Comparable<javax.measure.UnitConverter>

transformationLiteral

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

canReduceWith

protected boolean canReduceWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.reduce(AbstractConverter)

Specified by:

canReduceWith in class AbstractConverter

Returns:

whether or not a composition with given that is possible, such that no additional conversion steps are required, with respect to the steps already in place by this converter