org.ejml.sparse.ComputePermutation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ejml-core Show documentation

A fast and easy to use dense and sparse matrix linear algebra library written in Java.

The newest version!

/*
 * Copyright (c) 2020, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * 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 org.ejml.sparse;

import org.ejml.data.IGrowArray;
import org.ejml.data.Matrix;
import org.jetbrains.annotations.Nullable;

/**
 * @author Peter Abeles
 */
public abstract class ComputePermutation {

    protected @Nullable IGrowArray prow;
    protected @Nullable IGrowArray pcol;

    protected ComputePermutation( boolean hasRow, boolean hasCol ) {
        if (hasRow)
            prow = new IGrowArray();
        if (hasCol)
            pcol = new IGrowArray();
    }

    public abstract void process( T m );

    /**
     * Returns row permutation
     */
    public @Nullable IGrowArray getRow() {
        return prow;
    }

    /**
     * Returns column permutation
     */
    public @Nullable IGrowArray getColumn() {
        return pcol;
    }

    public boolean hasRowPermutation() {
        return prow != null;
    }

    public boolean hasColumnPermutation() {
        return pcol != null;
    }
}