Standard_Real.hxx File Reference

#include <algorithm>
#include <cmath>
#include <climits>
#include <float.h>
#include <Standard_TypeDef.hxx>

Functions
Use std::acos instead double	ACos (const double theValue)
	Returns the value of the arc cosine of a theValue.
double	ACosApprox (const double theValue)
	Returns the approximate value of the arc cosine theValue. The max error is about 1 degree near Value=0. NOTE: Avoid using this function in new code, it presumably slower then std::acos.
Use std::asin instead double	ASin (const double theValue)
	Returns the value of the arc sine of a theValue.
Use std::atan2 instead double	ATan2 (const double theX, const double theY)
	Computes the arc tangent of theX divided by theY using the signs of both arguments to determine the quadrant of the return value.
Use std::atanh instead double	ATanh (const double theValue)
	Returns the value of the hyperbolic arc tangent of theValue.
Use std::acosh instead double	ACosh (const double theValue)
	Returns the value of the hyperbolic arc cosine of theValue.
Use std::cosh instead double	Cosh (const double theValue)
	Returns the hyperbolic cosine of a double theValue.
Use std::sinh instead double	Sinh (const double theValue)
	Returns the hyperbolic sine of a double theValue.
Use std::log instead double	Log (const double theValue)
	Computes the natural (base-e) logarithm of number theValue.
Use std::sqrt instead double	Sqrt (const double theValue)
	Returns the square root of a double theValue.
This function duplicates std::nextafter and will be removed in future releases Use std::nextafter instead double	NextAfter (const double theValue, const double theDirection)
	Returns the next representable value of a double theValue in the direction of theDirection. Equivalent to std::nextafter.
This function duplicates std::copysign and will be removed in future releases Use std::copysign instead double	Sign (const double theMagnitude, const double theSign)
	Composes a floating point value with the magnitude of theMagnitude and the sign of theSign. Equivalent to std::copysign.
constexpr double	RealSmall ()
	Returns the minimum positive double value greater than zero.
Use std::abs instead double	Abs (const double theValue)
	Returns the absolute value of a double Value. Equivalent to std::abs.
bool	IsEqual (const double theValue1, const double theValue2)
	Returns Standard_True if two doubles are equal within the precision defined by RealSmall().
constexpr int	RealDigits ()
	Returns the number of digits of precision in a double.
constexpr double	RealEpsilon ()
	Returns the minimum positive double such that 1.0 + RealEpsilon() != 1.0.
constexpr double	RealFirst ()
	Returns the minimum value of a double.
constexpr int	RealFirst10Exp ()
	Returns the minimum value of exponent(base 10) of a double.
constexpr double	RealLast ()
	Returns the maximum value of a double.
constexpr int	RealLast10Exp ()
	Returns the maximum value of exponent(base 10) of a double.
constexpr int	RealMantissa ()
	Returns the size in bits of the mantissa part of a double.
constexpr int	RealRadix ()
	Returns the radix of a double.
constexpr int	RealSize ()
	Returns the size in bits of a double.
constexpr double	IntToReal (const int theValue)
	Converts a int theValue to a double.
Use std::atan instead double	ATan (const double theValue)
	Returns the value of the arc tangent of a double theValue.
Use std::ceil instead double	Ceiling (const double theValue)
	Returns the next integer greater than or equal to a double theValue.
Use std::cos instead double	Cos (const double theValue)
	Returns the cosine of a double theValue. Equivalent to std::cos.
double	Epsilon (const double theValue)
	The function returns absolute value of difference between theValue and other nearest value of double type. Nearest value is chosen in direction of infinity the same sign as theValue. If theValue is 0 then returns minimal positive value of double type.
Use std::exp instead double	Exp (const double theValue)
	Returns the exponential of a double theValue. Equivalent to std::exp.
Use std::floor instead double	Floor (const double theValue)
	Returns the nearest integer less than or equal to a double theValue. Equivalent to std::floor.
Use std::trunc instead double	IntegerPart (const double theValue)
	Returns the integer part of a double theValue. Equivalent to std::trunc.
Use std::log10 instead double	Log10 (const double theValue)
	Returns the logarithm to base 10 of a double theValue. Equivalent to std::log10.
Use std::max instead constexpr double	Max (const double theValue1, const double theValue2)
	Returns the maximum value of two doubles. Equivalent to std::max.
Use std::min instead constexpr double	Min (const double theValue1, const double theValue2)
	Returns the minimum value of two doubles. Equivalent to std::min.
Use std::pow instead double	Pow (const double theValue, const double thePower)
	Returns a double theValue raised to the power of thePower.
double	RealPart (const double theValue)
	Returns the fractional part of a double theValue. Always non-negative.
constexpr int	RealToInt (const double theValue)
	Converts a double theValue to the nearest valid int. If input value is out of valid range for int, minimal or maximal possible int is returned.
constexpr float	RealToShortReal (const double theValue)
	Converts a double theValue to the nearest valid float. If input value is out of valid range for float, minimal or maximal possible float is returned.
Use std::round instead double	Round (const double theValue)
	Returns the nearest integer of a double theValue. Equivalent to std::round.
Use std::sin instead double	Sin (const double theValue)
	Returns the sine of a double theValue. Equivalent to std::sin.
Use std::asinh instead double	ASinh (const double theValue)
	Returns the hyperbolic arc sine of a double theValue. Equivalent to std::asinh.
constexpr double	Square (const double theValue)
	Returns the square of a double theValue.
Use std::tan instead double	Tan (const double theValue)
	Returns the tangent of a double theValue. Equivalent to std::tan.
Use std::tanh instead double	Tanh (const double theValue)
	Returns the hyperbolic tangent of a double theValue. Equivalent to std::tanh.

Function Documentation

Abs()

Use std::abs instead double Abs ( const double theValue )

inline

Returns the absolute value of a double Value. Equivalent to std::abs.

Deprecated

("This function duplicates std::abs and will be removed in future releases. "

ACos()

Use std::acos instead double ACos ( const double theValue )

inline

Returns the value of the arc cosine of a theValue.

Deprecated

("This function duplicates std::acos and will be removed in future releases. "

ACosApprox()

double ACosApprox

(

const double

theValue

)

Returns the approximate value of the arc cosine theValue. The max error is about 1 degree near Value=0. NOTE: Avoid using this function in new code, it presumably slower then std::acos.

Deprecated

("Deprecated, use std::acos instead")

ACosh()

Use std::acosh instead double ACosh ( const double theValue )

inline

Returns the value of the hyperbolic arc cosine of theValue.

Deprecated

("This function duplicates std::acosh and will be removed in future releases. "

ASin()

Use std::asin instead double ASin ( const double theValue )

inline

Returns the value of the arc sine of a theValue.

Deprecated

("This function duplicates std::asin and will be removed in future releases. "

ASinh()

Use std::asinh instead double ASinh ( const double theValue )

inline

Returns the hyperbolic arc sine of a double theValue. Equivalent to std::asinh.

Deprecated

("This function duplicates std::asinh and will be removed in future releases. "

ATan()

Use std::atan instead double ATan ( const double theValue )

inline

Returns the value of the arc tangent of a double theValue.

Deprecated

("This function duplicates std::atan and will be removed in future releases. "

ATan2()

Use std::atan2 instead double ATan2 ( const double theX, const double theY )

inline

Computes the arc tangent of theX divided by theY using the signs of both arguments to determine the quadrant of the return value.

Deprecated

("This function duplicates std::atan2 and will be removed in future releases. "

ATanh()

Use std::atanh instead double ATanh ( const double theValue )

inline

Returns the value of the hyperbolic arc tangent of theValue.

Deprecated

("This function duplicates std::atanh and will be removed in future releases. "

Ceiling()

Use std::ceil instead double Ceiling ( const double theValue )

inline

Returns the next integer greater than or equal to a double theValue.

Deprecated

("This function duplicates std::ceil and will be removed in future releases. "

Cos()

Use std::cos instead double Cos ( const double theValue )

inline

Returns the cosine of a double theValue. Equivalent to std::cos.

Deprecated

("This function duplicates std::cos and will be removed in future releases. "

Cosh()

Use std::cosh instead double Cosh ( const double theValue )

inline

Returns the hyperbolic cosine of a double theValue.

Deprecated

("This function duplicates std::cosh and will be removed in future releases. "

Epsilon()

double Epsilon ( const double theValue )

inline

The function returns absolute value of difference between theValue and other nearest value of double type. Nearest value is chosen in direction of infinity the same sign as theValue. If theValue is 0 then returns minimal positive value of double type.

Exp()

Use std::exp instead double Exp ( const double theValue )

inline

Returns the exponential of a double theValue. Equivalent to std::exp.

Deprecated

("This function duplicates std::exp and will be removed in future releases. "

Floor()

Use std::floor instead double Floor ( const double theValue )

inline

Returns the nearest integer less than or equal to a double theValue. Equivalent to std::floor.

Deprecated

("This function duplicates std::floor and will be removed in future releases. "

IntegerPart()

Use std::trunc instead double IntegerPart ( const double theValue )

inline

Returns the integer part of a double theValue. Equivalent to std::trunc.

Deprecated

("This function duplicates std::trunc and will be removed in future releases. "

IntToReal()

constexpr double IntToReal ( const int theValue )

constexpr

Converts a int theValue to a double.

IsEqual()

bool IsEqual ( const double theValue1, const double theValue2 )

inline

Returns Standard_True if two doubles are equal within the precision defined by RealSmall().

Log()

Use std::log instead double Log ( const double theValue )

inline

Computes the natural (base-e) logarithm of number theValue.

Deprecated

("This function duplicates std::log and will be removed in future releases. "

Log10()

Use std::log10 instead double Log10 ( const double theValue )

inline

Returns the logarithm to base 10 of a double theValue. Equivalent to std::log10.

Deprecated

("This function duplicates std::log10 and will be removed in future releases. "

Max()

Use std::max instead constexpr double Max ( const double theValue1, const double theValue2 )

constexpr

Returns the maximum value of two doubles. Equivalent to std::max.

Deprecated

("This function duplicates std::max and will be removed in future releases. "

Min()

Use std::min instead constexpr double Min ( const double theValue1, const double theValue2 )

constexpr

Returns the minimum value of two doubles. Equivalent to std::min.

Deprecated

("This function duplicates std::min and will be removed in future releases. "

NextAfter()

This function duplicates std::nextafter and will be removed in future releases Use std::nextafter instead double NextAfter ( const double theValue, const double theDirection )

inline

Returns the next representable value of a double theValue in the direction of theDirection. Equivalent to std::nextafter.

Deprecated

(

Pow()

Use std::pow instead double Pow ( const double theValue, const double thePower )

inline

Returns a double theValue raised to the power of thePower.

Deprecated

("This function duplicates std::pow and will be removed in future releases. "

RealDigits()

constexpr int RealDigits ( )

constexpr

Returns the number of digits of precision in a double.

RealEpsilon()

constexpr double RealEpsilon ( )

constexpr

Returns the minimum positive double such that 1.0 + RealEpsilon() != 1.0.

RealFirst()

constexpr double RealFirst ( )

constexpr

Returns the minimum value of a double.

RealFirst10Exp()

constexpr int RealFirst10Exp ( )

constexpr

Returns the minimum value of exponent(base 10) of a double.

RealLast()

constexpr double RealLast ( )

constexpr

Returns the maximum value of a double.

RealLast10Exp()

constexpr int RealLast10Exp ( )

constexpr

Returns the maximum value of exponent(base 10) of a double.

RealMantissa()

constexpr int RealMantissa ( )

constexpr

Returns the size in bits of the mantissa part of a double.

RealPart()

double RealPart ( const double theValue )

inline

Returns the fractional part of a double theValue. Always non-negative.

RealRadix()

constexpr int RealRadix ( )

constexpr

Returns the radix of a double.

RealSize()

constexpr int RealSize ( )

constexpr

Returns the size in bits of a double.

RealSmall()

constexpr double RealSmall ( )

constexpr

Returns the minimum positive double value greater than zero.

RealToInt()

constexpr int RealToInt ( const double theValue )

constexpr

Converts a double theValue to the nearest valid int. If input value is out of valid range for int, minimal or maximal possible int is returned.

RealToShortReal()

constexpr float RealToShortReal ( const double theValue )

constexpr

Converts a double theValue to the nearest valid float. If input value is out of valid range for float, minimal or maximal possible float is returned.

Round()

Use std::round instead double Round ( const double theValue )

inline

Returns the nearest integer of a double theValue. Equivalent to std::round.

Deprecated

("This function duplicates std::round and will be removed in future releases. "

Sign()

This function duplicates std::copysign and will be removed in future releases Use std::copysign instead double Sign ( const double theMagnitude, const double theSign )

inline

Composes a floating point value with the magnitude of theMagnitude and the sign of theSign. Equivalent to std::copysign.

Deprecated

(

Sin()

Use std::sin instead double Sin ( const double theValue )

inline

Returns the sine of a double theValue. Equivalent to std::sin.

Deprecated

("This function duplicates std::sin and will be removed in future releases. "

Sinh()

Use std::sinh instead double Sinh ( const double theValue )

inline

Returns the hyperbolic sine of a double theValue.

Deprecated

("This function duplicates std::sinh and will be removed in future releases. "

Sqrt()

Use std::sqrt instead double Sqrt ( const double theValue )

inline

Returns the square root of a double theValue.

Deprecated

("This function duplicates std::sqrt and will be removed in future releases. "

Square()

constexpr double Square ( const double theValue )

constexpr

Returns the square of a double theValue.

Tan()

Use std::tan instead double Tan ( const double theValue )

inline

Returns the tangent of a double theValue. Equivalent to std::tan.

Deprecated

("This function duplicates std::tan and will be removed in future releases. "

Tanh()

Use std::tanh instead double Tanh ( const double theValue )

inline

Returns the hyperbolic tangent of a double theValue. Equivalent to std::tanh.

Deprecated

("This function duplicates std::tanh and will be removed in future releases. "