Merge pull request #22 from edmBernard/dev/add-test-argument

Dev/add test argument

Author: edmBernard

tests/cpp/test.cpp

@@ -145,7 +145,7 @@ cv::Mat cloneimg(cv::Mat image) {
 class ClassForReturn {
 public:
   ClassForReturn() {
-    m_image = cv::Mat(2, 2, CV_8UC3, cv::Scalar(1,2,3));
+    m_image = generateMatrix();
   }
 
   cv::Mat& returnByRef() { return m_image; };
@@ -160,13 +160,25 @@ class ClassForReturn {
   void returnInArgumentByPointer(cv::Mat* image) {};
 
   void changeInternal() {
-    m_image.at<cv::Vec3b>(0, 0) = cv::Vec3b(4,5,6);
+    m_image.at<cv::Vec3w>(0, 0) = cv::Vec3w(4,5,6);
   }
 
 private:
   cv::Mat m_image;
 };
 
+void returnByArgumentValue(cv::Mat mat) {
+  mat.at<cv::Vec3w>(0, 0) = cv::Vec3w(4,5,6);
+}
+
+void returnByArgumentRef(cv::Mat & mat) {
+  mat.at<cv::Vec3w>(0, 0) = cv::Vec3w(4,5,6);
+}
+
+void returnByArgumentPointer(cv::Mat *mat) {
+  mat->at<cv::Vec3w>(0, 0) = cv::Vec3w(4,5,6);
+}
+
 PYBIND11_MODULE(test_module, m) {
 
   NDArrayConverter::init_numpy();
@@ -209,4 +221,11 @@ PYBIND11_MODULE(test_module, m) {
     .def("returnInArgumentByRef", &ClassForReturn::returnInArgumentByRef)
     .def("returnInArgumentByPointer", &ClassForReturn::returnInArgumentByPointer)
     ;
+
+  m.def("returnByArgumentValue", &returnByArgumentValue, py::return_value_policy::copy);
+
+  m.def("returnByArgumentRef", &returnByArgumentRef);
+
+  m.def("returnByArgumentPointer", &returnByArgumentPointer);
+
 }

tests/test_return.py

@@ -1,44 +1,63 @@
 import numpy as np
 from tests import test_module as tm
+from tests.utils import generate_matrix, check_matrix_content
 
 
 def test_return_by_value():
   a = tm.ClassForReturn()
-  assert(id(a.returnByValue()) != id(a.returnByValue()))
   mat = a.returnByValue()
   a.changeInternal()
-  assert(np.any(mat != a.returnByValue()))
+  assert(check_matrix_content(mat))
+  changed_mat = a.returnByValue()
+  assert(not check_matrix_content(changed_mat))
 
 
 def test_return_by_ref_but_copy():
   a = tm.ClassForReturn()
-  assert(id(a.returnByRef()) != id(a.returnByRef()))
   mat = a.returnByRef()
   a.changeInternal()
-  assert(np.any(mat != a.returnByValue()))
+  assert(check_matrix_content(mat))
+  changed_mat = a.returnByValue()
+  assert(not check_matrix_content(changed_mat))
 
 
 def test_return_by_ref():
   a = tm.ClassForReturn()
-  assert(id(a.returnByRef()) != id(a.returnByRef()))
   mat = a.viewMatrix()
   a.changeInternal()
-  assert(np.all(mat == a.returnByValue()))
+  # Currently return parameter perform a copy of the data, so the change is not repercuted to mat
+  assert(check_matrix_content(mat))
+  changed_mat = a.returnByValue()
+  assert(not check_matrix_content(changed_mat))
 
 
 def test_return_by_pointer():
   a = tm.ClassForReturn()
-  assert(id(a.returnByPointer()) != id(a.returnByPointer()))
   mat = a.returnByPointer()
   a.changeInternal()
-  assert(np.all(mat == a.returnByValue()))
+  # Currently return parameter perform a copy of the data, so the change is not repercuted to mat
+  assert(check_matrix_content(mat))
+  changed_mat = a.returnByValue()
+  assert(not check_matrix_content(changed_mat))
+
+
+def test_return_by_argument_by_value():
+  mat = generate_matrix()
+  tm.returnByArgumentValue(mat)
+
+  # Not intuitive Argument passed by value can be changed by cpp
+  # because the cast between from numpy.drarray to cv::Mat avoid copy by passing buffer
+  assert(not check_matrix_content(mat))
 
 
 def test_return_by_argument_by_ref():
-  pass
+  mat = generate_matrix()
+  tm.returnByArgumentRef(mat)
+  assert(np.any(mat != generate_matrix()))
+  assert(not check_matrix_content(mat))
 
-def test_return_by_argument_by_value():
-  pass
 
 def test_return_by_argument_by_pointer():
-  pass
+  mat = generate_matrix()
+  tm.returnByArgumentPointer(mat)
+  assert(not check_matrix_content(mat))