Add documentation for offset generators

boostorg · Jun 5, 2021 · 29b3f83 · 29b3f83
1 parent c849b1c
commit 29b3f83
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/test/extension/numeric/test_fixture.hpp b/test/extension/numeric/test_fixture.hpp
@@ -28,6 +28,8 @@ auto create_kernel(std::initializer_list<T> const& values)
     return kernel;
 }
 
+// Adds an offset similar to 1D row convolution with kernel {0, 0, 0, 0, 0, 0, 1, 0, 0} 
+// having its anchor point at 5th element and boundary option as "extend_zero".
 template <typename SrcView, typename DstView>
 void row_conv1D_offset_img_generator(SrcView src_view, DstView dst_view, int const offset,
     std::ptrdiff_t start_row = 0, std::ptrdiff_t start_col = 0, std::ptrdiff_t end_row = -1,
@@ -53,6 +55,8 @@ void row_conv1D_offset_img_generator(SrcView src_view, DstView dst_view, int con
     }
 }
 
+// Adds an offset similar to 1D column convolution with kernel {0, 0, 0, 0, 0, 0, 1, 0, 0} 
+// having its anchor point at 5th element and boundary option as "extend_zero".
 template <typename SrcView, typename DstView>
 void col_conv1D_offset_img_generator(SrcView src_view, DstView dst_view, int const offset,
     std::ptrdiff_t start_row = 0, std::ptrdiff_t start_col = 0, std::ptrdiff_t end_row = -1,