org.ojalgo.matrix.Matrix2D Maven / Gradle / Ivy

Go to download
/*
 * Copyright 1997-2024 Optimatika
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.ojalgo.matrix;

import org.ojalgo.algebra.NormedVectorSpace;
import org.ojalgo.algebra.Operation;
import org.ojalgo.algebra.ScalarOperation;
import org.ojalgo.matrix.store.MatrixStore;
import org.ojalgo.scalar.Scalar;
import org.ojalgo.structure.Access2D;
import org.ojalgo.type.context.NumberContext;

/**
 * Definition of what's common to {@link BasicMatrix} and {@link MatrixStore}. At this point, at least, it is
 * not recommended to write any code in terms of this interface. It's relatively new, the definition may
 * change, and it may even be removed again.
 *
 * @author apete
 */
public interface Matrix2D, M extends Matrix2D>
        extends Access2D, Access2D.Aggregatable, NormedVectorSpace, Operation.Subtraction, Operation.Multiplication,
        ScalarOperation.Addition, ScalarOperation.Subtraction, ScalarOperation.Division {

    /**
     * @return true if the same size/shape and elements are equal to the given accuracy. norm of the
     *         difference between [this] and [another] is zero within the limits of [precision].
     */
    default boolean equals(final Access2D another, final NumberContext accuracy) {
        return Access2D.equals(this, another, accuracy);
    }

    /**
     * Extracts one element of this matrix as a Scalar.
     *
     * @param row A row index.
     * @param col A column index.
     * @return One matrix element as a Scalar.
     */
    Scalar toScalar(final int row, final int col);

    M transpose();

}