summaryrefslogtreecommitdiff
path: root/src/main/java/org/unitConverter/unit/MultiUnit.java
blob: a1623f89dad020ab448110a6a15bed50b950f352 (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/**
 * Copyright (C) 2020 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;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.unitConverter.math.ObjectProduct;

/**
 * A combination of units, like "5 foot + 7 inch". All but the last units should
 * have a whole number value associated with them.
 *
 * @since 2020-10-02
 */
public final class MultiUnit extends Unitlike<List<Double>> {
	/**
	 * Creates a {@code MultiUnit} from its units. It will not have a name or
	 * symbol.
	 *
	 * @since 2020-10-03
	 */
	public static final MultiUnit of(LinearUnit... units) {
		return of(Arrays.asList(units));
	}
	
	/**
	 * Creates a {@code MultiUnit} from its units. It will not have a name or
	 * symbol.
	 *
	 * @since 2020-10-03
	 */
	public static final MultiUnit of(List<LinearUnit> units) {
		if (units.size() < 1)
			throw new IllegalArgumentException("Must have at least one unit");
		final ObjectProduct<BaseUnit> unitBase = units.get(0).getBase();
		for (final LinearUnit unit : units) {
			if (!unitBase.equals(unit.getBase()))
				throw new IllegalArgumentException(
						"All units must have the same base.");
		}
		return new MultiUnit(new ArrayList<>(units), unitBase, NameSymbol.EMPTY);
	}
	
	/**
	 * The units that make up this value.
	 */
	private final List<LinearUnit> units;
	
	/**
	 * Creates a {@code MultiUnit}.
	 *
	 * @since 2020-10-03
	 */
	private MultiUnit(List<LinearUnit> units, ObjectProduct<BaseUnit> unitBase,
			NameSymbol ns) {
		super(unitBase, ns);
		this.units = units;
	}
	
	@Override
	protected List<Double> convertFromBase(double value) {
		final List<Double> values = new ArrayList<>(this.units.size());
		double temp = value;
		
		for (final LinearUnit unit : this.units.subList(0,
				this.units.size() - 1)) {
			values.add(Math.floor(temp / unit.getConversionFactor()));
			temp %= unit.getConversionFactor();
		}
		
		values.add(this.units.size() - 1,
				this.units.get(this.units.size() - 1).convertFromBase(temp));
		
		return values;
	}
	
	/**
	 * Converts a value expressed in this unitlike form to a value expressed in
	 * {@code other}.
	 * 
	 * @implSpec If conversion is possible, this implementation returns
	 *           {@code other.convertFromBase(this.convertToBase(value))}.
	 *           Therefore, overriding either of those methods will change the
	 *           output of this method.
	 * 				
	 * @param other unit to convert to
	 * @param value value to convert
	 * @return converted value
	 * @since 2020-10-03
	 * @throws IllegalArgumentException if {@code other} is incompatible for
	 *                                  conversion with this unitlike form (as
	 *                                  tested by {@link Unit#canConvertTo}).
	 * @throws NullPointerException     if other is null
	 */
	public final <U extends Unitlike<V>, V> V convertTo(U other,
			double... values) {
		final List<Double> valueList = new ArrayList<>(values.length);
		for (final double d : values) {
			valueList.add(d);
		}
		
		return this.convertTo(other, valueList);
	}
	
	/**
	 * Converts a value expressed in this unitlike form to a value expressed in
	 * {@code other}.
	 * 
	 * @implSpec If conversion is possible, this implementation returns
	 *           {@code other.convertFromBase(this.convertToBase(value))}.
	 *           Therefore, overriding either of those methods will change the
	 *           output of this method.
	 * 				
	 * @param other unit to convert to
	 * @param value value to convert
	 * @return converted value
	 * @since 2020-10-03
	 * @throws IllegalArgumentException if {@code other} is incompatible for
	 *                                  conversion with this unitlike form (as
	 *                                  tested by {@link Unit#canConvertTo}).
	 * @throws NullPointerException     if other is null
	 */
	public final double convertTo(Unit other, double... values) {
		final List<Double> valueList = new ArrayList<>(values.length);
		for (final double d : values) {
			valueList.add(d);
		}
		
		return this.convertTo(other, valueList);
	}
	
	@Override
	protected double convertToBase(List<Double> value) {
		if (value.size() != this.units.size())
			throw new IllegalArgumentException("Wrong number of values for "
					+ this.units.size() + "-unit MultiUnit.");
		
		double baseValue = 0;
		for (int i = 0; i < this.units.size(); i++) {
			baseValue += value.get(i) * this.units.get(i).getConversionFactor();
		}
		return baseValue;
	}
}