tech.units.indriya.function

Class MixedRadix<Q extends javax.measure.Quantity<Q>>

java.lang.Object

tech.units.indriya.function.MixedRadix<Q>

public final class MixedRadix<Q extends javax.measure.Quantity<Q>>
extends Object

Immutable class that represents mixed-radix units (like "hour:min:sec" or "ft, in")

Since:

2.0

Version:

2.2, Feb 25, 2021

Author:

Andi Huber, Werner Keil

See Also:

Wikipedia: Mixed radix, Wolfram Language & System: MixedUnit, Wikipedia: Metrication, MixedQuantity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MixedRadix.PrimaryUnitPick

Field Summary

Fields

Modifier and Type	Field and Description
static MixedRadix.PrimaryUnitPick	PRIMARY_UNIT_PICK
static MixedRadix.PrimaryUnitPick	PRIMARY_UNIT_PICK_DEFAULT

Method Summary

Modifier and Type	Method and Description
CompoundQuantity<Q>	createCompoundQuantity(Number... values) Deprecated.
CompoundQuantity<Q>	createCompoundQuantity(Number[] values, javax.measure.Quantity.Scale scale) Deprecated. use #getMixedQuantity
MixedQuantity<Q>	createMixedQuantity(Number... values)
MixedQuantity<Q>	createMixedQuantity(Number[] values, javax.measure.Quantity.Scale scale) Creates a MixedQuantity from given values and scale.
javax.measure.Quantity<Q>	createQuantity(Number... values)
javax.measure.Quantity<Q>	createQuantity(Number[] values, javax.measure.Quantity.Scale scale) Creates a Quantity from given values and scale.
Number[]	extractValues(javax.measure.Quantity<Q> quantity)
Number[]	extractValuesInto(javax.measure.Quantity<Q> quantity, Number[] target)
javax.measure.Unit<Q>	getPrimaryUnit()
List<javax.measure.Unit<Q>>	getUnits()
MixedRadix<Q>	mix(javax.measure.Unit<Q> mixedRadixUnit)
static <X extends javax.measure.Quantity<X>> MixedRadix<X>	of(Collection<javax.measure.Unit<X>> units)
static <X extends javax.measure.Quantity<X>> MixedRadix<X>	of(javax.measure.Unit<X>... units)
static <X extends javax.measure.Quantity<X>> MixedRadix<X>	of(javax.measure.Unit<X> leadingUnit)
static <X extends javax.measure.Quantity<X>> MixedRadix<X>	ofPrimary(javax.measure.Unit<X> primaryUnit)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PRIMARY_UNIT_PICK_DEFAULT

public static final MixedRadix.PrimaryUnitPick PRIMARY_UNIT_PICK_DEFAULT

PRIMARY_UNIT_PICK

public static MixedRadix.PrimaryUnitPick PRIMARY_UNIT_PICK

Method Detail

toString

public String toString()

Overrides:

toString in class Object

of

public static <X extends javax.measure.Quantity<X>> MixedRadix<X> of(javax.measure.Unit<X> leadingUnit)

of

@SafeVarargs
public static <X extends javax.measure.Quantity<X>> MixedRadix<X> of(javax.measure.Unit<X>... units)

of

public static <X extends javax.measure.Quantity<X>> MixedRadix<X> of(Collection<javax.measure.Unit<X>> units)

ofPrimary

public static <X extends javax.measure.Quantity<X>> MixedRadix<X> ofPrimary(javax.measure.Unit<X> primaryUnit)

mix

public MixedRadix<Q> mix(javax.measure.Unit<Q> mixedRadixUnit)

getPrimaryUnit

public javax.measure.Unit<Q> getPrimaryUnit()

getUnits

public List<javax.measure.Unit<Q>> getUnits()

createQuantity

public javax.measure.Quantity<Q> createQuantity(Number[] values,
                                                javax.measure.Quantity.Scale scale)

Creates a Quantity from given values and scale.

Parameters:

values - - numbers corresponding to the radices in most significant first order, allowed to be of shorter length than the total count of radices of this MixedRadix instance

scale - - the Quantity.Scale to be used for the returned Quantity

createQuantity

public javax.measure.Quantity<Q> createQuantity(Number... values)

createMixedQuantity

public MixedQuantity<Q> createMixedQuantity(Number[] values,
                                            javax.measure.Quantity.Scale scale)

Creates a MixedQuantity from given values and scale.

Note: Not every MixedQuantity can be represented by a MixedRadix. MixedRadix strictly requires its coefficients to be in decreasing order of significance, while a MixedQuantity in principle does not.

Parameters:

values - - numbers corresponding to the radix coefficients in most significant first order, allowed to be of shorter length than the total count of radix coefficients of this MixedRadix instance

scale - - the Quantity.Scale to be used for the elements of the returned MixedQuantity

createMixedQuantity

public MixedQuantity<Q> createMixedQuantity(Number... values)

createCompoundQuantity

public CompoundQuantity<Q> createCompoundQuantity(Number[] values,
                                                  javax.measure.Quantity.Scale scale)

Deprecated. use #getMixedQuantity

Creates a CompoundQuantity from given values and scale.

Note: Not every CompoundQuantity can be represented by a MixedRadix. MixedRadix strictly requires its coefficients to be in decreasing order of significance, while a CompoundQuantity in principle does not.

Parameters:

values - - numbers corresponding to the radix coefficients in most significant first order, allowed to be of shorter length than the total count of radix coefficients of this MixedRadix instance

scale - - the Quantity.Scale to be used for the elements of the returned CompoundQuantity

createCompoundQuantity

@Deprecated
public CompoundQuantity<Q> createCompoundQuantity(Number... values)

Deprecated.

extractValues

public Number[] extractValues(javax.measure.Quantity<Q> quantity)

extractValuesInto

public Number[] extractValuesInto(javax.measure.Quantity<Q> quantity,
                                  Number[] target)