blob: 9f9645df3f8c70eaf66077a97dd03a9e1df147f4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/**
* Copyright (C) 2018 Adrien Hopkins
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package org.unitConverter.unit;
/**
* A prefix that can be attached onto the front of any unit, which multiplies it by a certain value
*
* @author Adrien Hopkins
* @since 2019-01-14
* @since v0.1.0
*/
public interface UnitPrefix {
/**
* Divides this prefix by {@code other}.
*
* @param other
* prefix to divide by
* @return quotient of prefixes
* @since 2019-04-13
* @since v0.2.0
*/
default UnitPrefix dividedBy(final UnitPrefix other) {
return new DefaultUnitPrefix(this.getMultiplier() / other.getMultiplier());
}
/**
* @return this prefix's multiplier
* @since 2019-01-14
* @since v0.1.0
*/
double getMultiplier();
/**
* Multiplies this prefix by {@code other}.
*
* @param other
* prefix to multiply by
* @return product of prefixes
* @since 2019-04-13
* @since v0.2.0
*/
default UnitPrefix times(final UnitPrefix other) {
return new DefaultUnitPrefix(this.getMultiplier() * other.getMultiplier());
}
/**
* Raises this prefix to an exponent.
*
* @param exponent
* exponent to raise to
* @return result of exponentiation.
* @since 2019-04-13
* @since v0.2.0
*/
default UnitPrefix toExponent(final double exponent) {
return new DefaultUnitPrefix(Math.pow(getMultiplier(), exponent));
}
}
|
