package jsci.util;

import jsci.maths.Complex;
import jsci.maths.matrices.*;

/**
* This is a useful collection of matrix related methods.
* @author Mark Hale
*/
public final class MatrixToolkit {
        private MatrixToolkit() {}

        /**
        * Creates a random generated square matrix.
        */
        public static DoubleSquareMatrix randomSquareMatrix(int size) {
                return (DoubleSquareMatrix)new DoubleSquareMatrix(size).mapElements(RandomMap.MAP);
        }
        /**
        * Creates a random generated tridiagonal matrix.
        */
        public static DoubleTridiagonalMatrix randomTridiagonalMatrix(int size) {
                return new DoubleTridiagonalMatrix(toArray(randomSquareMatrix(size)));
        }
        /**
        * Creates a random generated diagonal matrix.
        */
        public static DoubleDiagonalMatrix randomDiagonalMatrix(int size) {
                return new DoubleDiagonalMatrix(toArray(randomSquareMatrix(size)));
        }

        /**
        * Creates a random generated square matrix.
        */
        public static ComplexSquareMatrix randomComplexSquareMatrix(int size) {
                return (ComplexSquareMatrix)new ComplexSquareMatrix(size).mapElements(RandomMap.MAP);
        }
        /**
        * Creates a random generated tridiagonal matrix.
        */
        public static ComplexTridiagonalMatrix randomComplexTridiagonalMatrix(int size) {
                return new ComplexTridiagonalMatrix(toArray(randomComplexSquareMatrix(size)));
        }
        /**
        * Creates a random generated diagonal matrix.
        */
        public static ComplexDiagonalMatrix randomComplexDiagonalMatrix(int size) {
                return new ComplexDiagonalMatrix(toArray(randomComplexSquareMatrix(size)));
        }

        /**
        * Converts a matrix to an array.
        */
        public static double[][] toArray(AbstractDoubleMatrix v) {
                double array[][]=new double[v.rows()][v.columns()];
                for(int j,i=0;i