org.djunits.value.vdouble.scalar

Class AngleSolid

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>

org.djunits.value.vdouble.scalar.TypedDoubleScalarRel<AngleSolidUnit,AngleSolid>

org.djunits.value.vdouble.scalar.AngleSolid

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel<AngleSolidUnit>>, MathFunctionsAbs<DoubleScalar.Rel<AngleSolidUnit>>, MathFunctionsRel<DoubleScalar.Rel<AngleSolidUnit>>, Relative, Value<AngleSolidUnit>, DoubleMathFunctions<DoubleScalar<AngleSolidUnit>>

public class AngleSolid
extends TypedDoubleScalarRel<AngleSolidUnit,AngleSolid>

Easy access methods for the AngleSolid DoubleScalar, which is relative by definition. Instead of:

 DoubleScalar.Rel<AngleSolidUnit> value = new DoubleScalar.Rel<AngleSolidUnit>(100.0, AngleSolidUnit.SI);
 

we can now write:

 AngleSolid value = new AngleSolid(100.0, AngleSolidUnit.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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

DoubleScalar.Abs<U extends Unit<U>>, DoubleScalar.Rel<U extends Unit<U>>

Field Summary

Fields

Modifier and Type	Field and Description
static AngleSolid	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

si

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
AngleSolid(AngleSolid value) Construct AngleSolid scalar.
AngleSolid(double value, AngleSolidUnit unit) Construct AngleSolid scalar.

Method Summary

Modifier and Type	Method and Description
Dimensionless	divideBy(AngleSolid v) Calculate the division of AngleSolid and AngleSolid, which results in a Dimensionless scalar.
protected AngleSolid	instantiateTypeRel(double value, AngleSolidUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static AngleSolid	interpolate(AngleSolid zero, AngleSolid one, double ratio) Interpolate between two values.
static AngleSolid	max(AngleSolid r1, AngleSolid r2) Return the maximum value of two relative scalars.
static AngleSolid	max(AngleSolid r1, AngleSolid r2, AngleSolid... rn) Return the maximum value of more than two relative scalars.
static AngleSolid	min(AngleSolid r1, AngleSolid r2) Return the minimum value of two relative scalars.
static AngleSolid	min(AngleSolid r1, AngleSolid r2, AngleSolid... rn) Return the minimum value of more than two relative scalars.

Methods inherited from class org.djunits.value.vdouble.scalar.TypedDoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

compareTo, eq, ge, getSI, gt, le, lt, minus, ne, plus

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final AngleSolid ZERO

constant with value zero.

Constructor Detail

AngleSolid

public AngleSolid(double value,
                  AngleSolidUnit unit)

Construct AngleSolid scalar.

Parameters:

value - double value

unit - unit for the double value

AngleSolid

public AngleSolid(AngleSolid value)

Construct AngleSolid scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeRel

protected final AngleSolid instantiateTypeRel(double value,
                                              AngleSolidUnit unit)

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

Specified by:

instantiateTypeRel in class TypedDoubleScalarRel<AngleSolidUnit,AngleSolid>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

public static AngleSolid interpolate(AngleSolid zero,
                                     AngleSolid one,
                                     double 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 AngleSolid max(AngleSolid r1,
                             AngleSolid 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 AngleSolid max(AngleSolid r1,
                             AngleSolid r2,
                             AngleSolid... 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 AngleSolid min(AngleSolid r1,
                             AngleSolid 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 AngleSolid min(AngleSolid r1,
                             AngleSolid r2,
                             AngleSolid... 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

divideBy

public final Dimensionless divideBy(AngleSolid v)

Calculate the division of AngleSolid and AngleSolid, which results in a Dimensionless scalar.

Parameters:

v - AngleSolid scalar

Returns:

Dimensionless scalar as a division of AngleSolid and AngleSolid