Function tskit::bindings::tsk_is_unknown_time
source · pub unsafe extern "C" fn tsk_is_unknown_time(val: f64) -> bool
Expand description
@brief Check if a number is TSK_UNKNOWN_TIME
@rst
Unknown time values in tskit are represented by a particular NaN value. Since NaN values
are not equal to each other by definition, a simple comparison like
mutation.time == TSK_UNKNOWN_TIME
will fail even if the mutation’s time is
TSK_UNKNOWN_TIME. This function compares the underlying bit representation of a double
value and returns true iff it is equal to the specific NaN value
:c:macro:TSK_UNKNOWN_TIME
.
@endrst
@param val The number to check
@return true if the number is TSK_UNKNOWN_TIME
else false