Standard_Integer.hxx File Reference

#include <Standard_Std.hxx>
#include <Standard_TypeDef.hxx>
#include <algorithm>
#include <climits>
#include <cmath>

Functions
constexpr int	Abs (const int theValue)
	Returns the absolute value of a int Value. Equivalent to std::abs.
constexpr bool	IsEven (const int theValue)
	Returns true if theValue is even.
constexpr bool	IsOdd (const int theValue)
	Returns true if theValue is odd.
Use std::max instead constexpr int	Max (const int theValue1, const int theValue2)
	Returns the maximum value of two integers. Equivalent to std::max.
Use std::min instead constexpr int	Min (const int theValue1, const int theValue2)
	Returns the minimum value of two integers. Equivalent to std::min.
constexpr int	Modulus (const int theValue, const int theDivisor)
	Returns the modulus of theValue by theDivisor.
constexpr int	Square (const int theValue)
	Returns the square of a int theValue. Note that behavior is undefined in case of overflow.
constexpr int	IntegerFirst ()
	Returns the minimum value of an integer.
constexpr int	IntegerLast ()
	Returns the maximum value of an integer.
constexpr int	IntegerSize ()
	Returns the size in bits of an integer.

Function Documentation

Abs()

int Abs ( const int theValue )

nodiscardconstexpr

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

IntegerFirst()

int IntegerFirst ( )

nodiscardconstexpr

Returns the minimum value of an integer.

IntegerLast()

int IntegerLast ( )

nodiscardconstexpr

Returns the maximum value of an integer.

IntegerSize()

int IntegerSize ( )

nodiscardconstexpr

Returns the size in bits of an integer.

IsEven()

bool IsEven ( const int theValue )

nodiscardconstexpr

Returns true if theValue is even.

IsOdd()

bool IsOdd ( const int theValue )

nodiscardconstexpr

Returns true if theValue is odd.

Max()

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

constexpr

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

Deprecated

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

Min()

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

constexpr

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

Deprecated

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

Modulus()

int Modulus ( const int theValue, const int theDivisor )

nodiscardconstexpr

Returns the modulus of theValue by theDivisor.

Square()

int Square ( const int theValue )

nodiscardconstexpr

Returns the square of a int theValue. Note that behavior is undefined in case of overflow.