From 3228e5f1ca7c22a335ec916df70c70813de109c7 Mon Sep 17 00:00:00 2001
From: Peng Xingliang <91927439+pxlxingliang@users.noreply.github.com>
Date: Sat, 3 Aug 2024 20:43:15 +0800
Subject: [PATCH] fix: avoid nan in the output of time percentage (#4857)

* fix: avoid nan in the output of time percentage

* [pre-commit.ci lite] apply automatic fixes

* add annotation

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
---
 source/module_base/timer.cpp | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/source/module_base/timer.cpp b/source/module_base/timer.cpp
index c47d58f2a9..25e676c6e1 100644
--- a/source/module_base/timer.cpp
+++ b/source/module_base/timer.cpp
@@ -5,7 +5,7 @@
 //==========================================================
 #include "timer.h"
 
-#include <math.h>
+#include <cmath>
 
 #ifdef __MPI
 #include <mpi.h>
@@ -32,20 +32,21 @@ std::map<std::string,std::map<std::string,timer::Timer_One>> timer::timer_pool;
 void timer::finish(std::ofstream &ofs,const bool print_flag)
 {
 	timer::tick("","total");
-	if(print_flag)
+	if(print_flag) {
 		print_all( ofs );
 }
+}
 
 //----------------------------------------------------------
 //
 //----------------------------------------------------------
-void timer::start(void)
+void timer::start()
 {
 	// first init ,then we can use tick
 	timer::tick("","total");
 }
 
-double timer::cpu_time(void)
+double timer::cpu_time()
 {
 //----------------------------------------------------------
 // EXPLAIN : here static is important !!
@@ -72,8 +73,9 @@ void timer::tick(const std::string &class_name,const std::string &name)
 //----------------------------------------------------------
 // EXPLAIN : if timer is disabled , return
 //----------------------------------------------------------
-	if (disabled)
+	if (disabled) {
 		return;
+}
 
 #ifdef _OPENMP
 	if(!omp_get_thread_num())
@@ -130,7 +132,7 @@ void timer::tick(const std::string &class_name,const std::string &name)
 	} // end if(!omp_get_thread_num())
 }
 
-long double timer::print_until_now(void)
+long double timer::print_until_now()
 {
 	// stop the clock
 	timer::tick("","total");
@@ -146,12 +148,14 @@ void timer::write_to_json(std::string file_name)
 	// if mpi is not initialized, we do not run this function
 	int is_initialized = 0;
     MPI_Initialized(&is_initialized);
-	if (!is_initialized)
+	if (!is_initialized) {
 		return;	
+}
 	int my_rank = 0;
 	MPI_Comm_rank(MPI_COMM_WORLD, &my_rank);
-	if (my_rank != 0)
+	if (my_rank != 0) {
 		return;
+}
 #endif
 
     // check if a double is inf, if so, return "null", else return a string of the input double
@@ -268,7 +272,13 @@ void timer::print_all(std::ofstream &ofs)
 		times.push_back(timer_one.cpu_second);
 		calls.push_back(timer_one.calls);
 		avgs.push_back(timer_one.cpu_second/timer_one.calls);
-		pers.push_back(timer_one.cpu_second / timer_pool_order[0].second.cpu_second * 100);
+
+		// if the total time is too small, we do not calculate the percentage
+		if (timer_pool_order[0].second.cpu_second < 1e-9) {
+    		pers.push_back(0);
+		} else {
+    		pers.push_back(timer_one.cpu_second / timer_pool_order[0].second.cpu_second * 100);
+		}
 	}
 	assert(class_names.size() == names.size());
 	assert(class_names.size() == times.size());