/*
 * $Id: GenMatrixRing.java 3571 2011-03-18 22:02:51Z kredel $
 */

package edu.jas.vector;


// import java.io.IOException;
import java.io.Reader;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;

import org.apache.log4j.Logger;

import edu.jas.kern.StringUtil;
import edu.jas.structure.AlgebraFactory;
import edu.jas.structure.RingElem;
import edu.jas.structure.RingFactory;


/**
 * GenMatrixRing implements a generic matrix algebra factory with RingFactory.
 * Matrices of n rows and m columns over C.
 * @author Heinz Kredel
 */

public class GenMatrixRing<C extends RingElem<C>> implements AlgebraFactory<GenMatrix<C>, C> {


    private static final Logger logger = Logger.getLogger(GenMatrixRing.class);


    public final RingFactory<C> coFac;


    public final int rows;


    public final int cols;


    public final int blocksize;


    public final static int DEFAULT_BSIZE = 10;


    public final GenMatrix<C> ZERO;


    public final GenMatrix<C> ONE;


    private final static Random random = new Random();


    public final static float DEFAULT_DENSITY = 0.5f;


    private final float density = DEFAULT_DENSITY;


    /**
     * Constructors for GenMatrixRing.
     * @param b coefficient factory.
     * @param r number of rows.
     * @param c number of colums.
     */
    public GenMatrixRing(RingFactory<C> b, int r, int c) {
        this(b, r, c, DEFAULT_BSIZE);
    }


    /**
     * Constructors for GenMatrixRing.
     * @param b coefficient factory.
     * @param r number of rows.
     * @param c number of colums.
     * @param s block size for blocked operations.
     */
    @SuppressWarnings("unchecked")
    public GenMatrixRing(RingFactory<C> b, int r, int c, int s) {
        if (b == null) {
            throw new IllegalArgumentException("RingFactory is null");
        }
        if (r < 1) {
            throw new IllegalArgumentException("rows < 1 " + r);
        }
        if (c < 1) {
            throw new IllegalArgumentException("cols < 1 " + c);
        }
        coFac = b;
        rows = r;
        cols = c;
        blocksize = s;
        ArrayList<C> z = new ArrayList<C>(cols);
        for (int i = 0; i < cols; i++) {
            z.add(coFac.getZERO());
        }
        ArrayList<ArrayList<C>> m = new ArrayList<ArrayList<C>>(rows);
        for (int i = 0; i < rows; i++) {
            m.add((ArrayList<C>) z.clone());
        }
        ZERO = new GenMatrix<C>(this, m);
        m = new ArrayList<ArrayList<C>>(rows);
        C one = coFac.getONE();
        ArrayList<C> v;
        for (int i = 0; i < rows; i++) {
            if (i < cols) {
                v = (ArrayList<C>) z.clone();
                v.set(i, one);
                m.add(v);
            }
        }
        ONE = new GenMatrix<C>(this, m);
    }


    /**
     * Get the String representation as RingElem.
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuffer s = new StringBuffer();
        s.append(coFac.getClass().getSimpleName());
        s.append("[" + rows + "," + cols + "]");
        return s.toString();
    }


    /**
     * Get a scripting compatible string representation.
     * @return script compatible representation for this ElemFactory.
     * @see edu.jas.structure.ElemFactory#toScript()
     */
    //JAVA6only: @Override
    public String toScript() {
        // Python case
        StringBuffer s = new StringBuffer("Mat(");
        String f = null;
        try {
            f = ((RingElem<C>) coFac).toScriptFactory(); // sic
        } catch (Exception e) {
            f = coFac.toScript();
        }
        s.append(f + "," + rows + "," + cols + ")");
        return s.toString();
    }


    /**
     * Get the constant one for the GenMatrix.
     * @return ZERO.
     */
    public GenMatrix<C> getZERO() {
        return ZERO;
    }


    /**
     * Get the constant one for the GenMatrix.
     * @return 1.
     */
    public GenMatrix<C> getONE() {
        return ONE;
    }


    /**
     * Get a list of the generating elements.
     * @return list of generators for the algebraic structure.
     * @see edu.jas.structure.ElemFactory#generators()
     */
    public List<GenMatrix<C>> generators() {
        List<C> rgens = coFac.generators();
        List<GenMatrix<C>> gens = new ArrayList<GenMatrix<C>>(rows * cols * rgens.size());
        for (int i = 0; i < rows; i++) {
            for (int j = 0; j < cols; j++) {
                for (C el : rgens) {
                    GenMatrix<C> g = ZERO.set(i, j, el); // uses clone()
                    gens.add(g);
                }
            }
        }
        return gens;
    }


    /**
     * Is this structure finite or infinite.
     * @return true if this structure is finite, else false.
     * @see edu.jas.structure.ElemFactory#isFinite()
     */
    public boolean isFinite() {
        return coFac.isFinite();
    }


    /**
     * Comparison with any other object.
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object other) {
        if (!(other instanceof GenMatrixRing)) {
            return false;
        }
        GenMatrixRing omod = (GenMatrixRing) other;
        if (rows != omod.rows) {
            return false;
        }
        if (cols != omod.cols) {
            return false;
        }
        if (!coFac.equals(omod.coFac)) {
            return false;
        }
        return true;
    }


    /**
     * Hash code for this matrix ring.
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        int h;
        h = rows * 17 + cols;
        h = 37 * h + coFac.hashCode();
        return h;
    }


    /**
     * Query if this ring is a field. May return false if it is to hard to
     * determine if this ring is a field.
     * @return true if it is known that this ring is a field, else false.
     */
    public boolean isField() {
        return false;
    }


    /**
     * Query if this monoid is commutative.
     * @return true if this monoid is commutative, else false.
     */
    public boolean isCommutative() {
        return false;
    }


    /**
     * Query if this ring is associative.
     * @return true if this monoid is associative, else false.
     */
    public boolean isAssociative() {
        return (rows == cols);
    }


    /**
     * Characteristic of this ring.
     * @return characteristic of this ring.
     */
    public java.math.BigInteger characteristic() {
        return coFac.characteristic();
    }


    /**
     * Transposed matrix ring.
     * @return transposed ring factory.
     */
    public GenMatrixRing<C> transpose() {
        if (rows == cols) {
            return this;
        }
        return new GenMatrixRing<C>(coFac, cols, rows, blocksize);
    }


    /**
     * Product matrix ring for multiplication.
     * @param other matrix ring factory.
     * @return product ring factory.
     */
    public GenMatrixRing<C> product(GenMatrixRing<C> other) {
        if (cols != other.rows) {
            throw new IllegalArgumentException("invalid dimensions in product");
        }
        if (!coFac.equals(other.coFac)) {
            throw new IllegalArgumentException("invalid coefficients in product");
        }
        if (rows == other.rows && cols == other.cols) {
            return this;
        }
        return new GenMatrixRing<C>(coFac, rows, other.cols, blocksize);
    }


    /**
     * Get the matrix for a.
     * @param a long
     * @return matrix corresponding to a.
     */
    public GenMatrix<C> fromInteger(long a) {
        C c = coFac.fromInteger(a);
        return ONE.scalarMultiply(c);
    }


    /**
     * Get the matrix for a.
     * @param a long
     * @return matrix corresponding to a.
     */
    public GenMatrix<C> fromInteger(BigInteger a) {
        C c = coFac.fromInteger(a);
        return ONE.scalarMultiply(c);
    }


    /**
     * From List of coefficients.
     * @param om list of list of coefficients.
     */
    public GenMatrix<C> fromList(List<List<C>> om) {
        if (om == null) {
            return ZERO;
        }
        if (om.size() > rows) {
            throw new IllegalArgumentException("size v > rows " + om + " > " + rows);
        }
        ArrayList<ArrayList<C>> m = new ArrayList<ArrayList<C>>(rows);
        for (int i = 0; i < rows; i++) {
            List<C> ov = om.get(i);
            ArrayList<C> v;
            if (ov == null) {
                v = ZERO.matrix.get(0);
            } else {
                if (ov.size() > cols) {
                    throw new IllegalArgumentException("size v > cols " + ov + " > " + cols);
                }
                v = new ArrayList<C>(cols);
                v.addAll(ov);
                // pad with zeros if required:
                for (int j = v.size(); j < cols; j++) {
                    v.add(coFac.getZERO());
                }
            }
            m.add(v);
        }
        return new GenMatrix<C>(this, m);
    }


    /**
     * Random matrix.
     * @param k size of random coefficients.
     */
    public GenMatrix<C> random(int k) {
        return random(k, density, random);
    }


    /**
     * Random matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     */
    public GenMatrix<C> random(int k, float q) {
        return random(k, q, random);
    }


    /**
     * Random matrix.
     * @param k size of random coefficients.
     * @param random is a source for random bits.
     * @return a random element.
     */
    public GenMatrix<C> random(int k, Random random) {
        return random(k, density, random);
    }


    /**
     * Random matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     * @param random is a source for random bits.
     * @return a random element.
     */
    public GenMatrix<C> random(int k, float q, Random random) {
        ArrayList<ArrayList<C>> m = new ArrayList<ArrayList<C>>(rows);
        for (int i = 0; i < rows; i++) {
            ArrayList<C> v = new ArrayList<C>(cols);
            for (int j = 0; j < cols; j++) {
                C e;
                if (random.nextFloat() < q) {
                    e = coFac.random(k);
                } else {
                    e = coFac.getZERO();
                }
                v.add(e);
            }
            m.add(v);
        }
        return new GenMatrix<C>(this, m);
    }


    /**
     * Random upper triangular matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     */
    public GenMatrix<C> randomUpper(int k, float q) {
        return randomUpper(k, q, random);
    }


    /**
     * Random upper triangular matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     * @param random is a source for random bits.
     * @return a random element.
     */
    public GenMatrix<C> randomUpper(int k, float q, Random random) {
        ArrayList<ArrayList<C>> m = new ArrayList<ArrayList<C>>(rows);
        for (int i = 0; i < rows; i++) {
            ArrayList<C> v = new ArrayList<C>(cols);
            for (int j = 0; j < cols; j++) {
                C e = coFac.getZERO();
                if (j >= i) {
                    if (random.nextFloat() < q) {
                        e = coFac.random(k);
                    }
                }
                v.add(e);
            }
            m.add(v);
        }
        return new GenMatrix<C>(this, m);
    }


    /**
     * Random lower triangular matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     */
    public GenMatrix<C> randomLower(int k, float q) {
        return randomLower(k, q, random);
    }


    /**
     * Random lower triangular matrix.
     * @param k size of random coefficients.
     * @param q density of nozero coefficients.
     * @param random is a source for random bits.
     * @return a random element.
     */
    public GenMatrix<C> randomLower(int k, float q, Random random) {
        ArrayList<ArrayList<C>> m = new ArrayList<ArrayList<C>>(rows);
        for (int i = 0; i < rows; i++) {
            ArrayList<C> v = new ArrayList<C>(cols);
            for (int j = 0; j < cols; j++) {
                C e = coFac.getZERO();
                if (j <= i) {
                    if (random.nextFloat() < q) {
                        e = coFac.random(k);
                    }
                }
                v.add(e);
            }
            m.add(v);
        }
        return new GenMatrix<C>(this, m);
    }


    /**
     * copy matrix.
     */
    public GenMatrix<C> copy(GenMatrix<C> c) {
        if (c == null) {
            return c;
        }
        return c.clone();
    }


    /**
     * parse a matrix from a String. Syntax: [ [ c, ..., c ], ..., [ c, ..., c ]
     * ]
     */
    public GenMatrix<C> parse(String s) {
        int i = s.indexOf("[");
        if (i >= 0) {
            s = s.substring(i + 1);
        }
        ArrayList<ArrayList<C>> mat = new ArrayList<ArrayList<C>>(rows);
        ArrayList<C> v;
        GenVector<C> vec;
        GenVectorModul<C> vmod = new GenVectorModul<C>(coFac, cols);
        String e;
        int j;
        do {
            i = s.indexOf("]"); // delimit vector
            j = s.lastIndexOf("]"); // delimit matrix
            if (i != j) {
                if (i >= 0) {
                    e = s.substring(0, i);
                    s = s.substring(i);
                    vec = vmod.parse(e);
                    v = (ArrayList<C>) vec.val;
                    mat.add(v);
                    i = s.indexOf(",");
                    if (i >= 0) {
                        s = s.substring(i + 1);
                    }
                }
            } else { // matrix delimiter
                if (i >= 0) {
                    e = s.substring(0, i);
                    if (e.trim().length() > 0) {
                        throw new RuntimeException("Error e not empty " + e);
                    }
                    s = s.substring(i + 1);
                }
                break;
            }
        } while (i >= 0);
        return new GenMatrix<C>(this, mat);
    }


    /**
     * parse a matrix from a Reader.
     */
    public GenMatrix<C> parse(Reader r) {
        String s = StringUtil.nextPairedString(r, '[', ']');
        return parse(s);
    }

}
