cvrMatrixProcessingInterface.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007
 * ITCR, Pablo Alvarado
 *
 *
 * 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   cvrMatrixProcessingInterface.h
 *         Simple interface from which all functors that process a matrix<T>
 *         to produce another matrix can be inherited.
 *
 * \author Pablo Alvarado
 * \date   23.09.2007
 *
 * revisions ..: $Id: cvrMatrixProcessingInterface.h,v 1.2 2007/10/07 03:17:16 alvarado Exp $
 */

#ifndef _CVR_MATRIX_PROCESSING_INTERFACE_H_
#define _CVR_MATRIX_PROCESSING_INTERFACE_H_

#include "cvrMatrix.h"
#include "cvrRGBAPixel.h"

namespace cvr {

  /**
   * Class matrixProcessingInterface
   *
   * Very simple interface to allow virtualization of classes that
   * transform a matrix into another one, like convolution, correlation,
   * matrixTransform, etc.
   *
   * Note that it is required that the apply methods do not alter the internal
   * state of the class.
   *
   * \ingroup gInterfaces
   */
  template<typename T>
  class matrixProcessingInterface {
  public:

    /**
     * Virtual destructor
     */
    virtual ~matrixProcessingInterface() {};

    /**
     * On-place processing apply.
     *
     * The inherited methods should take the \a srcdest matrix, process it in
     * some way, and on the same matrix leave the result.  No restrictions are
     * imposed on whether the memory block of the resulting matrix will be the
     * same that the one in the original matrix.  As a matter of fact, it
     * usually won't be.
     *
     * If you need to ensure the memory constancy, and assuming the resulting
     * matrix will always have the same size than the original one, then you
     * can use the following code:
     * \code
     * matrixProcessingInterfaceInheritedClass<T> theFunctor;
     * matrix<T> tmp;
     * theFunctor.apply(srcdest,tmp);
     * srcdest.fill(tmp)
     * \endcode
     *
     * which of course will be slower as it requires to copy all the data of
     * the result in the original matrix.
     *
     * @param srcdest matrix<T> with the source data. The result
     *                will be left here too.
     * @return true if apply successful or false otherwise.
     */
    virtual bool apply(matrix<T>& srcdest) const = 0;

    /**
     * On-copy processing apply.
     *
     * The inherited methods take the \a src matrix and process it leaving the
     * result in the \a dest matrix.
     *
     * @param src matrix<T> with the source data.
     * @param dest matrix<T> where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    virtual bool apply(const matrix<T>& src, matrix<T>& dest) const = 0;
  };
}

#endif