All Downloads are FREE. Search and download functionalities are using the official Maven repository.

matrix4j.matrix.MatrixUtils Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2019 and onwards Makoto Yui
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package matrix4j.matrix;

import matrix4j.matrix.builders.MatrixBuilder;
import matrix4j.matrix.ints.IntMatrix;
import matrix4j.matrix.sparse.CSCMatrix;
import matrix4j.matrix.sparse.CSRMatrix;
import matrix4j.matrix.sparse.floats.CSCFloatMatrix;
import matrix4j.matrix.sparse.floats.CSRFloatMatrix;
import matrix4j.utils.lang.Preconditions;
import matrix4j.utils.lang.mutable.MutableInt;
import matrix4j.vector.VectorProcedure;

import java.util.Arrays;
import java.util.Comparator;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;

public final class MatrixUtils {

    private MatrixUtils() {}

    @Nonnull
    public static Matrix shuffle(@Nonnull final Matrix m, @Nonnull final int[] indices) {
        Preconditions.checkArgument(m.numRows() <= indices.length, "m.numRow() `" + m.numRows()
                + "` MUST be equals to or less than |swapIndices| `" + indices.length + "`");

        final MatrixBuilder builder = m.builder();
        final VectorProcedure proc = new VectorProcedure() {
            public void apply(int col, double value) {
                builder.nextColumn(col, value);
            }
        };
        for (int i = 0; i < indices.length; i++) {
            int idx = indices[i];
            m.eachNonNullInRow(idx, proc);
            builder.nextRow();
        }
        return builder.buildMatrix();
    }

    /**
     * Returns the index of maximum value of an array.
     * 
     * @return -1 if there are no columns
     */
    public static int whichMax(@Nonnull final IntMatrix matrix, @Nonnegative final int row) {
        final MutableInt m = new MutableInt(Integer.MIN_VALUE);
        final MutableInt which = new MutableInt(-1);
        matrix.eachInRow(row, new VectorProcedure() {
            @Override
            public void apply(int i, int value) {
                if (value > m.getValue()) {
                    m.setValue(value);
                    which.setValue(i);
                }
            }
        }, false);
        return which.getValue();
    }

    /**
     * @param data non-zero entries
     */
    @Nonnull
    public static CSRMatrix coo2csr(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final double[] data, @Nonnegative final int numRows,
            @Nonnegative final int numCols, final boolean sortColumns) {
        final int nnz = data.length;
        Preconditions.checkArgument(rows.length == nnz);
        Preconditions.checkArgument(cols.length == nnz);

        final int[] rowPointers = new int[numRows + 1];
        final int[] colIndices = new int[nnz];
        final double[] values = new double[nnz];

        coo2csr(rows, cols, data, rowPointers, colIndices, values, numRows, numCols, nnz);

        if (sortColumns) {
            sortIndices(rowPointers, colIndices, values);
        }
        return new CSRMatrix(rowPointers, colIndices, values, numCols);
    }

    /**
     * @param data non-zero entries
     */
    @Nonnull
    public static CSRFloatMatrix coo2csr(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final float[] data, @Nonnegative final int numRows,
            @Nonnegative final int numCols, final boolean sortColumns) {
        final int nnz = data.length;
        Preconditions.checkArgument(rows.length == nnz);
        Preconditions.checkArgument(cols.length == nnz);

        final int[] rowPointers = new int[numRows + 1];
        final int[] colIndices = new int[nnz];
        final float[] values = new float[nnz];

        coo2csr(rows, cols, data, rowPointers, colIndices, values, numRows, numCols, nnz);

        if (sortColumns) {
            sortIndices(rowPointers, colIndices, values);
        }
        return new CSRFloatMatrix(rowPointers, colIndices, values, numCols);
    }

    @Nonnull
    public static CSCMatrix coo2csc(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final double[] data, @Nonnegative final int numRows,
            @Nonnegative final int numCols, final boolean sortRows) {
        final int nnz = data.length;
        Preconditions.checkArgument(rows.length == nnz);
        Preconditions.checkArgument(cols.length == nnz);

        final int[] columnPointers = new int[numCols + 1];
        final int[] rowIndices = new int[nnz];
        final double[] values = new double[nnz];

        coo2csr(cols, rows, data, columnPointers, rowIndices, values, numCols, numRows, nnz);

        if (sortRows) {
            sortIndices(columnPointers, rowIndices, values);
        }
        return new CSCMatrix(columnPointers, rowIndices, values, numRows, numCols);
    }

    @Nonnull
    public static CSCFloatMatrix coo2csc(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final float[] data, @Nonnegative final int numRows,
            @Nonnegative final int numCols, final boolean sortRows) {
        final int nnz = data.length;
        Preconditions.checkArgument(rows.length == nnz);
        Preconditions.checkArgument(cols.length == nnz);

        final int[] columnPointers = new int[numCols + 1];
        final int[] rowIndices = new int[nnz];
        final float[] values = new float[nnz];

        coo2csr(cols, rows, data, columnPointers, rowIndices, values, numCols, numRows, nnz);

        if (sortRows) {
            sortIndices(columnPointers, rowIndices, values);
        }

        return new CSCFloatMatrix(columnPointers, rowIndices, values, numRows, numCols);
    }

    private static void coo2csr(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final double[] data, @Nonnull final int[] rowPointers,
            @Nonnull final int[] colIndices, @Nonnull final double[] values,
            @Nonnegative final int numRows, @Nonnegative final int numCols, final int nnz) {
        // compute nnz per for each row to get rowPointers
        for (int n = 0; n < nnz; n++) {
            rowPointers[rows[n]]++;
        }
        for (int i = 0, sum = 0; i < numRows; i++) {
            int curr = rowPointers[i];
            rowPointers[i] = sum;
            sum += curr;
        }
        rowPointers[numRows] = nnz;

        // copy cols, data to colIndices, csrValues
        for (int n = 0; n < nnz; n++) {
            int row = rows[n];
            int dst = rowPointers[row];

            colIndices[dst] = cols[n];
            values[dst] = data[n];

            rowPointers[row]++;
        }

        for (int i = 0, last = 0; i <= numRows; i++) {
            int tmp = rowPointers[i];
            rowPointers[i] = last;
            last = tmp;
        }
    }

    private static void coo2csr(@Nonnull final int[] rows, @Nonnull final int[] cols,
            @Nonnull final float[] data, @Nonnull final int[] rowPointers,
            @Nonnull final int[] colIndices, @Nonnull final float[] values,
            @Nonnegative final int numRows, @Nonnegative final int numCols, final int nnz) {
        // compute nnz per for each row to get rowPointers
        for (int n = 0; n < nnz; n++) {
            rowPointers[rows[n]]++;
        }
        for (int i = 0, sum = 0; i < numRows; i++) {
            int curr = rowPointers[i];
            rowPointers[i] = sum;
            sum += curr;
        }
        rowPointers[numRows] = nnz;

        // copy cols, data to colIndices, csrValues
        for (int n = 0; n < nnz; n++) {
            int row = rows[n];
            int dst = rowPointers[row];

            colIndices[dst] = cols[n];
            values[dst] = data[n];

            rowPointers[row]++;
        }

        for (int i = 0, last = 0; i <= numRows; i++) {
            int tmp = rowPointers[i];
            rowPointers[i] = last;
            last = tmp;
        }
    }

    private static void sortIndices(@Nonnull final int[] majorAxisPointers,
            @Nonnull final int[] minorAxisIndices, @Nonnull final double[] values) {
        final int numRows = majorAxisPointers.length - 1;
        if (numRows <= 1) {
            return;
        }

        for (int i = 0; i < numRows; i++) {
            final int rowStart = majorAxisPointers[i];
            final int rowEnd = majorAxisPointers[i + 1];

            final int numCols = rowEnd - rowStart;
            if (numCols == 0) {
                continue;
            } else if (numCols < 0) {
                throw new IllegalArgumentException(
                    "numCols SHOULD be greater than zero. numCols = rowEnd - rowStart = " + rowEnd
                            + " - " + rowStart + " = " + numCols + " at i=" + i);
            }

            final IntDoublePair[] pairs = new IntDoublePair[numCols];
            for (int jj = rowStart, n = 0; jj < rowEnd; jj++, n++) {
                pairs[n] = new IntDoublePair(minorAxisIndices[jj], values[jj]);
            }

            Arrays.sort(pairs, new Comparator() {
                @Override
                public int compare(IntDoublePair x, IntDoublePair y) {
                    return Integer.compare(x.key, y.key);
                }
            });

            for (int jj = rowStart, n = 0; jj < rowEnd; jj++, n++) {
                IntDoublePair tmp = pairs[n];
                minorAxisIndices[jj] = tmp.key;
                values[jj] = tmp.value;
            }
        }
    }

    private static void sortIndices(@Nonnull final int[] majorAxisPointers,
            @Nonnull final int[] minorAxisIndices, @Nonnull final float[] values) {
        final int numRows = majorAxisPointers.length - 1;
        if (numRows <= 1) {
            return;
        }

        for (int i = 0; i < numRows; i++) {
            final int rowStart = majorAxisPointers[i];
            final int rowEnd = majorAxisPointers[i + 1];

            final int numCols = rowEnd - rowStart;
            if (numCols == 0) {
                continue;
            } else if (numCols < 0) {
                throw new IllegalArgumentException(
                    "numCols SHOULD be greater than or equal to zero. numCols = rowEnd - rowStart = "
                            + rowEnd + " - " + rowStart + " = " + numCols + " at i=" + i);
            }

            final IntFloatPair[] pairs = new IntFloatPair[numCols];
            for (int jj = rowStart, n = 0; jj < rowEnd; jj++, n++) {
                pairs[n] = new IntFloatPair(minorAxisIndices[jj], values[jj]);
            }

            Arrays.sort(pairs, new Comparator() {
                @Override
                public int compare(IntFloatPair x, IntFloatPair y) {
                    return Integer.compare(x.key, y.key);
                }
            });

            for (int jj = rowStart, n = 0; jj < rowEnd; jj++, n++) {
                IntFloatPair tmp = pairs[n];
                minorAxisIndices[jj] = tmp.key;
                values[jj] = tmp.value;
            }
        }
    }

    private static final class IntDoublePair {

        final int key;
        final double value;

        IntDoublePair(int key, double value) {
            this.key = key;
            this.value = value;
        }
    }

    private static final class IntFloatPair {

        final int key;
        final float value;

        IntFloatPair(int key, float value) {
            this.key = key;
            this.value = value;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy