/*!
 * \file division.cpp
 * 
 * \brief this file provides the functions for devisions
 * 
 * Well, I could write something smart here, but on the other
 * hand you also could look it up at
 * <a href="http://en.wikipedia.org/wiki/Division_%28mathematics%29">
 * Wikipedia</a>.
 */



/*!
 * \brief calculates the result of a division of two input numbers
 *
 * \return success of the division
 * \retval true division succeeded
 * \retval false division failed
 */
bool division(double divident,   //!< [in]   a in c = a/b
              double divisor,    //!< [in]   b in c = a/b
              double & quotient) //!< [out]  c in c = a/b
{
	/*!
	 * - if the divisor equals zero <b>return false</b>
	 */
	if(divisor == 0)
	{
		return false;
	}
	
	/*!
	 * - hard work: calculate quotient
	 */
	quotient = divident / divisor;
	
	/*!
	 * - division succeeded: <b>return true</b>
	 */
	
	return true;
}