cvrLinearAlgebraFunctor.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2004
 * 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   cvrLinearAlgebraFunctor.h
 *         Contains the class cvr::linearAlgebraFunctor which is the base
 *         class of all linear algebra functors and defines the global type
 *         cvr::integer
 * \author Thomas Rusert
 * \date   01.06.1999
 *
 * $Id: cvrLinearAlgebraFunctor.h,v 1.7 2006/09/07 11:43:53 doerfler Exp $
 */

#ifndef _CVR_LINEAR_ALGEBRA_FUNCTOR_H_
#define _CVR_LINEAR_ALGEBRA_FUNCTOR_H_

#include "cvrFunctor.h"

namespace cvr {

  /**
   * Type of integer as defined in f2c.h
   *
   * This is a type used to adapt different implementations of Fortran-C
   * adapters.
   */
  typedef _CVR_F2C_INTEGER integer;

  /**
   * Base class for all lti linear algebra functors.
   *
   * This class is abstract.
   *
   * @ingroup gLinearAlgebra
   */
  class linearAlgebraFunctor : public functor {
  public:

    /**
     * The parameters for the linear algebra functors
     */
    class parameters : public functor::parameters {
    public:
      /**
       * default constructor
       */
      parameters();

      /**
       * copy constructor
       * @param other the parameters object to be copied
       */
      parameters(const parameters& other);

      /**
       * destructor
       */
      virtual ~parameters();

      /**
       * copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& copy(const parameters& other);

      /**
       * Copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& operator=(const parameters& other);

      /**
       * Returns the name of this type
       */
      virtual 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;

      /**
       * Write the parameters in the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool write(ioHandler& handler,const bool complete=true) const;

      /**
       * Read the parameters from the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool read(ioHandler& handler,const bool complete=true);

      //--------------------------------------------------
      // the parameters
      //--------------------------------------------------

      /**
       * Many linear algebra functors offer (besides the CVR-Lib 
       * implementation) to use LAPACK functions for solving a certain
       * problem. If you have LAPACK installed and configured the
       * CVR-Lib to make use of it (e.g. through changing a config
       * file or by just using autoconf) useLapack==true carries out
       * that implementation.
       *
       * If a linear algebra functor does not provide a LAPACK version
       * the setting of this parameter has no effect. Such
       * linearAlgebraFunctors should state that fact in their class
       * description.
       *
       * Since mostly LAPACK methods are faster that those provided in
       * the CVR-Lib the default is true whenever LAPACK was detected
       * and false otherwise. The latter really doesn't have any
       * effect but looks more informative.
       *
       * Sometimes it can be slower to use LAPACK because it uses
       * column-wise scanning of matrices while the CVR-Lib uses
       * rows. This comes from the predominant orientation in the two
       * programming languages (FORTRAN and C++). Thus, often it is
       * necessary to transpose data before and after using
       * LAPACK. For small problems this might be significant.
       *
       * Default: true if LAPACK is available, false otherwise
       */
      bool useLapack;

    };


    /**
     * Default constructor
     */
    linearAlgebraFunctor();

    /**
     * Construct a functor using the given parameters
     */
    linearAlgebraFunctor(const parameters& par);

    /**
     * Copy constructor
     * @param other the object to be copied
     */
    linearAlgebraFunctor(const linearAlgebraFunctor& other);

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

    /**
     * Copy data of "other" functor.
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    linearAlgebraFunctor& copy(const linearAlgebraFunctor& other);

    /**
     * Alias for copy member
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    linearAlgebraFunctor& operator=(const linearAlgebraFunctor& other);

    /**
     * Returns used parameters
     */
    const parameters& getParameters() const;
  };
}


#endif