CR: Add a code comment for a helper function

Signed-off-by: Thien Nguyen <thiennguyen@nvidia.com>
NVIDIA · Feb 3, 2025 · 80741ec · 80741ec
1 parent a7e964b
commit 80741ec
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/runtime/nvqir/cutensornet/simulator_cutensornet.cpp b/runtime/nvqir/cutensornet/simulator_cutensornet.cpp
@@ -148,6 +148,9 @@ void SimulatorTensorNetBase::applyGate(const GateApplicationTask &task) {
   }
 }
 
+// Helper to check whether a matrix is a scaled unitary matrix, i.e., `k * U`
+// where U is a unitary matrix. If so, it also returns the `k` factor.
+// Otherwise, return a nullopt.
 template <typename T>
 std::optional<double> isScaledUnitary(const std::vector<std::complex<T>> &mat,
                                       double eps) {