Constants.h file

Mathematical constants and related utility functions.

This file provides commonly used mathematical constants with machine precision, as well as utility functions for checking special values.

Namespaces

namespace Rodin: The Rodin library for finite element methods and shape optimization.
namespace Rodin::Math: Spatial arithmetic, matrix operations, and sparse linear algebra.

auto pi() -> Real constexpr: Returns the mathematical constant to machine precision.
auto epsilon() -> Real constexpr: Returns the machine epsilon for Real type.
auto zero() -> Real constexpr: Returns the value zero.
auto isZero(Real x) -> Boolean constexpr: Checks if a value is exactly zero.
auto one() -> Real constexpr: Returns the value one.
auto isOne(Real x) -> Boolean constexpr: Checks if a value is exactly one.

Returns the mathematical constant to machine precision.

Returns	The value of as a Real

The value of is the ratio of a circle's circumference to its diameter.

Returns the machine epsilon for Real type.

Returns	The machine epsilon value

Machine epsilon is the smallest positive number such that in floating-point arithmetic. It represents the upper bound on relative rounding error.

Returns the value zero.

Returns	The Real value

Checks if a value is exactly zero.

Parameters
x in	Value to check
Returns	True if , false otherwise

Performs an exact comparison with zero. For approximate comparisons near zero, consider using a tolerance based on epsilon().

Returns the value one.

Returns	The Real value

Checks if a value is exactly one.

Parameters
x in	Value to check
Returns	True if , false otherwise

Performs an exact comparison with one. For approximate comparisons, consider using a tolerance based on epsilon().