//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
{
/**
* @class Math
- * @brief This class is the wrapper class for %Math Library.
+ * @brief This class is the wrapper class for the %Math Library.
*
* @since 2.0
*
static int Abs(int x);
/**
- * Gets the arc sine of the specified @c double integer. @n
+ * Gets the arc sine of the specified @c double integer. @n
* Returns a value between @c -PI/2 and @c PI/2.
*
* @since 2.0
*
* @return The arc sine of the input, @n
- * else Not-a-Number if @c x is out of range
+ * else Not-a-Number if @c x is out of the valid range
* @param[in] x A radian angle @n
- * It must be within the range @c -1 to @c 1 (inclusive).
+ * It must be within the range @c -1 to @c 1 (inclusive).
* @see Acos()
* @see Atan()
*/
static double Asin(double x);
/**
- * Gets the arc cosine of the specified double integer. @n
+ * Gets the arc cosine of the specified double integer. @n
* Returns a value between @c 0 and @c PI.
*
* @since 2.0
*
* @return The arc cosine of the input, @n
- * else Not-a-Number if @c x is out of range
+ * else Not-a-Number if @c x is out of the valid range
* @param[in] x A radian angle @n
- * It must be within the range @c -1 to @c 1 (inclusive).
+ * It must be within the range @c -1 to @c 1 (inclusive).
* @see Asin()
* @see Atan()
*/
static double Acos(double x);
/**
- * Gets the arc tangent of the specified @c double integer. @n
+ * Gets the arc tangent of the specified @c double integer. @n
* Returns a value between @c -PI/2 and @c PI/2.
*
* @since 2.0
*
* @return The arc tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Asin()
* @see Acos()
*/
* @since 2.0
*
* @return The smallest integer that is greater than or equal to the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Ceiling(double x);
/**
- * Gets the cosine of the specified @c double integer. @n
+ * Gets the cosine of the specified @c double integer. @n
* Returns a value between @c -1 and @c 1.
*
* @since 2.0
*
- * @return The cosine of the input
+ * @return The cosine of the input
* @param[in] x A radian angle
* @see Sin()
* @see Tan()
static double Cos(double x);
/**
- * Gets the hyperbolic cosine of the specified @c double integer.
+ * Gets the hyperbolic cosine of the specified @c double integer.
*
* @since 2.0
*
static double Cosh(double x);
/**
- * Gets the exponential value of the specified @c double integer.
+ * Gets the exponential value of the specified @c double integer.
*
* @since 2.0
*
* @return The exponential value of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Exp(double x);
* @since 2.0
*
* @return The largest @c double integer that is less than or equal to the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Floor(double x);
* @since 2.0
*
* @return The natural logarithm of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Log(double x);
* @since 2.0
*
* @return The logarithm to the base 10 of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Log10(double x);
* @since 2.0
*
* @return The greater of the two integer values
- * @param[in] x An integer value
- * @param[in] y An integer value
+ * @param[in] x An integer value
+ * @param[in] y An integer value
* @see Min()
*/
static int Max(int x, int y);
* @since 2.0
*
* @return The greater of the two floating point values
- * @param[in] x A floating point value
- * @param[in] y A floating point value
- * @see Min()
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
+ * @see Min()
*/
static double Max(double x, double y);
* @since 2.0
*
* @return The smaller of the two integer values
- * @param[in] x An integer value
- * @param[in] y An integer value
+ * @param[in] x An integer value
+ * @param[in] y An integer value
* @see Max()
*/
static int Min(int x, int y);
* @since 2.0
*
* @return The smaller of the two @c double values
- * @param[in] x A floating point value
- * @param[in] y A floating point value
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
* @see Max()
*/
static double Min(double x, double y);
* @since 2.0
*
* @return @c x raised to the power of @c y, @n
- * else Not-a-Number if @c x and @c y do not satisfy the conditions described below
- * @param[in] x A floating point value
- * @param[in] y A floating point value
- * @remarks @li @c x cannot be negative if @c y is a fractional value.
- * @li @c x cannot be @c 0 if @c y is less than or equal to @c 0.
+ * else Not-a-Number if @c x and @c y do not satisfy the conditions described below
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
+ * @remarks
+ * - @li @c x cannot be negative if @c y is a fractional value.
+ * - @li @c x cannot be @c 0 if @c y is less than or equal to @c 0.
*/
static double Pow(double x, double y);
* @since 2.0
*
* @return The closest integer to the specified input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Round(double x);
/**
- * Gets the sine of the specified @c double integer. @n
+ * Gets the sine of the specified @c double integer. @n
* Returns a value between @c -1 and @c 1.
*
* @since 2.0
*
* @return The sine of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Cos()
* @see Tan()
*/
static double Sin(double x);
/**
- * Gets the hyperbolic sine of the specified @c double integer.
+ * Gets the hyperbolic sine of the specified @c double integer.
*
* @since 2.0
*
* @return The hyperbolic sine of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
*/
static double Sinh(double x);
* @since 2.0
*
* @return The square root of the input, @n
- * else Not-a-Number if @c x is a negative number
- * @param[in] x A non-negative floating point value
+ * else Not-a-Number if @c x is a negative number
+ * @param[in] x A non-negative floating point value
*/
static double Sqrt(double x);
/**
- * Gets the tangent of the specified @c double integer.
+ * Gets the tangent of the specified @c double integer.
*
* @since 2.0
*
* @return The tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Sin()
* @see Cos()
*/
* @since 2.0
*
* @return The hyperbolic tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
*/
static double Tanh(double x);
*
* @since 2.0
*
- * @param[in] seed An integer value to use as seed by the pseudo-random number generator algorithm
+ * @param[in] seed The integer value used as a seed by the pseudo-random number generator algorithm
* @see Rand()
*/
static void Srand(unsigned int seed);
*
* @since 2.0
*
- * @return An integer value between @c 0 and @c RAND_VALUE_MAX
+ * @return The integer value between @c 0 and @c RAND_VALUE_MAX
* @remarks This method uses a seed to generate the pseudo-random numbers, that must be initialized to some distinctive value using Srand().
* @see Srand()
*/
static int Rand(void);
/**
- * Gets the constant value of E (the base of natural logarithms).
+ * Gets the constant value of E (the base of natural logarithms).
*
* @since 2.0
*
static const double GetE(void);
/**
- * Gets the constant value of PI.
+ * Gets the constant value of PI.
*
* @since 2.0
*
static const double GetPi(void);
/**
- * The maximum value that can be returned by the Rand() method.
- *
- * @since 2.0
- */
+ * The maximum value that can be returned by the Rand() method.
+ *
+ * @since 2.0
+ */
static const int RAND_VALUE_MAX = 32767; // 0x7fff