[APInt] Move a comment from urem to srem where it belongs.
authorCraig Topper <craig.topper@sifive.com>
Fri, 23 Dec 2022 18:25:19 +0000 (10:25 -0800)
committerCraig Topper <craig.topper@sifive.com>
Fri, 23 Dec 2022 18:26:28 +0000 (10:26 -0800)
This comment talks about sign of the dividend and the result. I
think it belongs to the srem function.

This is the commit that added it
https://github.com/llvm/llvm-project/commit/709a820a5338ca5c4b949f2f0286f7da39f00661
and the code change with it was for srem.

Reviewed By: nikic

Differential Revision: https://reviews.llvm.org/D140611

llvm/include/llvm/ADT/APInt.h

index 33b3865..ab8bf3e 100644 (file)
@@ -955,9 +955,7 @@ public:
   ///
   /// Perform an unsigned remainder operation on this APInt with RHS being the
   /// divisor. Both this and RHS are treated as unsigned quantities for purposes
-  /// of this operation. Note that this is a true remainder operation and not a
-  /// modulo operation because the sign follows the sign of the dividend which
-  /// is *this.
+  /// of this operation.
   ///
   /// \returns a new APInt value containing the remainder result
   APInt urem(const APInt &RHS) const;
@@ -966,6 +964,9 @@ public:
   /// Function for signed remainder operation.
   ///
   /// Signed remainder operation on APInt.
+  ///
+  /// Note that this is a true remainder operation and not a modulo operation
+  /// because the sign follows the sign of the dividend which is *this.
   APInt srem(const APInt &RHS) const;
   int64_t srem(int64_t RHS) const;