/*
 * Units of Measurement Reference Implementation
 * Copyright (c) 2005-2023, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JSR-385, Indriya nor the names of their contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package tech.units.indriya.unit;

import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;

import javax.measure.Dimension;
import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.UnitConverter;

import tech.units.indriya.AbstractUnit;
import tech.units.indriya.function.AbstractConverter;
import tech.units.indriya.internal.function.Lazy;

/**
 * <p>
 * This class represents units formed by the product of rational powers of existing physical units.
 * </p>
 *
 * <p>
 * This class maintains the canonical form of this product (simplest form after factorization). For example: <code>METRE.pow(2).divide(METRE)</code>
 * returns <code>METRE</code>.
 * </p>
 *
 * @param <Q>
 *            The type of the quantity measured by this unit.
 *
 * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
 * @author <a href="mailto:werner@units.tech">Werner Keil</a>
 * @author Andi Huber
 * @version 2.0, November 21, 2020
 * @since 1.0
 */
public final class ProductUnit<Q extends Quantity<Q>> extends AbstractUnit<Q> {

    /**
     *
     */
    private static final long serialVersionUID = 962983585531030093L;

    /**
     * Holds the units composing this product unit.
     * 
     * <dl>
     * <dt><span class="strong">Implementation Note:</span></dt><dd>considered immutable after constructor was called</dd>           
     * </dl> 
     */
    private final Element[] elements;

    /**
     * DefaultQuantityFactory constructor (used solely to create <code>ONE</code> instance).
     */
    public ProductUnit() {
        super("");
        elements = new Element[0];
    }

    /**
     * Copy constructor (allows for parameterization of product units).
     *
     * @param productUnit
     *            the product unit source.
     * @throws ClassCastException
     *             if the specified unit is not a product unit.
     */
    public ProductUnit(Unit<?> productUnit) {
        super(productUnit.getSymbol());
        this.elements = ((ProductUnit<?>) productUnit).elements;
    }

    /**
     * Product unit constructor.
     *
     * @param elements
     *            the product elements.
     */
    private ProductUnit(Element[] elements) {
        super(null);
        this.elements = elements;
    }

    /**
     * Returns the product of the specified units.
     *
     * @param left
     *            the left unit operand.
     * @param right
     *            the right unit operand.
     * @return <code>left * right</code>
     */
    public static Unit<?> ofProduct(Unit<?> left, Unit<?> right) {
        Element[] leftElems;
        if (left instanceof ProductUnit<?>) {
            leftElems = ((ProductUnit<?>) left).elements;
        } else {
            leftElems = new Element[] { new Element(left, 1, 1) };
        }
        Element[] rightElems;
        if (right instanceof ProductUnit<?>) {
            rightElems = ((ProductUnit<?>) right).elements;
        } else {
            rightElems = new Element[] { new Element(right, 1, 1) };
        }
        return getInstance(leftElems, rightElems);
    }

    /**
     * Returns the quotient of the specified units.
     *
     * @param left
     *            the dividend unit operand.
     * @param right
     *            the divisor unit operand.
     * @return <code>dividend / divisor</code>
     */
    public static Unit<?> ofQuotient(Unit<?> left, Unit<?> right) {
        Element[] leftElems;
        if (left instanceof ProductUnit<?>)
            leftElems = ((ProductUnit<?>) left).elements;
        else
            leftElems = new Element[] { new Element(left, 1, 1) };
        Element[] rightElems;
        if (right instanceof ProductUnit<?>) {
            Element[] elems = ((ProductUnit<?>) right).elements;
            rightElems = new Element[elems.length];
            for (int i = 0; i < elems.length; i++) {
                rightElems[i] = new Element(elems[i].unit, -elems[i].pow, elems[i].root);
            }
        } else
            rightElems = new Element[] { new Element(right, -1, 1) };
        return getInstance(leftElems, rightElems);
    }

    /**
     * Returns the product unit corresponding to the specified root of the specified unit.
     *
     * @param unit
     *            the unit.
     * @param n
     *            the root's order (n &gt; 0).
     * @return <code>unit^(1/nn)</code>
     * @throws ArithmeticException
     *             if <code>n == 0</code>.
     */
    public static Unit<?> ofRoot(Unit<?> unit, int n) {
        Element[] unitElems;
        if (unit instanceof ProductUnit<?>) {
            Element[] elems = ((ProductUnit<?>) unit).elements;
            unitElems = new Element[elems.length];
            for (int i = 0; i < elems.length; i++) {
                int gcd = gcd(Math.abs(elems[i].pow), elems[i].root * n);
                unitElems[i] = new Element(elems[i].unit, elems[i].pow / gcd, elems[i].root * n / gcd);
            }
        } else
            unitElems = new Element[] { new Element(unit, 1, n) };
        return getInstance(unitElems, new Element[0]);
    }

    /**
     * Returns the product unit corresponding to this unit raised to the specified exponent.
     *
     * @param unit
     *            the unit.
     * @param nn
     *            the exponent (nn &gt; 0).
     * @return <code>unit^n</code>
     */
    public static Unit<?> ofPow(Unit<?> unit, int n) {
        Element[] unitElems;
        if (unit instanceof ProductUnit<?>) {
            Element[] elems = ((ProductUnit<?>) unit).elements;
            unitElems = new Element[elems.length];
            for (int i = 0; i < elems.length; i++) {
                int gcd = gcd(Math.abs(elems[i].pow * n), elems[i].root);
                unitElems[i] = new Element(elems[i].unit, elems[i].pow * n / gcd, elems[i].root / gcd);
            }
        } else
            unitElems = new Element[] { new Element(unit, n, 1) };
        return getInstance(unitElems, new Element[0]);
    }

    @Override
    public Unit<?> pow(int n) {
      return ofPow(this, n);
    }

    /**
     * Returns the number of unit elements in this product.
     *
     * @return the number of unit elements.
     */
    public int getUnitCount() {
        return elements.length;
    }

    /**
     * Returns the unit element at the specified position.
     *
     * @param index
     *            the index of the unit element to return.
     * @return the unit element at the specified position.
     * @throws IndexOutOfBoundsException
     *             if index is out of range <code>(index &lt; 0 || index &gt;= getUnitCount())</code>.
     */
    public Unit<?> getUnit(int index) {
        return elements[index].getUnit();
    }

    /**
     * Returns the power exponent of the unit element at the specified position.
     *
     * @param index
     *            the index of the unit element.
     * @return the unit power exponent at the specified position.
     * @throws IndexOutOfBoundsException
     *             if index is out of range <code>(index &lt; 0 || index &gt;= getUnitCount())</code>.
     */
    public int getUnitPow(int index) {
        return elements[index].getPow();
    }

    /**
     * Returns the root exponent of the unit element at the specified position.
     *
     * @param index
     *            the index of the unit element.
     * @return the unit root exponent at the specified position.
     * @throws IndexOutOfBoundsException
     *             if index is out of range <code>(index &lt; 0 || index &gt;= getUnitCount())</code>.
     */
    public int getUnitRoot(int index) {
        return elements[index].getRoot();
    }

    @Override
    public Map<Unit<?>, Integer> getBaseUnits() {
        final Map<Unit<?>, Integer> units = new LinkedHashMap<>();
        for (int i = 0; i < getUnitCount(); i++) {
            units.put(getUnit(i), getUnitPow(i));
        }
        return units;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof ProductUnit<?>) {
            final ProductUnit<?> other = ((ProductUnit<?>) obj); 
            return ElementUtil.arrayEqualsArbitraryOrder(this.elements, other.elements);
        }
        return false;
    }

    // thread safe cache for the expensive hashCode calculation 
    private transient Lazy<Integer> hashCode = new Lazy<>(this::calculateHashCode); 
    private int calculateHashCode() {
        return Objects.hash((Object[]) ElementUtil.copyAndSort(elements));
    }
    
    @Override
    public int hashCode() {
        return hashCode.get(); // lazy and thread-safe
    }

    @SuppressWarnings("unchecked")
    @Override
    public Unit<Q> toSystemUnit() {
        Unit<?> systemUnit = AbstractUnit.ONE;
        for (Element element : elements) {
            Unit<?> unit = element.unit.getSystemUnit();
            unit = unit.pow(element.pow);
            unit = unit.root(element.root);
            systemUnit = systemUnit.multiply(unit);
        }
        return (AbstractUnit<Q>) systemUnit;
    }

    @Override
    public UnitConverter getSystemConverter() {
        UnitConverter converter = AbstractConverter.IDENTITY;
        for (Element e : elements) {
            if (e.unit instanceof AbstractUnit) {
                UnitConverter cvtr = ((AbstractUnit<?>) e.unit).getSystemConverter();
                if (!(cvtr.isLinear()))
                    throw new UnsupportedOperationException(e.unit + " is non-linear, cannot convert");
                if (e.root != 1)
                    throw new UnsupportedOperationException(e.unit + " holds a base unit with fractional exponent");
                int pow = e.pow;
                if (pow < 0) { // Negative power.
                    pow = -pow;
                    cvtr = cvtr.inverse();
                }
                for (int j = 0; j < pow; j++) {
                    converter = converter.concatenate(cvtr);
                }
            }
        }
        return converter;
    }

    @Override
    public Dimension getDimension() {
        Dimension dimension = UnitDimension.NONE;
        for (int i = 0; i < this.getUnitCount(); i++) {
            Unit<?> unit = this.getUnit(i);
            if (this.elements != null && unit.getDimension() != null) {
                Dimension d = unit.getDimension().pow(this.getUnitPow(i)).root(this.getUnitRoot(i));
                dimension = dimension.multiply(d);
            }
        }
        return dimension;
    }

    /**
     * Returns the unit defined from the product of the specified elements.
     *
     * @param leftElems
     *            left multiplicand elements.
     * @param rightElems
     *            right multiplicand elements.
     * @return the corresponding unit.
     */
    @SuppressWarnings("rawtypes")
    private static Unit<?> getInstance(Element[] leftElems, Element[] rightElems) {

        // Merges left elements with right elements.
        Element[] result = new Element[leftElems.length + rightElems.length];
        int resultIndex = 0;
        for (Element leftElem : leftElems) {
            Unit<?> unit = leftElem.unit;
            int p1 = leftElem.pow;
            int r1 = leftElem.root;
            int p2 = 0;
            int r2 = 1;
            for (Element rightElem : rightElems) {
                if (unit.equals(rightElem.unit)) {
                    p2 = rightElem.pow;
                    r2 = rightElem.root;
                    break; // No duplicate.
                }
            }
            int pow = p1 * r2 + p2 * r1;
            int root = r1 * r2;
            if (pow != 0) {
                int gcd = gcd(Math.abs(pow), root);
                result[resultIndex++] = new Element(unit, pow / gcd, root / gcd);
            }
        }

        // Appends remaining right elements not merged.
        for (Element rightElem : rightElems) {
            Unit<?> unit = rightElem.unit;
            boolean hasBeenMerged = false;
            for (Element leftElem : leftElems) {
                if (unit.equals(leftElem.unit)) {
                    hasBeenMerged = true;
                    break;
                }
            }
            if (!hasBeenMerged)
                result[resultIndex++] = rightElem;
        }

        // Returns or creates instance.
        if (resultIndex == 0)
            return AbstractUnit.ONE;
        else if (resultIndex == 1 && result[0].pow == result[0].root)
            return result[0].unit;
        else {
            Element[] elems = new Element[resultIndex];
            System.arraycopy(result, 0, elems, 0, resultIndex);
            return new ProductUnit(elems);
        }
    }

    /**
     * Returns the greatest common divisor (Euclid's algorithm).
     *
     * @param m
     *            the first number.
     * @param nn
     *            the second number.
     * @return the greatest common divisor.
     */
    private static int gcd(int m, int n) {
        return n == 0 ? m : gcd(n, m % n);
    }

    /**
     * Inner product element represents a rational power of a single unit.
     */
    private final static class Element implements Serializable {

        /**
         *
         */
        private static final long serialVersionUID = 452938412398890507L;

        /**
         * Holds the single unit.
         */
        private final Unit<?> unit;

        /**
         * Holds the power exponent.
         */
        private final int pow;

        /**
         * Holds the root exponent.
         */
        private final int root;

        /**
         * Structural constructor.
         *
         * @param unit
         *            the unit.
         * @param pow
         *            the power exponent.
         * @param root
         *            the root exponent.
         */
        private Element(Unit<?> unit, int pow, int root) {
            this.unit = unit;
            this.pow = pow;
            this.root = root;
        }

        /**
         * Returns this element's unit.
         *
         * @return the single unit.
         */
        public Unit<?> getUnit() {
            return unit;
        }

        /**
         * Returns the power exponent. The power exponent can be negative but is always different from zero.
         *
         * @return the power exponent of the single unit.
         */
        public int getPow() {
            return pow;
        }

        /**
         * Returns the root exponent. The root exponent is always greater than zero.
         *
         * @return the root exponent of the single unit.
         */
        public int getRoot() {
            return root;
        }

        @Override
        public boolean equals(Object o) {
            if (this == o)
                return true;
            if (o == null || getClass() != o.getClass())
                return false;

            final Element other = (Element) o;

            if (!Objects.equals(this.pow, other.pow)) {
                return false;
            }
            if (!Objects.equals(this.root, other.root)) {
                return false;
            }
            return Objects.equals(this.unit, other.unit);
        }

        @Override
        public int hashCode() {
            return Objects.hash(unit, pow, root);
        }
    }

    // Element specific algorithms provided locally to this class
    private final static class ElementUtil {
        
        // -- returns a defensive sorted copy, unless size <= 1 
        private static Element[] copyAndSort(final Element[] elements) {
            if (elements == null || elements.length <= 1) {
                return elements;
            }
            final Element[] elementsSorted = Arrays.copyOf(elements, elements.length);
            Arrays.sort(elementsSorted, ElementUtil::compare);
            return elementsSorted;
        }
        
        private static int compare(final Element e0, final Element e1) {
            final Unit<?> sysUnit0 = e0.getUnit().getSystemUnit();
            final Unit<?> sysUnit1 = e1.getUnit().getSystemUnit();
            final String symbol0 = sysUnit0.getSymbol();
            final String symbol1 = sysUnit1.getSymbol();
            
            if (symbol0 != null && symbol1 != null) {
                return symbol0.compareTo(symbol1);
            } else {
                return sysUnit0.toString().compareTo(sysUnit1.toString());
            }
        }
        
        // optimized for the fact, that can only return true, if for each element in e0 there exist a single match in e1
        private static boolean arrayEqualsArbitraryOrder(final Element[] e0, final Element[] e1) {
            if (e0.length != e1.length) {
                return false;
            }
            for (Element left : e0) {
                boolean unitFound = false;
                for (Element right : e1) {
                    if (left.unit.equals(right.unit)) {
                        if (left.pow != right.pow || left.root != right.root) {
                            return false;
                        } else {
                            unitFound = true;
                            break;
                        }
                    }
                }
                if (!unitFound) {
                    return false;
                }
            }
            return true;
        }
    }
    
    
    // -- SERIALIZATION PROXY
    
    // Chapter 12. Serialization
    // Bloch, Joshua. Effective Java (p. 339). Pearson Education. 
    
    private Object writeReplace() {
        return new SerializationProxy(this);
    }

    private void readObject(ObjectInputStream stream) throws InvalidObjectException {
        throw new InvalidObjectException("Proxy required");
    }

    private static class SerializationProxy implements Serializable {
        private static final long serialVersionUID = 1L;
        private final Element[] elements;
        private final String symbol;
        
        private SerializationProxy(ProductUnit<?> productUnit) {
            this.elements = productUnit.elements;
            this.symbol = productUnit.getSymbol();
        }

        private Object readResolve() {
            ProductUnit<?> pu = new ProductUnit<>(elements);
            pu.setSymbol(symbol);
            return pu;
        }
    }
    
}