Added unit prefixes.

1 files changed, 134 insertions, 0 deletions

diff --git a/src/org/unitConverter/newUnits/UnitPrefix.java b/src/org/unitConverter/newUnits/UnitPrefix.java
new file mode 100644
index 0000000..905ca19
--- /dev/null
+++ b/src/org/unitConverter/newUnits/UnitPrefix.java
@@ -0,0 +1,134 @@
+/**
+ * Copyright (C) 2019 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.newUnits;
+
+import org.unitConverter.math.DecimalComparison;
+
+/**
+ * A prefix that can be applied to a {@code LinearUnit} to multiply it by some value
+ * 
+ * @author Adrien Hopkins
+ * @since 2019-10-16
+ */
+public final class UnitPrefix {
+	/**
+	 * The number that this prefix multiplies units by
+	 * 
+	 * @since 2019-10-16
+	 */
+	private final double multiplier;
+
+	/**
+	 * Creates the {@code DefaultUnitPrefix}.
+	 * 
+	 * @param multiplier
+	 * @since 2019-01-14
+	 * @since v0.2.0
+	 */
+	private UnitPrefix(final double multiplier) {
+		this.multiplier = multiplier;
+	}
+
+	/**
+	 * Divides this prefix by a scalar
+	 * 
+	 * @param divisor
+	 *            number to divide by
+	 * @return quotient of prefix and scalar
+	 * @since 2019-10-16
+	 */
+	public UnitPrefix dividedBy(final double divisor) {
+		return new UnitPrefix(this.getMultiplier() / divisor);
+	}
+
+	/**
+	 * Divides this prefix by {@code other}.
+	 * 
+	 * @param other
+	 *            prefix to divide by
+	 * @return quotient of prefixes
+	 * @since 2019-04-13
+	 * @since v0.2.0
+	 */
+	public UnitPrefix dividedBy(final UnitPrefix other) {
+		return new UnitPrefix(this.getMultiplier() / other.getMultiplier());
+	}
+
+	@Override
+	public boolean equals(final Object obj) {
+		if (this == obj)
+			return true;
+		if (obj == null)
+			return false;
+		if (!(obj instanceof UnitPrefix))
+			return false;
+		final UnitPrefix other = (UnitPrefix) obj;
+		return DecimalComparison.equals(this.getMultiplier(), other.getMultiplier());
+	}
+
+	public double getMultiplier() {
+		return this.multiplier;
+	}
+
+	@Override
+	public int hashCode() {
+		return DecimalComparison.hash(this.getMultiplier());
+	}
+
+	/**
+	 * Multiplies this prefix by a scalar
+	 * 
+	 * @param multiplicand
+	 *            number to multiply by
+	 * @return product of prefix and scalar
+	 * @since 2019-10-16
+	 */
+	public UnitPrefix times(final double multiplicand) {
+		return new UnitPrefix(this.getMultiplier() * multiplicand);
+	}
+
+	/**
+	 * Multiplies this prefix by {@code other}.
+	 * 
+	 * @param other
+	 *            prefix to multiply by
+	 * @return product of prefixes
+	 * @since 2019-04-13
+	 * @since v0.2.0
+	 */
+	public UnitPrefix times(final UnitPrefix other) {
+		return new UnitPrefix(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
+	 */
+	public UnitPrefix toExponent(final double exponent) {
+		return new UnitPrefix(Math.pow(this.getMultiplier(), exponent));
+	}
+
+	@Override
+	public String toString() {
+		return String.format("Unit prefix equal to %s", this.multiplier);
+	}
+}