Template Function TRAP::Math::Log2(genType)#

Function Documentation#

template<typename genType>
constexpr genType TRAP::Math::Log2(genType x)#

Retrieve the base 2 logarithm of the parameter.

Log2 function is defined for input values of x defined in the range (0, inf+) in the limit of the type qualifier.

Parameters:

x – Specify the value of which to take the base 2 logarithm.

Returns:

Base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2^y.