1 package org.djunits.value.vdouble.scalar;
2
3 import org.djunits.unit.AbsoluteTemperatureUnit;
4 import org.djunits.unit.TemperatureUnit;
5
6 /**
7 * Easy access methods for the Absolute AbsoluteTemperature DoubleScalar. Instead of:
8 *
9 * <pre>
10 * DoubleScalar.Abs<AbsoluteTemperatureUnit> value =
11 * new DoubleScalar.Abs<AbsoluteTemperatureUnit>(100.0, AbsoluteTemperatureUnit.SI);
12 * </pre>
13 *
14 * we can now write:
15 *
16 * <pre>
17 * AbsoluteTemperature value = new AbsoluteTemperature(100.0, AbsoluteTemperatureUnit.BASE);
18 * </pre>
19 *
20 * The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit
21 * used are compatible.
22 * <p>
23 * Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. <br>
24 * All rights reserved. <br>
25 * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
26 * <p>
27 * $LastChangedDate: 2015-12-22 04:32:39 +0100 (Tue, 22 Dec 2015) $, @version $Revision: 180 $, by $Author: averbraeck $,
28 * initial version Sep 1, 2015 <br>
29 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
30 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
31 */
32 public class AbsoluteTemperature
33 extends AbstractDoubleScalarAbs<AbsoluteTemperatureUnit, AbsoluteTemperature, TemperatureUnit, Temperature>
34 {
35 /** */
36 private static final long serialVersionUID = 20150901L;
37
38 /** constant with value zero. */
39 public static final AbsoluteTemperature ZERO = new AbsoluteTemperature(0.0, AbsoluteTemperatureUnit.BASE);
40
41 /**
42 * Construct AbsoluteTemperature scalar.
43 * @param value double value
44 * @param unit unit for the double value
45 */
46 public AbsoluteTemperature(final double value, final AbsoluteTemperatureUnit unit)
47 {
48 super(value, unit);
49 }
50
51 /**
52 * Construct AbsoluteTemperature scalar.
53 * @param value Scalar from which to construct this instance
54 */
55 public AbsoluteTemperature(final AbsoluteTemperature value)
56 {
57 super(value);
58 }
59
60 /** {@inheritDoc} */
61 @Override
62 public final AbsoluteTemperature instantiateAbs(final double value, final AbsoluteTemperatureUnit unit)
63 {
64 return new AbsoluteTemperature(value, unit);
65 }
66
67 /** {@inheritDoc} */
68 @Override
69 public final Temperature instantiateRel(final double value, final TemperatureUnit unit)
70 {
71 return new Temperature(value, unit);
72 }
73
74 /**
75 * Construct %TypeAbsl% scalar.
76 * @param value double value in SI units
77 * @return the new scalar with the SI value
78 */
79 public static final AbsoluteTemperature createSI(final double value)
80 {
81 return new AbsoluteTemperature(value, AbsoluteTemperatureUnit.BASE);
82 }
83
84 /**
85 * Interpolate between two values.
86 * @param zero the low value
87 * @param one the high value
88 * @param ratio the ratio between 0 and 1, inclusive
89 * @return a Scalar at the ratio between
90 */
91 public static AbsoluteTemperature interpolate(final AbsoluteTemperature zero, final AbsoluteTemperature one,
92 final double ratio)
93 {
94 return new AbsoluteTemperature(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getUnit()) * ratio, zero.getUnit());
95 }
96
97 /**
98 * Return the maximum value of two absolute scalars.
99 * @param a1 the first scalar
100 * @param a2 the second scalar
101 * @return the maximum value of two absolute scalars
102 */
103 public static AbsoluteTemperature max(final AbsoluteTemperature a1, final AbsoluteTemperature a2)
104 {
105 return (a1.gt(a2)) ? a1 : a2;
106 }
107
108 /**
109 * Return the maximum value of more than two absolute scalars.
110 * @param a1 the first scalar
111 * @param a2 the second scalar
112 * @param an the other scalars
113 * @return the maximum value of more than two absolute scalars
114 */
115 public static AbsoluteTemperature max(final AbsoluteTemperature a1, final AbsoluteTemperature a2,
116 final AbsoluteTemperature... an)
117 {
118 AbsoluteTemperature maxa = (a1.gt(a2)) ? a1 : a2;
119 for (AbsoluteTemperature a : an)
120 {
121 if (a.gt(maxa))
122 {
123 maxa = a;
124 }
125 }
126 return maxa;
127 }
128
129 /**
130 * Return the minimum value of two absolute scalars.
131 * @param a1 the first scalar
132 * @param a2 the second scalar
133 * @return the minimum value of two absolute scalars
134 */
135 public static AbsoluteTemperature min(final AbsoluteTemperature a1, final AbsoluteTemperature a2)
136 {
137 return (a1.lt(a2)) ? a1 : a2;
138 }
139
140 /**
141 * Return the minimum value of more than two absolute scalars.
142 * @param a1 the first scalar
143 * @param a2 the second scalar
144 * @param an the other scalars
145 * @return the minimum value of more than two absolute scalars
146 */
147 public static AbsoluteTemperature min(final AbsoluteTemperature a1, final AbsoluteTemperature a2,
148 final AbsoluteTemperature... an)
149 {
150 AbsoluteTemperature mina = (a1.lt(a2)) ? a1 : a2;
151 for (AbsoluteTemperature a : an)
152 {
153 if (a.lt(mina))
154 {
155 mina = a;
156 }
157 }
158 return mina;
159 }
160
161 }