1 package org.djunits.value.vdouble.scalar;
2
3 import org.djunits.unit.AccelerationUnit;
4 import org.djunits.unit.DimensionlessUnit;
5 import org.djunits.unit.FrequencyUnit;
6 import org.djunits.unit.MoneyPerDurationUnit;
7 import org.djunits.unit.PowerUnit;
8 import org.djunits.unit.SpeedUnit;
9
10 /**
11 * Easy access methods for the Frequency DoubleScalar, which is relative by definition. Instead of:
12 *
13 * <pre>
14 * DoubleScalar.Rel<FrequencyUnit> value = new DoubleScalar.Rel<FrequencyUnit>(100.0, FrequencyUnit.SI);
15 * </pre>
16 *
17 * we can now write:
18 *
19 * <pre>
20 * Frequency value = new Frequency(100.0, FrequencyUnit.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 Frequency extends AbstractDoubleScalarRel<FrequencyUnit, Frequency>
35 {
36 /** */
37 private static final long serialVersionUID = 20150905L;
38
39 /** constant with value zero. */
40 public static final Frequency ZERO = new Frequency(0.0, FrequencyUnit.SI);
41
42 /** constant with value NaN. */
43 @SuppressWarnings("checkstyle:constantname")
44 public static final Frequency NaN = new Frequency(Double.NaN, FrequencyUnit.SI);
45
46 /** constant with value POSITIVE_INFINITY. */
47 public static final Frequency POSITIVE_INFINITY = new Frequency(Double.POSITIVE_INFINITY, FrequencyUnit.SI);
48
49 /** constant with value NEGATIVE_INFINITY. */
50 public static final Frequency NEGATIVE_INFINITY = new Frequency(Double.NEGATIVE_INFINITY, FrequencyUnit.SI);
51
52 /** constant with value MAX_VALUE. */
53 public static final Frequency POS_MAXVALUE = new Frequency(Double.MAX_VALUE, FrequencyUnit.SI);
54
55 /** constant with value -MAX_VALUE. */
56 public static final Frequency NEG_MAXVALUE = new Frequency(-Double.MAX_VALUE, FrequencyUnit.SI);
57
58 /**
59 * Construct Frequency scalar.
60 * @param value double value
61 * @param unit unit for the double value
62 */
63 public Frequency(final double value, final FrequencyUnit unit)
64 {
65 super(value, unit);
66 }
67
68 /**
69 * Construct Frequency scalar.
70 * @param value Scalar from which to construct this instance
71 */
72 public Frequency(final Frequency value)
73 {
74 super(value);
75 }
76
77 /** {@inheritDoc} */
78 @Override
79 public final Frequency instantiateRel(final double value, final FrequencyUnit unit)
80 {
81 return new Frequency(value, unit);
82 }
83
84 /**
85 * Construct Frequency scalar.
86 * @param value double value in SI units
87 * @return the new scalar with the SI value
88 */
89 public static final Frequency createSI(final double value)
90 {
91 return new Frequency(value, FrequencyUnit.SI);
92 }
93
94 /**
95 * Interpolate between two values.
96 * @param zero the low value
97 * @param one the high value
98 * @param ratio the ratio between 0 and 1, inclusive
99 * @return a Scalar at the ratio between
100 */
101 public static Frequency interpolate(final Frequency zero, final Frequency one, final double ratio)
102 {
103 return new Frequency(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getUnit()) * ratio, zero.getUnit());
104 }
105
106 /**
107 * Return the maximum value of two relative scalars.
108 * @param r1 the first scalar
109 * @param r2 the second scalar
110 * @return the maximum value of two relative scalars
111 */
112 public static Frequency max(final Frequency r1, final Frequency r2)
113 {
114 return (r1.gt(r2)) ? r1 : r2;
115 }
116
117 /**
118 * Return the maximum value of more than two relative scalars.
119 * @param r1 the first scalar
120 * @param r2 the second scalar
121 * @param rn the other scalars
122 * @return the maximum value of more than two relative scalars
123 */
124 public static Frequency max(final Frequency r1, final Frequency r2, final Frequency... rn)
125 {
126 Frequency maxr = (r1.gt(r2)) ? r1 : r2;
127 for (Frequency r : rn)
128 {
129 if (r.gt(maxr))
130 {
131 maxr = r;
132 }
133 }
134 return maxr;
135 }
136
137 /**
138 * Return the minimum value of two relative scalars.
139 * @param r1 the first scalar
140 * @param r2 the second scalar
141 * @return the minimum value of two relative scalars
142 */
143 public static Frequency min(final Frequency r1, final Frequency r2)
144 {
145 return (r1.lt(r2)) ? r1 : r2;
146 }
147
148 /**
149 * Return the minimum value of more than two relative scalars.
150 * @param r1 the first scalar
151 * @param r2 the second scalar
152 * @param rn the other scalars
153 * @return the minimum value of more than two relative scalars
154 */
155 public static Frequency min(final Frequency r1, final Frequency r2, final Frequency... rn)
156 {
157 Frequency minr = (r1.lt(r2)) ? r1 : r2;
158 for (Frequency r : rn)
159 {
160 if (r.lt(minr))
161 {
162 minr = r;
163 }
164 }
165 return minr;
166 }
167
168 /**
169 * Calculate the division of Frequency and Frequency, which results in a Dimensionless scalar.
170 * @param v Frequency scalar
171 * @return Dimensionless scalar as a division of Frequency and Frequency
172 */
173 public final Dimensionless divideBy(final Frequency v)
174 {
175 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
176 }
177
178 /**
179 * Calculate the multiplication of Frequency and Duration, which results in a Dimensionless scalar.
180 * @param v Frequency scalar
181 * @return Dimensionless scalar as a multiplication of Frequency and Duration
182 */
183 public final Dimensionless multiplyBy(final Duration v)
184 {
185 return new Dimensionless(this.si * v.si, DimensionlessUnit.SI);
186 }
187
188 /**
189 * Calculate the multiplication of Frequency and Length, which results in a Speed scalar.
190 * @param v Frequency scalar
191 * @return Speed scalar as a multiplication of Frequency and Length
192 */
193 public final Speed multiplyBy(final Length v)
194 {
195 return new Speed(this.si * v.si, SpeedUnit.SI);
196 }
197
198 /**
199 * Calculate the multiplication of Frequency and Speed, which results in a Acceleration scalar.
200 * @param v Frequency scalar
201 * @return Acceleration scalar as a multiplication of Frequency and Speed
202 */
203 public final Acceleration multiplyBy(final Speed v)
204 {
205 return new Acceleration(this.si * v.si, AccelerationUnit.SI);
206 }
207
208 /**
209 * Calculate the multiplication of Frequency and Energy, which results in a Power scalar.
210 * @param v Frequency scalar
211 * @return Power scalar as a multiplication of Frequency and Energy
212 */
213 public final Power multiplyBy(final Energy v)
214 {
215 return new Power(this.si * v.si, PowerUnit.SI);
216 }
217
218 /**
219 * Calculate the multiplication of Frequency and Money, which results in a MoneyPerDuration scalar.
220 * @param v Frequency scalar
221 * @return MoneyPerDuration scalar as a multiplication of Frequency and Money
222 */
223 public final MoneyPerDuration multiplyBy(final Money v)
224 {
225 return new MoneyPerDuration(this.si * v.si, MoneyPerDurationUnit.getStandardMoneyPerDurationUnit());
226 }
227
228 }