cern.colt.matrix.tfloat.algo.solver.preconditioner.FloatPreconditioner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parallelcolt Show documentation

Parallel Colt is a multithreaded version of Colt - a library for high performance scientific computing in Java. It contains efficient algorithms for data analysis, linear algebra, multi-dimensional arrays, Fourier transforms, statistics and histogramming.

The newest version!

/*
 * Copyright (C) 2003-2006 Bjørn-Ove Heimsund
 * 
 * This file is part of MTJ.
 * 
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package cern.colt.matrix.tfloat.algo.solver.preconditioner;

import cern.colt.matrix.tfloat.FloatMatrix1D;
import cern.colt.matrix.tfloat.FloatMatrix2D;

/**
 * Preconditioner interface. Before a preconditioner is used,
 * setMatrix must be called
 */
public interface FloatPreconditioner {

    /**
     * Solves the approximate problem with the given right hand side. Result is
     * stored in given solution vector
     * 
     * @param b
     *            Right hand side of problem
     * @param x
     *            Result is stored here
     * @return x
     */
    FloatMatrix1D apply(FloatMatrix1D b, FloatMatrix1D x);

    /**
     * Solves the approximate transpose problem with the given right hand side.
     * Result is stored in given solution vector
     * 
     * @param b
     *            Right hand side of problem
     * @param x
     *            Result is stored here
     * @return x
     */
    FloatMatrix1D transApply(FloatMatrix1D b, FloatMatrix1D x);

    /**
     * Sets the operator matrix for the preconditioner. This method must be
     * called before a preconditioner is used by an iterative solver
     * 
     * @param A
     *            Matrix to setup the preconditioner for. Not modified
     */
    void setMatrix(FloatMatrix2D A);

}