/**
 * 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));
	}
}