Rename atomic_wait functions to atomic_wait_value_equal

Updated the function names from `atomic_wait_value`, `atomic_wait_value_for`, and `atomic_wait_value_until` to `atomic_wait_value_equal`, `atomic_wait_value_equal_for`, and `atomic_wait_value_equal_until` respectively. This change clarifies the function's purpose and improves readability.

Author: beached

include/daw/daw_atomic_wait.h

@@ -286,9 +286,9 @@ namespace daw {
 	 * @param order The memory order to use. Defaults to
 	 * `std::memory_order_acquire`.
 	 */
-	void
-	atomic_wait_value( std::atomic<T> const *object, T const &desired_value,
-	                   std::memory_order order = std::memory_order_acquire ) {
+	void atomic_wait_value_equal(
+	  std::atomic<T> const *object, T const &desired_value,
+	  std::memory_order order = std::memory_order_acquire ) {
 		atomic_wait_if(
 		  object,
 		  [&desired_value]( T const &current_value ) {
@@ -320,10 +320,10 @@ namespace daw {
 	 * or a timeout occurred.
 	 */
 	template<typename T, typename Rep, typename Period>
-	[[nodiscard]] wait_status
-	atomic_wait_value_for( std::atomic<T> const *object, T const &desired_value,
-	                       std::chrono::duration<Rep, Period> const &rel_time,
-	                       std::memory_order order = std::memory_order_acquire ) {
+	[[nodiscard]] wait_status atomic_wait_value_equal_for(
+	  std::atomic<T> const *object, T const &desired_value,
+	  std::chrono::duration<Rep, Period> const &rel_time,
+	  std::memory_order order = std::memory_order_acquire ) {
 		return atomic_wait_if_for(
 		  object,
 		  [&desired_value]( T const &current_value ) {
@@ -355,7 +355,7 @@ namespace daw {
 	 * or a timeout occurred.
 	 */
 	template<typename T, typename Clock, typename Duration>
-	[[nodiscard]] wait_status atomic_wait_value_until(
+	[[nodiscard]] wait_status atomic_wait_value_equal_until(
 	  std::atomic<T> const *object, T const &desired_value,
 	  std::chrono::time_point<Clock, Duration> const &timeout_time,
 	  std::memory_order order = std::memory_order_acquire ) {

tests/daw_atomic_wait_test.cpp

@@ -18,7 +18,7 @@ using namespace std::chrono_literals;
 
 DAW_ATTRIB_NOINLINE void test_atomic_wait_value_until_timeout( ) {
 	auto value = std::atomic<int>{ };
-	auto result = daw::atomic_wait_value_until(
+	auto result = daw::atomic_wait_value_equal_until(
 	  &value, 42, std::chrono::system_clock::now( ) + 30ms );
 	daw_ensure( result == daw::wait_status::timeout );
 	daw_ensure( value == 0 );
@@ -32,7 +32,7 @@ DAW_ATTRIB_NOINLINE void test_atomic_wait_value_until_no_timeout( ) {
 		value = 42;
 		std::atomic_notify_one( &value );
 	} );
-	auto const result = daw::atomic_wait_value_until(
+	auto const result = daw::atomic_wait_value_equal_until(
 	  &value, 42, std::chrono::system_clock::now( ) + 1min );
 	th.join( );
 	daw_ensure( result == daw::wait_status::found );
@@ -41,7 +41,7 @@ DAW_ATTRIB_NOINLINE void test_atomic_wait_value_until_no_timeout( ) {
 
 DAW_ATTRIB_NOINLINE void test_atomic_wait_value_for_timeout( ) {
 	auto value = std::atomic<int>{ };
-	auto result = daw::atomic_wait_value_for( &value, 42, 30ms );
+	auto result = daw::atomic_wait_value_equal_for( &value, 42, 30ms );
 	daw_ensure( result == daw::wait_status::timeout );
 	daw_ensure( value == 0 );
 }
@@ -54,15 +54,15 @@ DAW_ATTRIB_NOINLINE void test_atomic_wait_value_for_no_timeout( ) {
 		value = 42;
 		std::atomic_notify_one( &value );
 	} );
-	auto const result = daw::atomic_wait_value_for( &value, 42, 1min );
+	auto const result = daw::atomic_wait_value_equal_for( &value, 42, 1min );
 	th.join( );
 	daw_ensure( result == daw::wait_status::found );
 	daw_ensure( value == 42 );
 }
 
 DAW_ATTRIB_NOINLINE void test_atomic_wait_value_already_set( ) {
 	auto value = std::atomic<int>{ 42 };
-	daw::atomic_wait_value( &value, 42 );
+	daw::atomic_wait_value_equal( &value, 42 );
 	daw_ensure( value == 42 );
 }
 
@@ -75,7 +75,7 @@ DAW_ATTRIB_NOINLINE void test_atomic_wait_value( ) {
 	};
 	auto ths = std::array<std::thread, 4>{ std::thread( fn ), std::thread( fn ),
 	                                       std::thread( fn ), std::thread( fn ) };
-	daw::atomic_wait_value( &value, 0 );
+	daw::atomic_wait_value_equal( &value, 0 );
 	for( auto &th : ths ) {
 		th.join( );
 	}