add code comments for deepSwap

8 years ago · 5de5453d15
parent c7f96de12e
commit 5de5453d15
1 changed files with 4 additions and 0 deletions
--- a/paddle/math/BaseMatrix.h
+++ b/paddle/math/BaseMatrix.h
@ -458,6 +458,10 @@ public:
  /**
   * @code
   * swap(this, b)
+   * example: swap two Matrices
+   * MatrixPtr cpuA = std::make_shared<CpuMatrix>(height, width);
+   * MatrixPtr cpuB = std::make_shared<CpuMatrix>(height, width);
+   * cpuA->deepSwap(*cpuB);
   * @endcode
   */
  void deepSwap(BaseMatrixT& b);