com.powsybl.math.matrix.AbstractMatrix Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-math Show documentation

A set of mathematical utilities

The newest version!

/**
 * Copyright (c) 2017, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.math.matrix;

import com.powsybl.math.AbstractMathNative;

import java.util.Objects;

/**
 * Abstract class for matrix that provides an implementation for common methods.
 *
 * @author Geoffroy Jamgotchian {@literal }
 */
public abstract class AbstractMatrix extends AbstractMathNative implements Matrix {

    /**
     * Get value count.
     *
     * @return the value count
     */
    public abstract int getValueCount();

    /**
     * Check that row {@code i} and column {@code j} are in matrix bounds.
     *
     * @param i row index
     * @param j column index
     */
    protected void checkBounds(int i, int j) {
        if (i < 0 || i >= getRowCount()) {
            throw new MatrixException("Row index out of bound [0, " + (getRowCount() - 1) + "]");
        }
        if (j < 0 || j >= getColumnCount()) {
            throw new MatrixException("Column index out of bound [0, " + (getColumnCount() - 1) + "]");
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Matrix copy(MatrixFactory factory) {
        Objects.requireNonNull(factory);
        Matrix matrix = factory.create(getRowCount(), getColumnCount(), getValueCount());
        iterateNonZeroValue(matrix::set);
        return matrix;
    }

    @Override
    public Matrix add(Matrix other) {
        return add(other, 1d, 1d);
    }

    @Override
    public Matrix times(Matrix other) {
        return times(other, 1d);
    }
}