org.djunits.value.vdouble.scalar

Class Angle

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

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

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<AngleUnit,Angle>

org.djunits.value.vdouble.scalar.Angle

All Implemented Interfaces:

Serializable, Comparable<Angle>, MathFunctionsAbs<Angle>, MathFunctionsRel<Angle>, Relative, Value<AngleUnit>, DoubleMathFunctions<Angle>, DoubleScalarInterface

public class Angle
extends AbstractDoubleScalarRel<AngleUnit,Angle>

Easy access methods for the Relative Angle DoubleScalar. Instead of:

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

we can now write:

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

$LastChangedDate: 2015-12-22 04:32:39 +0100 (Tue, 22 Dec 2015) $, @version $Revision: 180 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

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

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

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, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Angle(Angle value) Construct Angle scalar.
Angle(double value, AngleUnit unit) Construct Angle scalar.

Method Summary

Modifier and Type	Method and Description
static Angle	createSI(double value) Construct Angle scalar.
Dimensionless	divideBy(Angle v) Calculate the division of Angle and Angle, which results in a Dimensionless scalar.
Direction	instantiateAbs(double value, DirectionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
Angle	instantiateRel(double value, AngleUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Angle	interpolate(Angle zero, Angle one, double ratio) Interpolate between two values.
static Angle	max(Angle r1, Angle r2) Return the maximum value of two relative scalars.
static Angle	max(Angle r1, Angle r2, Angle... rn) Return the maximum value of more than two relative scalars.
static Angle	min(Angle r1, Angle r2) Return the minimum value of two relative scalars.
static Angle	min(Angle r1, Angle r2, Angle... rn) Return the minimum value of more than two relative scalars.
Direction	plus(Direction v) Relative scalar plus Absolute scalar = Absolute scalar.

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

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

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

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

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 Angle ZERO

constant with value zero.

NaN

public static final Angle NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Angle POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Angle NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Angle POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Angle NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Angle

public Angle(double value,
             AngleUnit unit)

Construct Angle scalar.

Parameters:

value - double value

unit - unit for the double value

Angle

public Angle(Angle value)

Construct Angle scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Angle instantiateRel(double value,
                                  AngleUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<AngleUnit,Angle>

Parameters:

value - the double value

unit - the unit

Returns:

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

instantiateAbs

public final Direction instantiateAbs(double value,
                                      DirectionUnit unit)

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

Parameters:

value - the double value

unit - the unit

Returns:

A a new absolute instance of the DoubleScalar of the right type

createSI

public static final Angle createSI(double value)

Construct Angle scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Angle interpolate(Angle zero,
                                Angle 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

plus

public final Direction plus(Direction v)

Relative scalar plus Absolute scalar = Absolute scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

max

public static Angle max(Angle r1,
                        Angle 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 Angle max(Angle r1,
                        Angle r2,
                        Angle... 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 Angle min(Angle r1,
                        Angle 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 Angle min(Angle r1,
                        Angle r2,
                        Angle... 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(Angle v)

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

Parameters:

v - Angle scalar

Returns:

Dimensionless scalar as a division of Angle and Angle