cvrRound.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   cvrRound.h
 *         Definition of some usually used global functions for
 *         mathematical rounding (round, iround, lround and cround_cast)
 * \author Pablo Alvarado
 * \date   28.04.1999
 *
 * $Id: cvrRound.h,v 1.3 2004/07/27 08:22:42 alvarado Exp $
 */

#ifndef _CVR_ROUND_H_
#define _CVR_ROUND_H_

namespace cvr {

  /**
   * Round any float type mathematicly
   *
   * @ingroup gBasicMathFunc
   */
  template<typename T>
  inline T round(T x);

  /**
   * Round any float type mathematicly and return an integer
   *
   * @ingroup gBasicMathFunc
   */
  template<typename T>
  inline int iround(T x);

  /**
   * Round any float type mathematicly and return an long integer
   *
   * @ingroup gBasicMathFunc
   */
  template<typename T>
  inline long lround(T x);

  /**
   * Conditional round cast.
   *
   * This template functions cast the given value using rounding if necessary.
   * This means, if you cast between different floating point types, no
   * integer rounding will be done, but if you cast from a floating point
   * value to an integer value, the result will be rounded.  For example:
   *
   * \code
   * int i   = cround_cast<int>(3.6); // i will contain 4
   * float f = cround_cast<float>(3.6); // i will contain 3.6f
   * \endcode
   *
   * This sort of casting is used in the implementation of several template
   * functions where the output type depends on the current instantiation.
   */
  template<typename T,typename F>
  inline T cround_cast(const F from);

}

#include "cvrRound_inline.h"

#endif