org.ojalgo.matrix.decomposition.GenericDecomposition 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.decomposition;

import org.ojalgo.array.BasicArray;
import org.ojalgo.function.FunctionSet;
import org.ojalgo.function.aggregator.AggregatorSet;
import org.ojalgo.matrix.store.DiagonalStore;
import org.ojalgo.matrix.store.MatrixStore;
import org.ojalgo.matrix.store.PhysicalStore;
import org.ojalgo.matrix.transformation.Householder;
import org.ojalgo.matrix.transformation.Rotation;
import org.ojalgo.scalar.Scalar;
import org.ojalgo.structure.Access1D;
import org.ojalgo.structure.Access2D;
import org.ojalgo.structure.Structure2D;

/**
 * AbstractDecomposition
 *
 * @author apete
 */
abstract class GenericDecomposition> extends AbstractDecomposition {

    private final PhysicalStore.Factory> myFactory;

    protected GenericDecomposition(final DecompositionStore.Factory> factory) {

        super();

        myFactory = factory;
    }

    protected final AggregatorSet aggregator() {
        return myFactory.aggregator();
    }

    @Override
    protected final DecompositionStore allocate(final long numberOfRows, final long numberOfColumns) {
        return myFactory.make(numberOfRows, numberOfColumns);
    }

    protected final MatrixStore collect(final Access2D.Collectable> source) {
        if (source instanceof MatrixStore) {
            return (MatrixStore) source;
        }
        if (source instanceof Access2D) {
            return myFactory.makeWrapper((Access2D) source);
        }
        return source.collect(myFactory);
    }

    protected final DecompositionStore copy(final Access2D source) {
        return myFactory.copy(source);
    }

    @Override
    protected final FunctionSet function() {
        return myFactory.function();
    }

    protected final BasicArray makeArray(final int length) {
        return myFactory.array().make(length);
    }

    protected final > DiagonalStore.Builder makeDiagonal(final D mainDiag) {
        return DiagonalStore.builder(myFactory, mainDiag);
    }

    protected final DecompositionStore makeEye(final int numberOfRows, final int numberOfColumns) {
        return myFactory.makeEye(numberOfRows, numberOfColumns);
    }

    protected final Householder makeHouseholder(final int dimension) {
        return myFactory.makeHouseholder(dimension);
    }

    protected final MatrixStore makeIdentity(final int dimension) {
        return myFactory.makeIdentity(dimension);
    }

    protected final Rotation makeRotation(final int low, final int high, final double cos, final double sin) {
        return myFactory.makeRotation(low, high, cos, sin);
    }

    protected final Rotation makeRotation(final int low, final int high, final N cos, final N sin) {
        return myFactory.makeRotation(low, high, cos, sin);
    }

    protected final DecompositionStore makeZero(final int numberOfRows, final int numberOfColumns) {
        return myFactory.make(numberOfRows, numberOfColumns);
    }

    protected final DecompositionStore makeZero(final Structure2D shape) {
        return myFactory.make(shape);
    }

    @Override
    protected final Scalar.Factory scalar() {
        return myFactory.scalar();
    }

    protected final MatrixStore wrap(final Access2D source) {
        return myFactory.makeWrapper(source);
    }

}