ltiMultScalar.h

/*
 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 * This file is part of the LTI-Computer Vision Library (LTI-Lib)
 *
 * The LTI-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License (LGPL)
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * The LTI-Lib 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 the LTI-Lib; see the file LICENSE.  If
 * not, write to the Free Software Foundation, Inc., 59 Temple Place -
 * Suite 330, Boston, MA 02111-1307, USA.
 */


/*----------------------------------------------------------------
 * project ....: LTI Digital Image/Signal Processing Library
 * file .......: ltiMultScalar.h
 * authors ....: Thomas Rusert
 * organization: LTI, RWTH Aachen
 * creation ...: 20.04.99
 * revisions ..: $Id: ltiMultScalar.h,v 1.4 2007/01/10 02:26:22 alvarado Exp $
 */

#ifndef _LTI_MULTSCALAR_H_
#define _LTI_MULTSCALAR_H_

#include "ltiScalarFunctor.h"

namespace lti {
  /** 
   * Multiply by Scalar functor class.
   *
   * apply() multiplies each element of the mathObj by the given scalar value.
   */
  template<class T>
  class multiplyScalar : public scalarFunctor<T> {
  public:

    typedef typename scalarFunctor<T>::parameters parameters;

    /// default constructor, sets the scalar value to 0
    multiplyScalar() {};

    /// constructor, sets the scalar value.
    multiplyScalar(const T theValue) : scalarFunctor<T>(theValue) {};

    /// constructor, sets the parameters, i.e. the scalar value.
    multiplyScalar(const parameters& theParams)
      :scalarFunctor<T>(theParams) {};

    /// destructor
    virtual ~multiplyScalar();

    /** onPlace version of apply.
        applies the functor's function to 'theObject'. */
    virtual vector<T>& apply(vector<T>& theObject) const;

    /** onCopy version of apply.
        applies the functor's function to the copy of 'theObject',
        'newObject'. */
    virtual vector<T>& apply(const vector<T>& theObject,
                                   vector<T>& newObject) const;

    /** onPlace version of apply.
        applies the functor's function to 'theObject'. */
    virtual matrix<T>& apply(matrix<T>& theObject) const;

    /** onCopy version of apply.
        applies the functor's function to the copy of 'theObject',
        'newObject'. */
    virtual matrix<T>& apply(const matrix<T>& theObject,
                                   matrix<T>& newObject) const;

    /// returns a pointer to a clone of the functor.
    virtual functor* clone() const;

    /// returns the name of this type
    virtual const char* getTypeName() const;
  };
}

#include "ltiMultScalar_template.h"

#endif