FloatAmountOfSubstance.java
package org.djunits.value.vfloat.scalar;
import java.util.Locale;
import org.djunits.unit.AmountOfSubstanceUnit;
import org.djunits.unit.CatalyticActivityUnit;
import org.djunits.unit.DimensionlessUnit;
import org.djunits.unit.DurationUnit;
import org.djunits.value.vfloat.scalar.base.FloatScalar;
import org.djunits.value.vfloat.scalar.base.FloatScalarRel;
import org.djutils.base.NumberParser;
import org.djutils.exceptions.Throw;
import jakarta.annotation.Generated;
/**
* Easy access methods for the FloatAmountOfSubstance FloatScalar, which is relative by definition.
* <p>
* Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
* </p>
* @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
*/
@Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
public class FloatAmountOfSubstance extends FloatScalarRel<AmountOfSubstanceUnit, FloatAmountOfSubstance>
{
/** */
private static final long serialVersionUID = 20150901L;
/** Constant with value zero. */
public static final FloatAmountOfSubstance ZERO = new FloatAmountOfSubstance(0.0f, AmountOfSubstanceUnit.SI);
/** Constant with value one. */
public static final FloatAmountOfSubstance ONE = new FloatAmountOfSubstance(1.0f, AmountOfSubstanceUnit.SI);
/** Constant with value NaN. */
@SuppressWarnings("checkstyle:constantname")
public static final FloatAmountOfSubstance NaN = new FloatAmountOfSubstance(Float.NaN, AmountOfSubstanceUnit.SI);
/** Constant with value POSITIVE_INFINITY. */
public static final FloatAmountOfSubstance POSITIVE_INFINITY =
new FloatAmountOfSubstance(Float.POSITIVE_INFINITY, AmountOfSubstanceUnit.SI);
/** Constant with value NEGATIVE_INFINITY. */
public static final FloatAmountOfSubstance NEGATIVE_INFINITY =
new FloatAmountOfSubstance(Float.NEGATIVE_INFINITY, AmountOfSubstanceUnit.SI);
/** Constant with value MAX_VALUE. */
public static final FloatAmountOfSubstance POS_MAXVALUE =
new FloatAmountOfSubstance(Float.MAX_VALUE, AmountOfSubstanceUnit.SI);
/** Constant with value -MAX_VALUE. */
public static final FloatAmountOfSubstance NEG_MAXVALUE =
new FloatAmountOfSubstance(-Float.MAX_VALUE, AmountOfSubstanceUnit.SI);
/**
* Construct FloatAmountOfSubstance scalar.
* @param value float; the float value
* @param unit unit for the float value
*/
public FloatAmountOfSubstance(final float value, final AmountOfSubstanceUnit unit)
{
super(value, unit);
}
/**
* Construct FloatAmountOfSubstance scalar.
* @param value Scalar from which to construct this instance
*/
public FloatAmountOfSubstance(final FloatAmountOfSubstance value)
{
super(value);
}
/**
* Construct FloatAmountOfSubstance scalar using a double value.
* @param value double; the double value
* @param unit unit for the resulting float value
*/
public FloatAmountOfSubstance(final double value, final AmountOfSubstanceUnit unit)
{
super((float) value, unit);
}
@Override
public final FloatAmountOfSubstance instantiateRel(final float value, final AmountOfSubstanceUnit unit)
{
return new FloatAmountOfSubstance(value, unit);
}
/**
* Construct FloatAmountOfSubstance scalar.
* @param value float; the float value in SI units
* @return the new scalar with the SI value
*/
public static final FloatAmountOfSubstance instantiateSI(final float value)
{
return new FloatAmountOfSubstance(value, AmountOfSubstanceUnit.SI);
}
/**
* Interpolate between two values.
* @param zero the low value
* @param one the high value
* @param ratio double; the ratio between 0 and 1, inclusive
* @return a Scalar at the ratio between
*/
public static FloatAmountOfSubstance interpolate(final FloatAmountOfSubstance zero, final FloatAmountOfSubstance one,
final float ratio)
{
return new FloatAmountOfSubstance(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
zero.getDisplayUnit());
}
/**
* Return the maximum value of two relative scalars.
* @param r1 the first scalar
* @param r2 the second scalar
* @return the maximum value of two relative scalars
*/
public static FloatAmountOfSubstance max(final FloatAmountOfSubstance r1, final FloatAmountOfSubstance r2)
{
return r1.gt(r2) ? r1 : r2;
}
/**
* Return the maximum value of more than two relative scalars.
* @param r1 the first scalar
* @param r2 the second scalar
* @param rn the other scalars
* @return the maximum value of more than two relative scalars
*/
public static FloatAmountOfSubstance max(final FloatAmountOfSubstance r1, final FloatAmountOfSubstance r2,
final FloatAmountOfSubstance... rn)
{
FloatAmountOfSubstance maxr = r1.gt(r2) ? r1 : r2;
for (FloatAmountOfSubstance r : rn)
{
if (r.gt(maxr))
{
maxr = r;
}
}
return maxr;
}
/**
* Return the minimum value of two relative scalars.
* @param r1 the first scalar
* @param r2 the second scalar
* @return the minimum value of two relative scalars
*/
public static FloatAmountOfSubstance min(final FloatAmountOfSubstance r1, final FloatAmountOfSubstance r2)
{
return r1.lt(r2) ? r1 : r2;
}
/**
* Return the minimum value of more than two relative scalars.
* @param r1 the first scalar
* @param r2 the second scalar
* @param rn the other scalars
* @return the minimum value of more than two relative scalars
*/
public static FloatAmountOfSubstance min(final FloatAmountOfSubstance r1, final FloatAmountOfSubstance r2,
final FloatAmountOfSubstance... rn)
{
FloatAmountOfSubstance minr = r1.lt(r2) ? r1 : r2;
for (FloatAmountOfSubstance r : rn)
{
if (r.lt(minr))
{
minr = r;
}
}
return minr;
}
/**
* Returns a FloatAmountOfSubstance representation of a textual representation of a value with a unit. The String
* representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
* unit. Spaces are allowed, but not required, between the value and the unit.
* @param text String; the textual representation to parse into a FloatAmountOfSubstance
* @return FloatAmountOfSubstance; the Scalar representation of the value in its unit
* @throws IllegalArgumentException when the text cannot be parsed
* @throws NullPointerException when the text argument is null
*/
public static FloatAmountOfSubstance valueOf(final String text)
{
Throw.whenNull(text, "Error parsing FloatAmountOfSubstance: text to parse is null");
Throw.when(text.length() == 0, IllegalArgumentException.class,
"Error parsing FloatAmountOfSubstance: empty text to parse");
try
{
NumberParser numberParser = new NumberParser().lenient().trailing();
float f = numberParser.parseFloat(text);
String unitString = text.substring(numberParser.getTrailingPosition()).trim();
AmountOfSubstanceUnit unit = AmountOfSubstanceUnit.BASE.getUnitByAbbreviation(unitString);
if (unit == null)
throw new IllegalArgumentException("Unit " + unitString + " not found");
return new FloatAmountOfSubstance(f, unit);
}
catch (Exception exception)
{
throw new IllegalArgumentException("Error parsing FloatAmountOfSubstance from " + text + " using Locale "
+ Locale.getDefault(Locale.Category.FORMAT), exception);
}
}
/**
* Returns a FloatAmountOfSubstance based on a value and the textual representation of the unit, which can be localized.
* @param value double; the value to use
* @param unitString String; the textual representation of the unit
* @return FloatAmountOfSubstance; the Scalar representation of the value in its unit
* @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
* @throws NullPointerException when the unitString argument is null
*/
public static FloatAmountOfSubstance of(final float value, final String unitString)
{
Throw.whenNull(unitString, "Error parsing FloatAmountOfSubstance: unitString is null");
Throw.when(unitString.length() == 0, IllegalArgumentException.class,
"Error parsing FloatAmountOfSubstance: empty unitString");
AmountOfSubstanceUnit unit = AmountOfSubstanceUnit.BASE.getUnitByAbbreviation(unitString);
if (unit != null)
{
return new FloatAmountOfSubstance(value, unit);
}
throw new IllegalArgumentException("Error parsing FloatAmountOfSubstance with unit " + unitString);
}
/**
* Calculate the division of FloatAmountOfSubstance and FloatAmountOfSubstance, which results in a FloatDimensionless
* scalar.
* @param v FloatAmountOfSubstance; scalar
* @return FloatDimensionless; scalar as a division of FloatAmountOfSubstance and FloatAmountOfSubstance
*/
public final FloatDimensionless divide(final FloatAmountOfSubstance v)
{
return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
}
/**
* Calculate the division of FloatAmountOfSubstance and FloatCatalyticActivity, which results in a FloatDuration scalar.
* @param v FloatAmountOfSubstance; scalar
* @return FloatDuration; scalar as a division of FloatAmountOfSubstance and FloatCatalyticActivity
*/
public final FloatDuration divide(final FloatCatalyticActivity v)
{
return new FloatDuration(this.si / v.si, DurationUnit.SI);
}
/**
* Calculate the division of FloatAmountOfSubstance and FloatDuration, which results in a FloatCatalyticActivity scalar.
* @param v FloatAmountOfSubstance; scalar
* @return FloatCatalyticActivity; scalar as a division of FloatAmountOfSubstance and FloatDuration
*/
public final FloatCatalyticActivity divide(final FloatDuration v)
{
return new FloatCatalyticActivity(this.si / v.si, CatalyticActivityUnit.SI);
}
@Override
public FloatSIScalar reciprocal()
{
return FloatScalar.divide(FloatDimensionless.ONE, this);
}
}