Package org.djunits.value.vdouble.scalar.base

Class AbstractDoubleScalarRel<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

java.lang.Object

java.lang.Number

org.djunits.value.AbstractScalar<U,S>

org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<U,R>

Type Parameters:

U - the unit

R - the Relative class for reference purposes

All Implemented Interfaces:

Serializable, Cloneable, Comparable<R>, Scalar<U,R>, Scalar.Rel<U,R>, ValueFunctions<U,R>, Relative<U,R>, Value<U,R>, DoubleScalarInterface<U,R>, DoubleScalarInterface.Rel<U,R>

Direct Known Subclasses:

AbsorbedDose, AbstractDoubleScalarRelWithAbs, Acceleration, AmountOfSubstance, AngularAcceleration, AngularVelocity, Area, CatalyticActivity, Density, Dimensionless, ElectricalCapacitance, ElectricalCharge, ElectricalConductance, ElectricalCurrent, ElectricalInductance, ElectricalPotential, ElectricalResistance, Energy, EquivalentDose, FlowMass, FlowVolume, Force, Frequency, Illuminance, LinearDensity, LuminousFlux, LuminousIntensity, MagneticFlux, MagneticFluxDensity, Mass, Momentum, Power, Pressure, RadioActivity, SIScalar, SolidAngle, Speed, Torque, Volume

public abstract class AbstractDoubleScalarRel<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>
extends AbstractDoubleScalar<U,R>
implements DoubleScalarInterface.Rel<U,R>

The typed, abstract DoubleScalarRel class that forms the basis of all DoubleScalar definitions and extensions.
Note: A relative scalar class can implement the toAbs() method if it has an absolute equivalent.

Copyright (c) 2013-2023 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface

DoubleScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>, DoubleScalarInterface.Rel<U extends Unit<U>,R extends DoubleScalarInterface.Rel<U,R>>, DoubleScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>

Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar

Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
AbstractDoubleScalarRel(double value, U unit)	Construct a new Relative Immutable DoubleScalar.
AbstractDoubleScalarRel(R value)	Construct a new Relative Immutable DoubleScalar from an existing Relative Immutable DoubleScalar.

Method Summary

Modifier and Type	Method	Description
R	abs()	Return a new Scalar/Vector/Matrix with absolute value(s).
R	ceil()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).
R	divide(double constant)	Returns a new scalar/vector/matrix with value(s) divided by a factor.
R	divide(float constant)	Returns a new scalar/vector/matrix with value(s) divided by a factor.
SIScalar	divide(AbstractDoubleScalarRel<?,?> otherScalar)	Divide this scalar by another scalar and create a new scalar.
R	floor()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).
R	minus(R decrement)	Subtract a Relative value from this Relative value.
R	neg()	Return a new Scalar/Vector/Matrix with negated value(s).
R	plus(R increment)	Add a Relative value to this Relative value.
abstract AbstractDoubleScalarRel<?,?>	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
R	rint()	Return a new Scalar/Vector/Matrix with the nearest integer value(s).
R	times(double constant)	Returns a new scalar/vector/matrix with value(s) multiplied by a factor.
R	times(float constant)	Returns a new scalar/vector/matrix with value(s) multiplied by a factor.
SIScalar	times(AbstractDoubleScalarRel<?,?> otherScalar)	Multiply this scalar by another scalar and create a new scalar.

Methods inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar

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

Methods inherited from class org.djunits.value.AbstractScalar

getDisplayUnit, isAbsolute, isRelative, 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 java.lang.Comparable

compareTo

Methods inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface

getInUnit, getInUnit, getSI

Methods inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface.Rel

instantiateRel

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

eq, eq0, format, format, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Constructor Detail

AbstractDoubleScalarRel

public AbstractDoubleScalarRel(double value,
                               U unit)

Construct a new Relative Immutable DoubleScalar.

Parameters:

value - double; the value of the new Relative Immutable DoubleScalar

unit - U; the unit of the new Relative Immutable DoubleScalar

AbstractDoubleScalarRel

public AbstractDoubleScalarRel(R value)

Construct a new Relative Immutable DoubleScalar from an existing Relative Immutable DoubleScalar.

Parameters:

value - R, a relative typed DoubleScalar; the reference

Method Detail

plus

public final R plus(R increment)

Add a Relative value to this Relative value. A new value is returned due to immutability.

Specified by:

plus in interface Scalar.Rel<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

increment - R; the value to add

Returns:

R; the sum of this value and the operand as a new object

minus

public final R minus(R decrement)

Subtract a Relative value from this Relative value. A new value is returned due to immutability.

Specified by:

minus in interface Scalar.Rel<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

decrement - R; the value to subtract

Returns:

R; the difference of this value and the operand

times

public SIScalar times(AbstractDoubleScalarRel<?,?> otherScalar)

Multiply this scalar by another scalar and create a new scalar.

Parameters:

otherScalar - AbstractDoubleScalarRel<?, ?>; the value by which this scalar is multiplied

Returns:

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

reciprocal

public abstract AbstractDoubleScalarRel<?,?> reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Returns:

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

divide

public SIScalar divide(AbstractDoubleScalarRel<?,?> otherScalar)

Divide this scalar by another scalar and create a new scalar.

Parameters:

otherScalar - AbstractDoubleScalarRel<?, ?>; the value by which this scalar is divided

Returns:

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

abs

public R abs()

Return a new Scalar/Vector/Matrix with absolute value(s).

Specified by:

abs in interface ValueFunctions<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Returns:

R; a new R with absolute value(s)

ceil

public R ceil()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).

Specified by:

ceil in interface ValueFunctions<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Returns:

R; a new R with absolute value(s)

floor

public R floor()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).

Specified by:

floor in interface ValueFunctions<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Returns:

R; a new R with absolute value(s)

rint

public R rint()

Return a new Scalar/Vector/Matrix with the nearest integer value(s). When the value is exactly in the middle between two integer values, the even one is returned.

Specified by:

rint in interface ValueFunctions<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Returns:

R; a new R with absolute value(s)

neg

public R neg()

Return a new Scalar/Vector/Matrix with negated value(s).

Specified by:

neg in interface ValueFunctions<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Returns:

R; a new R with negated value(s)

times

public R times(double constant)

Returns a new scalar/vector/matrix with value(s) multiplied by a factor.

Specified by:

times in interface Relative<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

constant - double; the multiplier

Returns:

T; a new scalar/vector/matrix

divide

public R divide(double constant)

Returns a new scalar/vector/matrix with value(s) divided by a factor.

Specified by:

divide in interface Relative<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

constant - double; the divisor

Returns:

T; the modified T

times

public R times(float constant)

Returns a new scalar/vector/matrix with value(s) multiplied by a factor.

Specified by:

times in interface Relative<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

constant - float; the multiplier

Returns:

T; a new scalar/vector/matrix

divide

public R divide(float constant)

Returns a new scalar/vector/matrix with value(s) divided by a factor.

Specified by:

divide in interface Relative<U extends Unit<U>,R extends AbstractDoubleScalarRel<U,R>>

Parameters:

constant - float; the divisor

Returns:

T; the modified T