move optional extra timestamp functions to utilities

Author: tmckayus

cpp/include/cuopt/utilities/timestamp_utils.hpp

@@ -0,0 +1,50 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <string>
+
+namespace cuopt {
+namespace utilities {
+
+/**
+ * @brief Check if extra timestamps should be printed based on environment variable
+ * 
+ * Checks the CUOPT_EXTRA_TIMESTAMPS environment variable once and caches the result.
+ * Returns true if the environment variable is set to "True", "true", or "1".
+ * 
+ * @return true if extra timestamps are enabled, false otherwise
+ */
+bool extraTimestamps();
+
+/**
+ * @brief Get current timestamp as seconds since epoch
+ * 
+ * @return Current timestamp as a double representing seconds since epoch
+ */
+double getCurrentTimestamp();
+
+/**
+ * @brief Print a timestamp with label if extra timestamps are enabled
+ * 
+ * @param label The label to print with the timestamp
+ */
+void printTimestamp(const std::string& label);
+
+}  // namespace utilities
+}  // namespace cuopt

cpp/src/CMakeLists.txt

@@ -15,7 +15,8 @@
 
 set(UTIL_SRC_FILES ${CMAKE_CURRENT_SOURCE_DIR}/utilities/seed_generator.cu
                    ${CMAKE_CURRENT_SOURCE_DIR}/utilities/logger_helper.cpp
-                   ${CMAKE_CURRENT_SOURCE_DIR}/utilities/version_info.cpp)
+                   ${CMAKE_CURRENT_SOURCE_DIR}/utilities/version_info.cpp
+                   ${CMAKE_CURRENT_SOURCE_DIR}/utilities/timestamp_utils.cpp)
 
 add_subdirectory(linear_programming)
 add_subdirectory(math_optimization)

cpp/src/linear_programming/cuopt_c.cpp

@@ -21,6 +21,7 @@
 #include <cuopt/linear_programming/solve.hpp>
 #include <cuopt/linear_programming/solver_settings.hpp>
 #include <cuopt/logger.hpp>
+#include <cuopt/utilities/timestamp_utils.hpp>
 
 #include <mps_parser/parser.hpp>
 
@@ -76,29 +77,6 @@ cuopt_int_t cuOptGetVersion(cuopt_int_t* version_major,
   return CUOPT_SUCCESS;
 }
 
-bool extraTimestamps() {
-    const char* envValue = std::getenv("CUOPT_EXTRA_TIMESTAMPS");
-    if (envValue == nullptr) {
-        return false;
-    }
-    
-    std::string value(envValue);
-    return (value == "True" || value == "true" || value == "1");
-}
-
-
-double getCurrentTimestamp() {
-    auto now = std::chrono::system_clock::now();
-    return std::chrono::duration<double>(now.time_since_epoch()).count();
-}
-
-void printTimestamp(const std::string& label) {
-    if (extraTimestamps()) {    
-        std::cout << std::fixed << std::setprecision(6);
-        std::cout << std::endl << label << ": " << getCurrentTimestamp() << std::endl;
-    }
-}
-
 cuopt_int_t cuOptReadProblem(const char* filename, cuOptOptimizationProblem* problem_ptr)
 {
   problem_and_stream_view_t* problem_and_stream = new problem_and_stream_view_t();
@@ -141,7 +119,7 @@ cuopt_int_t cuOptCreateProblem(cuopt_int_t num_constraints,
                                cuOptOptimizationProblem* problem_ptr)
 {
 
-  printTimestamp("CUOPT_CREATE_PROBLEM");
+  cuopt::utilities::printTimestamp("CUOPT_CREATE_PROBLEM");
 
   if (problem_ptr == nullptr || objective_coefficients == nullptr ||
       constraint_matrix_row_offsets == nullptr || constraint_matrix_column_indices == nullptr ||
@@ -199,7 +177,7 @@ cuopt_int_t cuOptCreateRangedProblem(cuopt_int_t num_constraints,
                                      cuOptOptimizationProblem* problem_ptr)
 {
 
-  printTimestamp("CUOPT_CREATE_PROBLEM");
+  cuopt::utilities::printTimestamp("CUOPT_CREATE_PROBLEM");
 
   if (problem_ptr == nullptr || objective_coefficients == nullptr ||
       constraint_matrix_row_offsets == nullptr || constraint_matrix_column_indices == nullptr ||
@@ -627,7 +605,7 @@ cuopt_int_t cuOptSolve(cuOptOptimizationProblem problem,
                        cuOptSolverSettings settings,
                        cuOptSolution* solution_ptr)
 {
-  printTimestamp("CUOPT_SOLVE_START");
+  cuopt::utilities::printTimestamp("CUOPT_SOLVE_START");
 
   if (problem == nullptr) { return CUOPT_INVALID_ARGUMENT; }
   if (settings == nullptr) { return CUOPT_INVALID_ARGUMENT; }
@@ -648,7 +626,7 @@ cuopt_int_t cuOptSolve(cuOptOptimizationProblem problem,
       solve_mip<cuopt_int_t, cuopt_float_t>(*op_problem, mip_settings));
     *solution_ptr = static_cast<cuOptSolution>(solution_and_stream_view);
 
-    printTimestamp("CUOPT_SOLVE_RETURN");
+    cuopt::utilities::printTimestamp("CUOPT_SOLVE_RETURN");
 
     return static_cast<cuopt_int_t>(
       solution_and_stream_view->mip_solution_ptr->get_error_status().get_error_type());
@@ -666,7 +644,7 @@ cuopt_int_t cuOptSolve(cuOptOptimizationProblem problem,
         solve_lp<cuopt_int_t, cuopt_float_t>(*op_problem, pdlp_settings));
     *solution_ptr = static_cast<cuOptSolution>(solution_and_stream_view);
 
-    printTimestamp("CUOPT_SOLVE_RETURN");
+    cuopt::utilities::printTimestamp("CUOPT_SOLVE_RETURN");
 
     return static_cast<cuopt_int_t>(
       solution_and_stream_view->lp_solution_ptr->get_error_status().get_error_type());

cpp/src/utilities/timestamp_utils.cpp

@@ -0,0 +1,58 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <cuopt/utilities/timestamp_utils.hpp>
+
+#include <chrono>
+#include <cstdlib>
+#include <iomanip>
+#include <iostream>
+#include <string>
+
+namespace cuopt {
+namespace utilities {
+
+bool extraTimestamps() {
+    static bool initialized = false;
+    static bool enableTimestamps = false;
+    
+    if (!initialized) {
+        const char* envValue = std::getenv("CUOPT_EXTRA_TIMESTAMPS");
+        if (envValue != nullptr) {
+            std::string value(envValue);
+            enableTimestamps = (value == "True" || value == "true" || value == "1");
+        }
+        initialized = true;
+    }
+    
+    return enableTimestamps;
+}
+
+double getCurrentTimestamp() {
+    auto now = std::chrono::system_clock::now();
+    return std::chrono::duration<double>(now.time_since_epoch()).count();
+}
+
+void printTimestamp(const std::string& label) {
+    if (extraTimestamps()) {    
+        std::cout << std::fixed << std::setprecision(6);
+        std::cout << std::endl << label << ": " << getCurrentTimestamp() << std::endl;
+    }
+}
+
+}  // namespace utilities
+}  // namespace cuopt