Improve clone docs

docs_input/api/manipulation/joinrepeat/clone.rst

@@ -17,3 +17,8 @@ Examples
    :end-before: example-end clone-test-1
    :dedent:
 
+.. literalinclude:: ../../../../test/00_operators/clone_test.cu
+   :language: cpp
+   :start-after: example-begin clone-test-2
+   :end-before: example-end clone-test-2
+   :dedent:

include/matx/operators/clone.h

@@ -144,13 +144,13 @@ MATX_IGNORE_WARNING_POP_GCC
 
 
   /**
-   * @brief Operator to clone an operator or tensor acorss dimensions
+   * @brief Operator to clone an operator or tensor across dimensions
    *
    * @tparam Rank the rank of the cloned operator
    * @tparam T source operator/tensor type
    * @param t source operator/tensor
    * @param shape the shape of the cloned operator/tensor.
-   * Each element is either the size of the cloned dimension or matxKeepDim to be from the source tensor
+   * Each element is either the size of the cloned dimension or `matxKeepDim` to be from the source tensor
    * @return operator to compute the cloned value
    */
   template <std::size_t Rank, typename Op>

test/00_operators/clone_test.cu

@@ -25,7 +25,7 @@ TYPED_TEST(OperatorTestsNumericAllExecs, CloneOp)
 
     tiv() = 3;
 
-    // Clone "tiv" from a 1D tensor to a 3D tensor
+    // Clone "tiv" from a 0D tensor to a 3D tensor
     auto op = clone<3>(tiv, {N, M, K});
     // example-end clone-test-1
 
@@ -54,14 +54,18 @@ TYPED_TEST(OperatorTestsNumericAllExecs, CloneOp)
   }    
 
   { // clone from 1D
+    // example-begin clone-test-2
     auto tiv = make_tensor<TestType>({K});
     auto tov = make_tensor<TestType>({N,M,K});
 
     for(int k = 0; k < K; k++) {
       tiv(k) = static_cast<typename inner_op_type_t<TestType>::type>(k);
     }
 
+    // Clone "tiv" from a 1D tensor to a 3D tensor
+    // matxKeepDim is used to indicate where the 1D tensor should be placed in the 3D tensor
     auto op = clone<3>(tiv, {N, M, matxKeepDim});
+    // example-end clone-test-2
 
     ASSERT_EQ(op.Size(0), N);
     ASSERT_EQ(op.Size(1), M);