cvrUnivariateDiscreteDistribution.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   cvrUnivariateDiscreteDistribution.h
 *         Contains the class cvr::univariateDiscreteDistribution,
 *         parent of all univariate discrete random distributions.
 * \author Pablo Alvarado
 * \date   23.09.2007
 *
 * revisions ..: $Id: cvrUnivariateDiscreteDistribution.h,v 1.2 2007/09/28 00:06:17 alvarado Exp $
 */

#ifndef _CVR_UNIVARIATE_DISCRETE_DISTRIBUTION_H_
#define _CVR_UNIVARIATE_DISCRETE_DISTRIBUTION_H_

#include "cvrRandomDistribution.h"

namespace cvr {

  /**
   * Class univariateDiscreteDistribution
   *
   * All univariate continuous distributions return random numbers in a
   * floating point format.  This class establishes the basic interface to
   * allow virtual inheritance of the apply methods.
   *
   * @see univariateDiscreteDistribution::parameters.
   *
   * @ingroup gRandomDiscrete
   */
  class univariateDiscreteDistribution : public randomDistribution {
  public:
    /**
     * Default constructor
     */
    univariateDiscreteDistribution();

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

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

    /**
     * Get a random number.
     *
     * Returns a random number distributed accordingly to the type of the
     * current instance.
     *
     * The univariateDiscreteDistribution can be used to obtain numbers
     * in the interval [0,max()].
     *
     * @param rnd double reference where the random number has to be left.
     * @return true if apply successful or false otherwise.
     */
    virtual bool apply(int& rnd) = 0;

    /**
     * Virtual method to get a integer random number.
     *
     * Returns a random number distributed accordingly to the type of the
     * current instance.
     *
     * The univariateDiscreteDistribution can be used to obtain numbers
     * in the interval [0,max()], where max() is the method of this class.
     *
     * @return a random float number.
     */
    virtual int draw() = 0;

    /**
     * Non-virtual method to get a integer random number.
     *
     * Returns a random number distributed accordingly to the type of the
     * current instance.
     *
     * The univariateDiscreteDistribution can be used to obtain numbers
     * in the interval [0,max()], where max() is the method of this class.
     *
     * @return a random float number.
     */
    int rand();

    /**
     * Virtual method to obtain the maximum possible number
     * (inclusive) to be returned by this distribution
     */
    virtual int max() const = 0;

    /**
     * Virtual method to obtain the minimum possible number
     * (inclusive) to be returned by this distribution.
     */
    virtual int min() const = 0;

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

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

  };
}

#endif