Package org.djunits.value.vfloat.scalar

Class FloatRadioActivity

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vfloat.scalar.base.FloatScalar<U,R>

org.djunits.value.vfloat.scalar.base.FloatScalarRel<RadioActivityUnit,FloatRadioActivity>

org.djunits.value.vfloat.scalar.FloatRadioActivity

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatRadioActivity>, Relative<RadioActivityUnit,FloatRadioActivity>, Value<RadioActivityUnit,FloatRadioActivity>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatRadioActivity
extends FloatScalarRel<RadioActivityUnit,FloatRadioActivity>

Easy access methods for the FloatRadioActivity FloatScalar, which is relative by definition.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatRadioActivity	NaN	Constant with value NaN.
static final FloatRadioActivity	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatRadioActivity	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatRadioActivity	ONE	Constant with value one.
static final FloatRadioActivity	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatRadioActivity	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatRadioActivity	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatRadioActivity(double value, RadioActivityUnit unit)	Construct FloatRadioActivity scalar using a double value.
FloatRadioActivity(float value, RadioActivityUnit unit)	Construct FloatRadioActivity scalar.
FloatRadioActivity(FloatRadioActivity value)	Construct FloatRadioActivity scalar.

Method Summary

Modifier and Type	Method	Description
final FloatDimensionless	divide(FloatRadioActivity v)	Calculate the division of FloatRadioActivity and FloatRadioActivity, which results in a FloatDimensionless scalar.
final FloatRadioActivity	instantiateRel(float value, RadioActivityUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatRadioActivity	instantiateSI(float value)	Construct FloatRadioActivity scalar.
static FloatRadioActivity	interpolate(FloatRadioActivity zero, FloatRadioActivity one, float ratio)	Interpolate between two values.
static FloatRadioActivity	max(FloatRadioActivity r1, FloatRadioActivity r2)	Return the maximum value of two relative scalars.
static FloatRadioActivity	max(FloatRadioActivity r1, FloatRadioActivity r2, FloatRadioActivity... rn)	Return the maximum value of more than two relative scalars.
static FloatRadioActivity	min(FloatRadioActivity r1, FloatRadioActivity r2)	Return the minimum value of two relative scalars.
static FloatRadioActivity	min(FloatRadioActivity r1, FloatRadioActivity r2, FloatRadioActivity... rn)	Return the minimum value of more than two relative scalars.
static FloatRadioActivity	of(float value, String unitString)	Returns a FloatRadioActivity based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static FloatRadioActivity	valueOf(String text)	Returns a FloatRadioActivity representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final FloatRadioActivity ZERO

Constant with value zero.

ONE

public static final FloatRadioActivity ONE

Constant with value one.

NaN

public static final FloatRadioActivity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatRadioActivity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatRadioActivity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatRadioActivity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatRadioActivity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatRadioActivity

public FloatRadioActivity(float value,
 RadioActivityUnit unit)

Construct FloatRadioActivity scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatRadioActivity

public FloatRadioActivity(FloatRadioActivity value)

Construct FloatRadioActivity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatRadioActivity

public FloatRadioActivity(double value,
 RadioActivityUnit unit)

Construct FloatRadioActivity scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatRadioActivity instantiateRel(float value,
 RadioActivityUnit unit)

Description copied from class: FloatScalarRel

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class FloatScalarRel<RadioActivityUnit,FloatRadioActivity>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

R a new relative instance of the FloatScalar of the right type

instantiateSI

public static final FloatRadioActivity instantiateSI(float value)

Construct FloatRadioActivity scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatRadioActivity interpolate(FloatRadioActivity zero,
 FloatRadioActivity one,
 float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatRadioActivity max(FloatRadioActivity r1,
 FloatRadioActivity r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FloatRadioActivity max(FloatRadioActivity r1,
 FloatRadioActivity r2,
 FloatRadioActivity... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FloatRadioActivity min(FloatRadioActivity r1,
 FloatRadioActivity r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FloatRadioActivity min(FloatRadioActivity r1,
 FloatRadioActivity r2,
 FloatRadioActivity... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static FloatRadioActivity valueOf(String text)

Returns a FloatRadioActivity 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.

Parameters:

text - String; the textual representation to parse into a FloatRadioActivity

Returns:

FloatRadioActivity; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatRadioActivity of(float value,
 String unitString)

Returns a FloatRadioActivity based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatRadioActivity; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final FloatDimensionless divide(FloatRadioActivity v)

Calculate the division of FloatRadioActivity and FloatRadioActivity, which results in a FloatDimensionless scalar.

Parameters:

v - FloatRadioActivity; scalar

Returns:

FloatDimensionless; scalar as a division of FloatRadioActivity and FloatRadioActivity

reciprocal

public FloatSIScalar reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<RadioActivityUnit,FloatRadioActivity>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions