Package org.djunits.value.vfloat.scalar

Class FloatAngularVelocity

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<AngularVelocityUnit,FloatAngularVelocity>

org.djunits.value.vfloat.scalar.FloatAngularVelocity

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatAngularVelocity>, Relative<AngularVelocityUnit,FloatAngularVelocity>, Value<AngularVelocityUnit,FloatAngularVelocity>

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

Easy access methods for the FloatAngularVelocity 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 FloatAngularVelocity	NaN	Constant with value NaN.
static final FloatAngularVelocity	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatAngularVelocity	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatAngularVelocity	ONE	Constant with value one.
static final FloatAngularVelocity	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatAngularVelocity	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatAngularVelocity	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatAngularVelocity(double value, AngularVelocityUnit unit)	Construct FloatAngularVelocity scalar using a double value.
FloatAngularVelocity(float value, AngularVelocityUnit unit)	Construct FloatAngularVelocity scalar.
FloatAngularVelocity(FloatAngularVelocity value)	Construct FloatAngularVelocity scalar.

Method Summary

Modifier and Type	Method	Description
final FloatFrequency	divide(FloatAngle v)	Calculate the division of FloatAngularVelocity and FloatAngle, which results in a FloatFrequency scalar.
final FloatDuration	divide(FloatAngularAcceleration v)	Calculate the division of FloatAngularVelocity and FloatAngularAcceleration, which results in a FloatDuration scalar.
final FloatDimensionless	divide(FloatAngularVelocity v)	Calculate the division of FloatAngularVelocity and FloatAngularVelocity, which results in a FloatDimensionless scalar.
final FloatAngularAcceleration	divide(FloatDuration v)	Calculate the division of FloatAngularVelocity and FloatDuration, which results in a FloatAngularAcceleration scalar.
final FloatAngle	divide(FloatFrequency v)	Calculate the division of FloatAngularVelocity and FloatFrequency, which results in a FloatAngle scalar.
final FloatAngularVelocity	instantiateRel(float value, AngularVelocityUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatAngularVelocity	instantiateSI(float value)	Construct FloatAngularVelocity scalar.
static FloatAngularVelocity	interpolate(FloatAngularVelocity zero, FloatAngularVelocity one, float ratio)	Interpolate between two values.
static FloatAngularVelocity	max(FloatAngularVelocity r1, FloatAngularVelocity r2)	Return the maximum value of two relative scalars.
static FloatAngularVelocity	max(FloatAngularVelocity r1, FloatAngularVelocity r2, FloatAngularVelocity... rn)	Return the maximum value of more than two relative scalars.
static FloatAngularVelocity	min(FloatAngularVelocity r1, FloatAngularVelocity r2)	Return the minimum value of two relative scalars.
static FloatAngularVelocity	min(FloatAngularVelocity r1, FloatAngularVelocity r2, FloatAngularVelocity... rn)	Return the minimum value of more than two relative scalars.
static FloatAngularVelocity	of(float value, String unitString)	Returns a FloatAngularVelocity 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.
final FloatAngle	times(FloatDuration v)	Calculate the multiplication of FloatAngularVelocity and FloatDuration, which results in a FloatAngle scalar.
final FloatAngularAcceleration	times(FloatFrequency v)	Calculate the multiplication of FloatAngularVelocity and FloatFrequency, which results in a FloatAngularAcceleration scalar.
static FloatAngularVelocity	valueOf(String text)	Returns a FloatAngularVelocity 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 FloatAngularVelocity ZERO

Constant with value zero.

ONE

public static final FloatAngularVelocity ONE

Constant with value one.

NaN

public static final FloatAngularVelocity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatAngularVelocity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatAngularVelocity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatAngularVelocity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatAngularVelocity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatAngularVelocity

public FloatAngularVelocity(float value,
 AngularVelocityUnit unit)

Construct FloatAngularVelocity scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatAngularVelocity

public FloatAngularVelocity(FloatAngularVelocity value)

Construct FloatAngularVelocity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatAngularVelocity

public FloatAngularVelocity(double value,
 AngularVelocityUnit unit)

Construct FloatAngularVelocity scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatAngularVelocity instantiateRel(float value,
 AngularVelocityUnit 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<AngularVelocityUnit,FloatAngularVelocity>

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 FloatAngularVelocity instantiateSI(float value)

Construct FloatAngularVelocity scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatAngularVelocity interpolate(FloatAngularVelocity zero,
 FloatAngularVelocity 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 FloatAngularVelocity max(FloatAngularVelocity r1,
 FloatAngularVelocity 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 FloatAngularVelocity max(FloatAngularVelocity r1,
 FloatAngularVelocity r2,
 FloatAngularVelocity... 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 FloatAngularVelocity min(FloatAngularVelocity r1,
 FloatAngularVelocity 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 FloatAngularVelocity min(FloatAngularVelocity r1,
 FloatAngularVelocity r2,
 FloatAngularVelocity... 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 FloatAngularVelocity valueOf(String text)

Returns a FloatAngularVelocity 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 FloatAngularVelocity

Returns:

FloatAngularVelocity; 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 FloatAngularVelocity of(float value,
 String unitString)

Returns a FloatAngularVelocity 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:

FloatAngularVelocity; 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(FloatAngularVelocity v)

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

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatDimensionless; scalar as a division of FloatAngularVelocity and FloatAngularVelocity

divide

public final FloatFrequency divide(FloatAngle v)

Calculate the division of FloatAngularVelocity and FloatAngle, which results in a FloatFrequency scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatFrequency; scalar as a division of FloatAngularVelocity and FloatAngle

divide

public final FloatAngle divide(FloatFrequency v)

Calculate the division of FloatAngularVelocity and FloatFrequency, which results in a FloatAngle scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatAngle; scalar as a division of FloatAngularVelocity and FloatFrequency

times

public final FloatAngle times(FloatDuration v)

Calculate the multiplication of FloatAngularVelocity and FloatDuration, which results in a FloatAngle scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatAngle; scalar as a multiplication of FloatAngularVelocity and FloatDuration

divide

public final FloatAngularAcceleration divide(FloatDuration v)

Calculate the division of FloatAngularVelocity and FloatDuration, which results in a FloatAngularAcceleration scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatAngularAcceleration; scalar as a division of FloatAngularVelocity and FloatDuration

divide

public final FloatDuration divide(FloatAngularAcceleration v)

Calculate the division of FloatAngularVelocity and FloatAngularAcceleration, which results in a FloatDuration scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatDuration; scalar as a division of FloatAngularVelocity and FloatAngularAcceleration

times

public final FloatAngularAcceleration times(FloatFrequency v)

Calculate the multiplication of FloatAngularVelocity and FloatFrequency, which results in a FloatAngularAcceleration scalar.

Parameters:

v - FloatAngularVelocity; scalar

Returns:

FloatAngularAcceleration; scalar as a multiplication of FloatAngularVelocity and FloatFrequency

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<AngularVelocityUnit,FloatAngularVelocity>

Returns:

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