1 package org.djunits.value.vfloat.scalar;
2
3 import org.djunits.unit.AreaUnit;
4 import org.djunits.unit.DimensionlessUnit;
5 import org.djunits.unit.FlowVolumeUnit;
6 import org.djunits.unit.FrequencyUnit;
7 import org.djunits.unit.SpeedUnit;
8 import org.djunits.unit.VolumeUnit;
9
10 /**
11 * Easy access methods for the FlowVolume FloatScalar, which is relative by definition. An example is Speed. Instead of:
12 *
13 * <pre>
14 * FloatScalar.Rel<FlowVolumeUnit> value = new FloatScalar.Rel<FlowVolumeUnit>(100.0, FlowVolumeUnit.SI);
15 * </pre>
16 *
17 * we can now write:
18 *
19 * <pre>
20 * FloatFlowVolume value = new FloatFlowVolume(100.0, FlowVolumeUnit.SI);
21 * </pre>
22 *
23 * The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit
24 * used are compatible.
25 * <p>
26 * Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
27 * BSD-style license. See <a href="http://djunits.org/docs/license.html">DJUNITS License</a>.
28 * <p>
29 * $LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $,
30 * initial version Sep 5, 2015 <br>
31 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
32 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
33 */
34 public class FloatFlowVolume extends AbstractFloatScalarRel<FlowVolumeUnit, FloatFlowVolume>
35 {
36 /** */
37 private static final long serialVersionUID = 20150901L;
38
39 /** constant with value zero. */
40 public static final FloatFlowVolume ZERO = new FloatFlowVolume(0.0f, FlowVolumeUnit.SI);
41
42 /** constant with value NaN. */
43 @SuppressWarnings("checkstyle:constantname")
44 public static final FloatFlowVolume NaN = new FloatFlowVolume(Float.NaN, FlowVolumeUnit.SI);
45
46 /** constant with value POSITIVE_INFINITY. */
47 public static final FloatFlowVolume POSITIVE_INFINITY = new FloatFlowVolume(Float.POSITIVE_INFINITY, FlowVolumeUnit.SI);
48
49 /** constant with value NEGATIVE_INFINITY. */
50 public static final FloatFlowVolume NEGATIVE_INFINITY = new FloatFlowVolume(Float.NEGATIVE_INFINITY, FlowVolumeUnit.SI);
51
52 /** constant with value MAX_VALUE. */
53 public static final FloatFlowVolume POS_MAXVALUE = new FloatFlowVolume(Float.MAX_VALUE, FlowVolumeUnit.SI);
54
55 /** constant with value -MAX_VALUE. */
56 public static final FloatFlowVolume NEG_MAXVALUE = new FloatFlowVolume(-Float.MAX_VALUE, FlowVolumeUnit.SI);
57
58 /**
59 * Construct FloatFlowVolume scalar.
60 * @param value float value
61 * @param unit unit for the float value
62 */
63 public FloatFlowVolume(final float value, final FlowVolumeUnit unit)
64 {
65 super(value, unit);
66 }
67
68 /**
69 * Construct FloatFlowVolume scalar.
70 * @param value Scalar from which to construct this instance
71 */
72 public FloatFlowVolume(final FloatFlowVolume value)
73 {
74 super(value);
75 }
76
77 /**
78 * Construct FloatFlowVolume scalar using a double value.
79 * @param value double value
80 * @param unit unit for the resulting float value
81 */
82 public FloatFlowVolume(final double value, final FlowVolumeUnit unit)
83 {
84 super((float) value, unit);
85 }
86
87 /** {@inheritDoc} */
88 @Override
89 public final FloatFlowVolume instantiateRel(final float value, final FlowVolumeUnit unit)
90 {
91 return new FloatFlowVolume(value, unit);
92 }
93
94 /**
95 * Construct FloatFlowVolume scalar.
96 * @param value float value in SI units
97 * @return the new scalar with the SI value
98 */
99 public static final FloatFlowVolume createSI(final float value)
100 {
101 return new FloatFlowVolume(value, FlowVolumeUnit.SI);
102 }
103
104 /**
105 * Interpolate between two values.
106 * @param zero the low value
107 * @param one the high value
108 * @param ratio the ratio between 0 and 1, inclusive
109 * @return a Scalar at the ratio between
110 */
111 public static FloatFlowVolume interpolate(final FloatFlowVolume zero, final FloatFlowVolume one, final float ratio)
112 {
113 return new FloatFlowVolume(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getUnit()) * ratio, zero.getUnit());
114 }
115
116 /**
117 * Return the maximum value of two relative scalars.
118 * @param r1 the first scalar
119 * @param r2 the second scalar
120 * @return the maximum value of two relative scalars
121 */
122 public static FloatFlowVolume max(final FloatFlowVolume r1, final FloatFlowVolume r2)
123 {
124 return (r1.gt(r2)) ? r1 : r2;
125 }
126
127 /**
128 * Return the maximum value of more than two relative scalars.
129 * @param r1 the first scalar
130 * @param r2 the second scalar
131 * @param rn the other scalars
132 * @return the maximum value of more than two relative scalars
133 */
134 public static FloatFlowVolume max(final FloatFlowVolume r1, final FloatFlowVolume r2, final FloatFlowVolume... rn)
135 {
136 FloatFlowVolume maxr = (r1.gt(r2)) ? r1 : r2;
137 for (FloatFlowVolume r : rn)
138 {
139 if (r.gt(maxr))
140 {
141 maxr = r;
142 }
143 }
144 return maxr;
145 }
146
147 /**
148 * Return the minimum value of two relative scalars.
149 * @param r1 the first scalar
150 * @param r2 the second scalar
151 * @return the minimum value of two relative scalars
152 */
153 public static FloatFlowVolume min(final FloatFlowVolume r1, final FloatFlowVolume r2)
154 {
155 return (r1.lt(r2)) ? r1 : r2;
156 }
157
158 /**
159 * Return the minimum value of more than two relative scalars.
160 * @param r1 the first scalar
161 * @param r2 the second scalar
162 * @param rn the other scalars
163 * @return the minimum value of more than two relative scalars
164 */
165 public static FloatFlowVolume min(final FloatFlowVolume r1, final FloatFlowVolume r2, final FloatFlowVolume... rn)
166 {
167 FloatFlowVolume minr = (r1.lt(r2)) ? r1 : r2;
168 for (FloatFlowVolume r : rn)
169 {
170 if (r.lt(minr))
171 {
172 minr = r;
173 }
174 }
175 return minr;
176 }
177
178 /**
179 * Calculate the division of FloatFlowVolume and FloatFlowVolume, which results in a FloatDimensionless scalar.
180 * @param v FloatFlowVolume scalar
181 * @return FloatDimensionless scalar as a division of FloatFlowVolume and FloatFlowVolume
182 */
183 public final FloatDimensionless divideBy(final FloatFlowVolume v)
184 {
185 return new FloatDimensionless(this.si / v.si, DimensionlessUnit.SI);
186 }
187
188 /**
189 * Calculate the multiplication of FloatFlowVolume and FloatDuration, which results in a FloatVolume scalar.
190 * @param v FloatFlowVolume scalar
191 * @return FloatVolume scalar as a multiplication of FloatFlowVolume and FloatDuration
192 */
193 public final FloatVolume multiplyBy(final FloatDuration v)
194 {
195 return new FloatVolume(this.si * v.si, VolumeUnit.SI);
196 }
197
198 /**
199 * Calculate the division of FloatFlowVolume and FloatFrequency, which results in a FloatVolume scalar.
200 * @param v FloatFlowVolume scalar
201 * @return FloatVolume scalar as a division of FloatFlowVolume and FloatFrequency
202 */
203 public final FloatVolume divideBy(final FloatFrequency v)
204 {
205 return new FloatVolume(this.si / v.si, VolumeUnit.SI);
206 }
207
208 /**
209 * Calculate the division of FloatFlowVolume and FloatVolume, which results in a FloatFrequency scalar.
210 * @param v FloatFlowVolume scalar
211 * @return FloatFrequency scalar as a division of FloatFlowVolume and FloatVolume
212 */
213 public final FloatFrequency divideBy(final FloatVolume v)
214 {
215 return new FloatFrequency(this.si / v.si, FrequencyUnit.SI);
216 }
217
218 /**
219 * Calculate the division of FloatFlowVolume and FloatArea, which results in a FloatSpeed scalar.
220 * @param v FloatFlowVolume scalar
221 * @return FloatSpeed scalar as a division of FloatFlowVolume and FloatArea
222 */
223 public final FloatSpeed divideBy(final FloatArea v)
224 {
225 return new FloatSpeed(this.si / v.si, SpeedUnit.SI);
226 }
227
228 /**
229 * Calculate the division of FloatFlowVolume and FloatSpeed, which results in a FloatArea scalar.
230 * @param v FloatFlowVolume scalar
231 * @return FloatArea scalar as a division of FloatFlowVolume and FloatSpeed
232 */
233 public final FloatArea divideBy(final FloatSpeed v)
234 {
235 return new FloatArea(this.si / v.si, AreaUnit.SI);
236 }
237
238 }