renamed functions libraries and build products

jima80525 · jima80525 · commit f2fb1bdaf73f · 2019-11-14T20:33:03.000-07:00
diff --git a/python-bindings/overview_article/c_function.h b/python-bindings/overview_article/c_function.h
diff --git a/python-bindings/overview_article/cffi_test.py b/python-bindings/overview_article/cffi_test.py
@@ -1,9 +1,9 @@
 #!/usr/bin/env python3
-import _c_function
+import cffi_example
 
 if __name__ == "__main__":
     # sample data for our call:
     x, y = 6, 2.3
 
-    answer = _c_function.c_function(x, y)
+    answer = cffi_example.lib.cmult(x, y)
     print(f"    In Python: int: {x} float {y:.1f} return val {answer:.1f}")
diff --git a/python-bindings/overview_article/cmult.c b/python-bindings/overview_article/cmult.c
@@ -1,10 +1,10 @@
 #include <stdio.h>
-#include "c_function.h"
+#include "cmult.h"
 
 
-float c_function(int int_param, float float_param) {
+float cmult(int int_param, float float_param) {
     float return_value = int_param * float_param;
-    printf("    In c_func: int: %d float %.1f returning  %.1f\n", int_param,
+    printf("    In cmult : int: %d float %.1f returning  %.1f\n", int_param,
             float_param, return_value);
     return int_param * float_param;
 }
diff --git a/python-bindings/overview_article/cmult.h b/python-bindings/overview_article/cmult.h
@@ -0,0 +1 @@
+float cmult(int int_param, float float_param);
diff --git a/python-bindings/overview_article/cpp_function.hpp b/python-bindings/overview_article/cpp_function.hpp
diff --git a/python-bindings/overview_article/cppmult.cpp b/python-bindings/overview_article/cppmult.cpp
@@ -1,10 +1,10 @@
 #include <stdio.h>
-#include "cpp_function.hpp"
+#include "cppmult.hpp"
 
 
-float cpp_mult(int int_param, float float_param) {
+float cppmult(int int_param, float float_param) {
     float return_value = int_param * float_param;
-    printf("    In c_func: int: %d float %.1f returning  %.1f\n", int_param,
+    printf("    In cppmul: int: %d float %.1f returning  %.1f\n", int_param,
             float_param, return_value);
     return int_param * float_param;
 }
diff --git a/python-bindings/overview_article/cppmult.hpp b/python-bindings/overview_article/cppmult.hpp
@@ -0,0 +1 @@
+float cppmult(int int_param, float float_param);
diff --git a/python-bindings/overview_article/ctypes_test.py b/python-bindings/overview_article/ctypes_test.py
@@ -6,24 +6,22 @@
 
 if __name__ == "__main__":
     # load the shared library into c types.
-    libname = pathlib.Path().absolute() / "libc_function.so"
+    libname = pathlib.Path().absolute() / "libcmult.so"
     c_lib = ctypes.CDLL(libname)
 
     # sample data for our call:
-    x = 6
-    y = 2.3
+    x, y = 6, 2.3
 
     # This will not work:
-    # answer = c_lib.c_function(6, 2.3)
+    # answer = c_lib.cmult(x, y)
 
     # This produces a bad answer:
-    answer = c_lib.c_function(6, ctypes.c_float(2.3))
+    answer = c_lib.cmult(x, ctypes.c_float(y))
     print(f"    In Python: int: {x} float {y:.1f} return val {answer:.1f}")
     print()
 
     # You need tell ctypes that the function returns a float
-    c_function = c_lib.c_function
-    c_function.restype = ctypes.c_float
-    answer = c_function(6, ctypes.c_float(2.3))
+    c_lib.cmult.restype = ctypes.c_float
+    answer = c_lib.cmult(x, ctypes.c_float(y))
     print(f"    In Python: int: {x} float {y:.1f} return val {answer:.1f}")
 
diff --git a/python-bindings/overview_article/pybind11_test.py b/python-bindings/overview_article/pybind11_test.py
@@ -1,13 +1,13 @@
 #!/usr/bin/env python
 """ Simple examples of calling C functions through ctypes module. """
-import example
+import pybind11_example
 
 
 if __name__ == "__main__":
     # sample data for our call:
     x = 6
     y = 2.3
 
-    answer = example.cpp_function(x, y)
+    answer = pybind11_example.cpp_function(x, y)
     print(f"    In Python: int: {x} float {y:.1f} return val {answer:.1f}")
 
diff --git a/python-bindings/overview_article/pybind11_wrapper.cpp b/python-bindings/overview_article/pybind11_wrapper.cpp
@@ -1,9 +1,9 @@
 #include <pybind11/pybind11.h>
-#include <cpp_function.hpp>
+#include <cppmult.hpp>
 
 
-PYBIND11_MODULE(example, m) {
+PYBIND11_MODULE(pybind11_example, m) {
     m.doc() = "pybind11 example plugin"; // optional module docstring
-    m.def("cpp_function", &cpp_mult, "A function which multiplies two numbers");
+    m.def("cpp_function", &cppmult, "A function which multiplies two numbers");
 }
 
diff --git a/python-bindings/overview_article/tasks.py b/python-bindings/overview_article/tasks.py
@@ -5,45 +5,45 @@
 import os
 import pathlib
 
-COMPILE = "gcc -c -Wall -Werror -fpic c_function.c -I /usr/include/python3.7"
-LINK = "gcc -shared -o libc_function.so c_function.o"
+COMPILE = "gcc -c -Wall -Werror -fpic cmult.c -I /usr/include/python3.7"
+LINK = "gcc -shared -o libcmult.so cmult.o"
 
 
 @invoke.task
 def clean(c):
     """ Remove any built objects. """
-    for pattern in ["*.o", "*.so", "_c_function*", ]:
+    for pattern in ["*.o", "*.so", "cffi_example*", ]:
         c.run("rm -rf {}".format(pattern))
 
 @invoke.task
-def build_c_function(c):
+def build_cmult(c):
     """ Compile and link the shared library (DLL) for the sample C++ code."""
     invoke.run(COMPILE)
     invoke.run(LINK)
 
 
-@invoke.task(build_c_function)
+@invoke.task(build_cmult)
 def test_ctypes(c):
     invoke.run("python3 ctypes_test.py", pty=True)
 
-@invoke.task(build_c_function)
+@invoke.task(build_cmult)
 def build_cffi(c):
     ffi = cffi.FFI()
 
     this_dir = pathlib.Path().absolute()
-    h_file_name = this_dir / "c_function.h"
+    h_file_name = this_dir / "cmult.h"
     with open(h_file_name) as h_file:
         ffi.cdef(h_file.read())
 
-    ffi.set_source("_c_function",
+    ffi.set_source("cffi_example",
         # Since we are calling a fully built library directly no custom source
         # is necessary. We need to include the .h files, though, because behind
         # the scenes cffi generates a .c file which contains a Python-friendly
         # wrapper around each of the functions.
-        '#include "c_function.h"',
+        '#include "cmult.h"',
         # The important thing is to include the pre-built lib in the list of
         # libraries we are linking against:
-        libraries=["c_function"],
+        libraries=["cmult"],
         library_dirs=[this_dir.as_posix(),],
         extra_link_args=['-Wl,-rpath,.'],
     )
@@ -57,27 +57,27 @@ def test_cffi(c):
 @invoke.task()
 def build_pybind11(c):
     """ Compile and link the shared library (DLL) for the sample C++ code."""
+    # compile and link the c++ library
     invoke.run("g++ -O3 -Wall -Werror -shared -std=c++11 -fPIC " \
                "-I /usr/include/python3.7 " \
-               "cpp_function.cpp " \
-               "-o libcpp_function.so "
+               "cppmult.cpp " \
+               "-o libcppmult.so "
               )
-    # invoke.run(CPP_LINK)
     # compile and link the pybind11 wrapper library
     invoke.run("g++ -O3 -Wall -Werror -shared -std=c++11 -fPIC "
                "`python3 -m pybind11 --includes` "
                "-I /usr/include/python3.7 -I . "
                "pybind11_wrapper.cpp "
-               "-o example`python3.7-config --extension-suffix` "
-               "-L. -lcpp_function "
+               "-o pybind11_example`python3.7-config --extension-suffix` "
+               "-L. -lcppmult "
                "-Wl,-rpath,. "
               )
 
 @invoke.task()
 def test_pybind11(c):
     invoke.run("python3 pybind11_test.py", pty=True)
 
-@invoke.task(clean, build_c_function, test_ctypes, build_cffi, test_cffi,
+@invoke.task(clean, build_cmult, test_ctypes, build_cffi, test_cffi,
              build_pybind11, test_pybind11)
 def all(c):
     pass

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+float cmult(int int_param, float float_param);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+float cppmult(int int_param, float float_param);`