org.ojalgo.matrix.store.LogicalStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojalgo Show documentation
oj! Algorithms - ojAlgo - is Open Source Java code that has to do with mathematics, linear algebra and optimisation.
There is a newer version: 55.0.1
/*
 * Copyright 1997-2021 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.store;

import java.util.concurrent.Future;

import org.ojalgo.concurrent.DaemonPoolExecutor;
import org.ojalgo.scalar.Scalar;
import org.ojalgo.structure.Access1D;

/**
 * Logical stores are (intended to be) immutable.
 *
 * @author apete
 */
abstract class LogicalStore> extends AbstractStore {

    private final MatrixStore myBase;
    private final Scalar myOne;
    private final Scalar myZero;

    protected LogicalStore(final MatrixStore base, final int rowsCount, final int columnsCount) {

        super(rowsCount, columnsCount);

        myBase = base;

        myZero = base.physical().scalar().zero();
        myOne = base.physical().scalar().one();
    }

    protected LogicalStore(final MatrixStore base, final long rowsCount, final long columnsCount) {
        this(base, Math.toIntExact(rowsCount), Math.toIntExact(columnsCount));
    }

    public PhysicalStore.Factory physical() {
        return myBase.physical();
    }

    protected final Future executeMultiply(final Access1D right, final TransformableRegion target) {
        return DaemonPoolExecutor.invoke(() -> myBase.multiply(right, target));
    }

    protected final Future> executeMultiply(final double scalar) {
        return DaemonPoolExecutor.invoke(() -> myBase.multiply(scalar));
    }

    protected final Future> executeMultiply(final MatrixStore right) {
        return DaemonPoolExecutor.invoke(() -> myBase.multiply(right));
    }

    protected final Future> executeMultiply(final N scalar) {
        return DaemonPoolExecutor.invoke(() -> myBase.multiply(scalar));
    }

    protected final Future executeMultiplyBoth(final Access1D leftAndRight) {
        return DaemonPoolExecutor.invoke(() -> myBase.multiplyBoth(leftAndRight));
    }

    protected final Future> executePremultiply(final Access1D left) {
        return DaemonPoolExecutor.invoke(() -> myBase.premultiply(left));
    }

    final MatrixStore base() {
        return myBase;
    }

    final Scalar one() {
        return myOne;
    }

    final Scalar zero() {
        return myZero;
    }

}