org.djunits.value.vfloat.scalar

Class FloatForce

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<ForceUnit,FloatForce>

org.djunits.value.vfloat.scalar.FloatForce

All Implemented Interfaces:

Serializable, Comparable<FloatForce>, MathFunctionsAbs<FloatForce>, MathFunctionsRel<FloatForce>, Relative, Value<ForceUnit>, FloatMathFunctions<FloatForce>, FloatScalarInterface

public class FloatForce
extends AbstractFloatScalarRel<ForceUnit,FloatForce>

Easy access methods for the Force FloatScalar, which is relative by definition. An example is Speed. Instead of:

 FloatScalar.Rel<ForceUnit> value = new FloatScalar.Rel<ForceUnit>(100.0, ForceUnit.SI);
 

we can now write:

 FloatForce value = new FloatForce(100.0, ForceUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

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

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatForce	NaN constant with value NaN.
static FloatForce	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatForce	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatForce	POS_MAXVALUE constant with value MAX_VALUE.
static FloatForce	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatForce	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatForce(double value, ForceUnit unit) Construct FloatForce scalar using a double value.
FloatForce(FloatForce value) Construct FloatForce scalar.
FloatForce(float value, ForceUnit unit) Construct FloatForce scalar.

Method Summary

Modifier and Type	Method and Description
static FloatForce	createSI(float value) Construct FloatForce scalar.
FloatMass	divideBy(FloatAcceleration v) Calculate the division of FloatForce and FloatAcceleration, which results in a FloatMass scalar.
FloatPressure	divideBy(FloatArea v) Calculate the division of FloatForce and FloatArea, which results in a FloatPressure scalar.
FloatLinearDensity	divideBy(FloatEnergy v) Calculate the division of FloatForce and FloatEnergy, which results in a FloatLinearDensity scalar.
FloatDimensionless	divideBy(FloatForce v) Calculate the division of FloatForce and FloatForce, which results in a FloatDimensionless scalar.
FloatEnergy	divideBy(FloatLinearDensity v) Calculate the division of FloatForce and FloatLinearDensity, which results in a FloatEnergy scalar.
FloatAcceleration	divideBy(FloatMass v) Calculate the division of FloatForce and FloatMass, which results in a FloatAcceleration scalar.
FloatArea	divideBy(FloatPressure v) Calculate the division of FloatForce and FloatPressure, which results in a FloatArea scalar.
FloatForce	instantiateRel(float value, ForceUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatForce	interpolate(FloatForce zero, FloatForce one, float ratio) Interpolate between two values.
static FloatForce	max(FloatForce r1, FloatForce r2) Return the maximum value of two relative scalars.
static FloatForce	max(FloatForce r1, FloatForce r2, FloatForce... rn) Return the maximum value of more than two relative scalars.
static FloatForce	min(FloatForce r1, FloatForce r2) Return the minimum value of two relative scalars.
static FloatForce	min(FloatForce r1, FloatForce r2, FloatForce... rn) Return the minimum value of more than two relative scalars.
FloatEnergy	multiplyBy(FloatLength v) Calculate the multiplication of FloatForce and FloatLength, which results in a FloatEnergy scalar.
FloatPower	multiplyBy(FloatSpeed v) Calculate the multiplication of FloatForce and FloatSpeed, which results in a FloatPower scalar.
static FloatForce	valueOf(String text) Returns a FloatForce representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatForce ZERO

constant with value zero.

NaN

public static final FloatForce NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatForce POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatForce NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatForce POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatForce NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatForce

public FloatForce(float value,
                  ForceUnit unit)

Construct FloatForce scalar.

Parameters:

value - float value

unit - unit for the float value

FloatForce

public FloatForce(FloatForce value)

Construct FloatForce scalar.

Parameters:

value - Scalar from which to construct this instance

FloatForce

public FloatForce(double value,
                  ForceUnit unit)

Construct FloatForce scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatForce instantiateRel(float value,
                                       ForceUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<ForceUnit,FloatForce>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

createSI

public static final FloatForce createSI(float value)

Construct FloatForce scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatForce max(FloatForce r1,
                             FloatForce 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 FloatForce max(FloatForce r1,
                             FloatForce r2,
                             FloatForce... 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 FloatForce min(FloatForce r1,
                             FloatForce 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 FloatForce min(FloatForce r1,
                             FloatForce r2,
                             FloatForce... 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 FloatForce valueOf(String text)
                          throws IllegalArgumentException

Returns a FloatForce 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 the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

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

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final FloatDimensionless divideBy(FloatForce v)

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

Parameters:

v - FloatForce scalar

Returns:

FloatDimensionless scalar as a division of FloatForce and FloatForce

multiplyBy

public final FloatEnergy multiplyBy(FloatLength v)

Calculate the multiplication of FloatForce and FloatLength, which results in a FloatEnergy scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatEnergy scalar as a multiplication of FloatForce and FloatLength

divideBy

public final FloatEnergy divideBy(FloatLinearDensity v)

Calculate the division of FloatForce and FloatLinearDensity, which results in a FloatEnergy scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatEnergy scalar as a division of FloatForce and FloatLinearDensity

divideBy

public final FloatLinearDensity divideBy(FloatEnergy v)

Calculate the division of FloatForce and FloatEnergy, which results in a FloatLinearDensity scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatLinearDensity scalar as a division of FloatForce and FloatEnergy

multiplyBy

public final FloatPower multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatForce and FloatSpeed, which results in a FloatPower scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatPower scalar as a multiplication of FloatForce and FloatSpeed

divideBy

public final FloatAcceleration divideBy(FloatMass v)

Calculate the division of FloatForce and FloatMass, which results in a FloatAcceleration scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatAcceleration scalar as a division of FloatForce and FloatMass

divideBy

public final FloatMass divideBy(FloatAcceleration v)

Calculate the division of FloatForce and FloatAcceleration, which results in a FloatMass scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatMass scalar as a division of FloatForce and FloatAcceleration

divideBy

public final FloatPressure divideBy(FloatArea v)

Calculate the division of FloatForce and FloatArea, which results in a FloatPressure scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatPressure scalar as a division of FloatForce and FloatArea

divideBy

public final FloatArea divideBy(FloatPressure v)

Calculate the division of FloatForce and FloatPressure, which results in a FloatArea scalar.

Parameters:

v - FloatForce scalar

Returns:

FloatArea scalar as a division of FloatForce and FloatPressure