cvrDecompositionSolution.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrDecompositionSolution.h
 * \author Thomas Rusert
 * \date   02.06.1999
 *
 * $Id: cvrDecompositionSolution.h,v 1.1 2005/04/21 13:11:20 gquiros Exp $
 */

#ifndef _CVR_DECOMPOSITION_SOLUTION_H_
#define _CVR_DECOMPOSITION_SOLUTION_H_

#include "cvrLinearAlgebraFunctor.h"
#include "cvrMatrix.h"

namespace cvr {

  /**
   * Abstract base class for all lti linear equation system solution functors
   * using matrix decomposition to solve Ax=b.
   *
   * Methods to give the matrix A are provided.
   *
   * @ingroup gCVR-Lib FormatRequired
   */
  template<class T>
  class decompositionSolution : public linearAlgebraFunctor {

  public:
    /**
     * Parameters of class decompositionSolution
     */
    class parameters : public linearAlgebraFunctor::parameters {

    public:
      /**
       * Default constructor
       */
      parameters();

      /**
       * Copy constructor
       */
      parameters(const parameters& other);

      /**
       * Copy member.
       *
       * if the system-matrix of the other object is a normal matrix,
       * its contents will be copied to the system-matrix of this
       * parameters-object.  If the other system-matrix contains just
       * a reference to external data, then the system-matrix of this
       * object will contain the same reference to the data!  The
       * reason for this is to allow the use of this functor with huge
       * matrices without the need of duplication.  Use this data
       * referencing option carefully!
       */
      parameters& copy(const parameters& other);

      /**
       * Returns the name of this class.
       */
      const std::string& name() const;

      /**
       * Returns a pointer to a clone of the parameters.
       */
      virtual parameters* clone() const;

      /**
       * Returns a pointer to a new instance of the parameters.
       */
      virtual parameters* newInstance() const;

      // -------------------------------------------------------
      // the parameters
      // -------------------------------------------------------
    };

    /**
     * Default constructor
     */
    decompositionSolution();

    /**
     * Constructor, sets the matrix A
     */
    decompositionSolution(const matrix<T>& theMatrix);

    /**
     * Destructor
     */
    virtual ~decompositionSolution();

    /**
     * Returns the current parameters.
     */
    const parameters& getParameters() const;

    /**
     * Copy data of "other" functor.
     */
    decompositionSolution<T>& copy(const decompositionSolution<T>& other);

    /**
     * Returns the name of this class.
     */
    const std::string& name() const;

    /**
     * Use the given matrix as is.  
     *
     * This matrix will not be copied and you have to ensure that the given
     * instance exists as long as this functor uses it.
     */
    virtual bool use(matrix<T>& A);

    /**
     * Use the given matrix and take care of its memory management.
     *
     * The given matrix will be empty after calling this method.
     */
    virtual bool attach(matrix<T>& A);

    /**
     * Copy the given matrix for internal use.
     */
    virtual bool set(const matrix<T>& A);


  protected:
    /**
     * Matrix A.
     *
     * The linear system to be solved is Ax=b.
     *
     * Default value: empty matrix.
     */
    matrix<T> systemMatrix_;

    /**
     * Flag to indicate if the system matrix has been decomposed.
     */
    bool decomposed_;

    /**
     * Decomposed matrix.
     */
    matrix<T> dcmpMat_;
  };

}

#endif