cvrValidator.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   cvrValidator.h
 *         Contains a class that checks the validity of the elements of
 *         matrices and vectors of floating point types (e.g. float and double). * \author Jochen Wickel
 * \date   05.12.2001
 *
 * $Id: cvrValidator.h,v 1.4 2005/01/03 16:17:52 alvarado Exp $
 */

#ifndef _CVR_VALIDATOR_H_
#define _CVR_VALIDATOR_H_


#include "cvrFunctor.h"
#include "cvrMatrix.h"
#include "cvrComplex.h"

namespace cvr {
  /**
   * Matrix and Vector validity check.
   *
   * Checks the validity of a matrix or vector with float or double
   * elements. A matrix is invalid, if it contains nan or inf elements.
   * Otherwise, it is assumed to be valid.
   *
   * @todo The pointer to functions are not a good idea, since it is
   *       not easily serializable.  We need a family of functors that can
   *       belong to a factory, which can then be easily serialized through
   *       their names.
   */
  class validator : public functor {
  public:

    /**
     * Type of a function that checks a single double value
     */
    typedef bool (doubleValidator)(double);

    /**
     * Type of a function that checks a single float value
     */
    typedef bool (floatValidator)(float);

    /**
     * The parameters for the class validator
     */
    class parameters : public functor::parameters {
    public:
      /**
       * Default constructor
       */
      parameters();

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

      /**
       * Destructor
       */
      ~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 class.
       */
      virtual const std::string& name() const;

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

      /**
       * Returns a pointer to a clone of the parameters
       */
      virtual functor::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
      // ------------------------------------------------

      /**
       * Pointer to a C function or a static member function that
       * evaluates if a value is a valid floating point representation
       * for the double type.
       *
       * Default value: defaultValidateDouble()
       */
      doubleValidator* isDoubleValid;

      /**
       * Pointer to a C function or a static member function that
       * evaluates if a value is a valid floating point representation
       * for the float type.
       *
       * Default value: defaultValidateFloat()
       */
      floatValidator* isFloatValid;

      /**
       * Default function to check the validity of a double value
       */
      static bool defaultValidateDouble(double x);

      /**
       * Default function to check the validity of a float value
       */
      static bool defaultValidateFloat(float x);

    };

    /**
     * Default constructor
     */
    validator();

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

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

    /**
     * Operates on the given %parameter.
     * @param src vector<double> with the source data.
     * @return true if the vector is valid or false otherwise.
     */
    bool apply(const vector<double>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src vector<float> with the source data.
     * @return true if the vector is valid or false otherwise.
     */
    bool apply(const vector<float>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src vector<double> with the source data.
     * @return true if the vector is valid or false otherwise.
     */
    bool apply(const vector<dcomplex>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src vector<float> with the source data.
     * @return true if the vector is valid or false otherwise.
     */
    bool apply(const vector<fcomplex>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src matrix<double> with the source data.
     * @return true if the matrix is valid or false otherwise.
     */
    bool apply(const matrix<double>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src matrix<float> with the source data.
     * @return true if the matrix is valid  or false otherwise.
     */
    bool apply(const matrix<float>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src matrix<double> with the source data.
     * @return true if the matrix is valid or false otherwise.
     */
    bool apply(const matrix<dcomplex>& src) const;

    /**
     * Operates on the given %parameter.
     * @param src matrix<float> with the source data.
     * @return true if the matrix is valid  or false otherwise.
     */
    bool apply(const matrix<fcomplex>& src) const;

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

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

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

    /**
     * Returns a pointer to a clone of this functor.
     */
    virtual functor* clone() const;

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

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

#endif