[Project] Minor project content polishing

Author: EgorOrachyov

CODE_OF_CONDUCT.md

@@ -0,0 +1,38 @@
+# JetBrains Open Source and Community Code of Conduct
+
+This code of conduct outlines our expectations for all those who participate in our 
+open source projects and communities (community programs), as well as the consequences 
+for unacceptable behaviour. We invite all those who participate to help us create safe 
+and positive experiences for everyone. Communities mirror the societies in which they 
+exist and positive action is essential to counteract the many forms of inequality and 
+abuses of power that exist in society. 
+
+## How to behave
+
+The following behaviours are expected and requested of all community members:
+
+- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+- Exercise consideration, respect and empathy in your speech and actions. Remember, we have all been through different stages of learning when adopting technologies.
+- Refrain from demeaning, discriminatory, or harassing behaviour and speech.
+- Disagreements on things are fine, argumentative behaviour or trolling are not.
+
+## How not to behave
+
+- Do not perform threats of violence or use violent language directed against another person.
+- Do not make jokes of sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory nature, or use language of this nature.
+- Do not post or display sexually explicit or violent material.
+- Do not post or threaten to post other people’s personally identifying information ("doxing").
+- Do not make personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Do not engage in sexual attention. This includes, sexualised comments or jokes and sexual advances.
+- Do not advocate for, or encourage, any of the above behaviour.
+
+
+Please take into account that online communities bring together people from many 
+different cultures and backgrounds. It's important to understand that sometimes
+the combination of cultural differences and online interaction can lead to misunderstandings.
+That is why having empathy is very important.
+
+## Also 
+
+You can access original text at 
+[JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct).

README.md

@@ -151,6 +151,7 @@ closure provides info about reachable vertices in the graph:
 ```c++
 /**
  * Performs transitive closure for directed graph
+ * 
  * @param Inst Library instance, which provides context for operations
  * @param A Adjacency matrix of the graph
  * @param T Reference to the handle where to allocate and store result
@@ -160,17 +161,15 @@ closure provides info about reachable vertices in the graph:
 CuBoolStatus TransitiveClosure(CuBoolInstance Inst, CuBoolMatrix A, CuBoolMatrix* T) {
     CuBool_Matrix_Duplicate(Inst, A, T);         /** Create result matrix and copy initial values */
 
-    CuBoolSize_t total;
-    CuBool_Matrix_Nvals(Inst, *T, &total);       /** Query current number on non-zero elements */
+    CuBoolSize_t total = 0;
+    CuBoolSize_t current;
+    CuBool_Matrix_Nvals(Inst, *T, &current);     /** Query current number on non-zero elements */
 
-    CuBoolSize_t current = total;                /** Loop while values are added */
-
-    do {
+    while (current != total) {                   /** Loop while values are added */
         total = current;
         CuBool_MxM(Inst, *T, *T, *T);            /** T += T * T */
         CuBool_Matrix_Nvals(Inst, *T, &current);
     }
-    while (current != total);
 
     return CUBOOL_STATUS_SUCCESS;
 }
@@ -194,17 +193,13 @@ def transitive_closure(a: pycubool.Matrix):
     """
 
     t = a.duplicate()                 # Duplicate matrix where to store result
+    total = 0                         # Current number of values
 
-    total = t.nvals                   # Current number of values
-    changing = True                   # track changing
-
-    while changing:
-        pycubool.mxm(t, t, t)         # t += t * t
-        changing = t.nvals != total
+    while total != t.nvals:
         total = t.nvals
+        pycubool.mxm(t, t, t)         # t += t * t
 
     return t
-
 ```
 
 ## License

python/pycubool/add.py

@@ -1,5 +1,5 @@
 from . import wrapper
-from . import dll
+from . import bridge
 from . import matrix
 
 __all__ = [
@@ -12,4 +12,4 @@ def add(result_matrix: matrix.Matrix, a_matrix: matrix.Matrix):
                                                   result_matrix.hnd,
                                                   a_matrix.hnd)
 
-    dll.check(status)
+    bridge.check(status)

python/pycubool/dll.py python/pycubool/bridge.py

@@ -1,5 +1,5 @@
 from . import wrapper
-from . import dll
+from . import bridge
 from . import matrix
 
 __all__ = [
@@ -13,4 +13,4 @@ def kron(result_matrix: matrix.Matrix, a_matrix: matrix.Matrix, b_matrix: matrix
                                             a_matrix.hnd,
                                             b_matrix.hnd)
 
-    dll.check(status)
+    bridge.check(status)

python/pycubool/kron.py

@@ -1,7 +1,7 @@
 import ctypes
 
 from . import wrapper
-from . import dll
+from . import bridge
 
 __all__ = [
     "Matrix"
@@ -30,20 +30,20 @@ def empty(cls, shape):
                                                       ctypes.c_uint(nrows),
                                                       ctypes.c_uint(ncols))
 
-        dll.check(status)
+        bridge.check(status)
 
         return Matrix(hnd)
 
     def __del__(self):
-        dll.check(wrapper.loaded_dll.CuBool_Matrix_Free(wrapper.instance, self.hnd))
+        bridge.check(wrapper.loaded_dll.CuBool_Matrix_Free(wrapper.instance, self.hnd))
 
     def resize(self, nrows, ncols):
         status = wrapper.loaded_dll.matrix_resizer(wrapper.instance,
                                                    self.hnd,
                                                    ctypes.c_uint(nrows),
                                                    ctypes.c_uint(ncols))
 
-        dll.check(status)
+        bridge.check(status)
 
     def build(self, rows, cols, nvals):
         if len(rows) != len(cols) or len(rows) != nvals:
@@ -58,7 +58,7 @@ def build(self, rows, cols, nvals):
                                                         t_cols,
                                                         ctypes.c_size_t(nvals))
 
-        dll.check(status)
+        bridge.check(status)
 
     def duplicate(self):
         hnd = ctypes.c_void_p(0)
@@ -67,7 +67,7 @@ def duplicate(self):
                                                             self.hnd,
                                                             ctypes.byref(hnd))
 
-        dll.check(status)
+        bridge.check(status)
 
         return Matrix(hnd)
 
@@ -79,7 +79,7 @@ def nrows(self) -> int:
                                                         self.hnd,
                                                         ctypes.byref(result))
 
-        dll.check(status)
+        bridge.check(status)
         return int(result.value)
 
     @property
@@ -90,7 +90,7 @@ def ncols(self) -> int:
                                                         self.hnd,
                                                         ctypes.byref(result))
 
-        dll.check(status)
+        bridge.check(status)
         return int(result.value)
 
     @property
@@ -101,7 +101,7 @@ def nvals(self) -> int:
                                                         self.hnd,
                                                         ctypes.byref(result))
 
-        dll.check(status)
+        bridge.check(status)
         return int(result.value)
 
     @property
@@ -121,6 +121,6 @@ def to_lists(self):
                                                                cols,
                                                                ctypes.byref(nvals))
 
-        dll.check(status)
+        bridge.check(status)
 
         return rows, cols

python/pycubool/matrix.py

@@ -1,5 +1,5 @@
 from . import wrapper
-from . import dll
+from . import bridge
 from . import matrix
 
 __all__ = [
@@ -13,4 +13,4 @@ def mxm(result_matrix: matrix.Matrix, a_matrix: matrix.Matrix, b_matrix: matrix.
                                            a_matrix.hnd,
                                            b_matrix.hnd)
 
-    dll.check(status)
+    bridge.check(status)

python/pycubool/mxm.py

@@ -1,6 +1,6 @@
 import os
 import ctypes
-from . import dll
+from . import bridge
 
 __all__ = [
     "singleton",
@@ -48,7 +48,7 @@ def __init__(self):
         self.loaded_dll = None
 
         self.load_path = os.environ["CUBOOL_PATH"]
-        self.loaded_dll = dll.load_and_configure(self.load_path)
+        self.loaded_dll = bridge.load_and_configure(self.load_path)
 
         self._setup_instance()
 
@@ -58,14 +58,14 @@ def __del__(self):
 
     def _setup_instance(self):
         self.instance = ctypes.c_void_p(None)
-        self._descInstance = dll.configure_instance_desc()
+        self._descInstance = bridge.configure_instance_desc()
         self._descInstance.memoryType = 0
 
         status = self.loaded_dll.CuBool_Instance_NewExt(ctypes.byref(self._descInstance),
                                                         ctypes.byref(self.instance))
 
-        dll.check(status)
+        bridge.check(status)
 
     def _release_instance(self):
         status = self.loaded_dll.CuBool_Instance_Free(self.instance)
-        dll.check(status)
+        bridge.check(status)

python/pycubool/wrapper.py

@@ -11,13 +11,10 @@ def transitive_closure(a: pycubool.Matrix):
     """
 
     t = a.duplicate()                 # Duplicate matrix where to store result
+    total = 0                         # Current number of values
 
-    total = t.nvals                   # Current number of values
-    changing = True                   # track changing
-
-    while changing:
-        pycubool.mxm(t, t, t)         # t += t * t
-        changing = t.nvals != total
+    while total != t.nvals:
         total = t.nvals
+        pycubool.mxm(t, t, t)         # t += t * t
 
     return t

python/tests/test_example.py

@@ -89,6 +89,7 @@ TEST(CuBoolInstance, SetupExt) {
 
 /**
  * Performs transitive closure for directed graph
+ *
  * @param Inst Library instance, which provides context for operations
  * @param A Adjacency matrix of the graph
  * @param T Reference to the handle where to allocate and store result
@@ -98,17 +99,15 @@ TEST(CuBoolInstance, SetupExt) {
 CuBoolStatus TransitiveClosure(CuBoolInstance Inst, CuBoolMatrix A, CuBoolMatrix* T) {
     CuBool_Matrix_Duplicate(Inst, A, T);         /** Create result matrix and copy initial values */
 
-    CuBoolSize_t total;
-    CuBool_Matrix_Nvals(Inst, *T, &total);       /** Query current number on non-zero elements */
-
-    CuBoolSize_t current = total;                /** Loop while values are added */
+    CuBoolSize_t total = 0;
+    CuBoolSize_t current;
+    CuBool_Matrix_Nvals(Inst, *T, &current);     /** Query current number on non-zero elements */
 
-    do {
+    while (current != total) {                   /** Loop while values are added */
         total = current;
         CuBool_MxM(Inst, *T, *T, *T);            /** T += T * T */
         CuBool_Matrix_Nvals(Inst, *T, &current);
     }
-    while (current != total);
 
     return CUBOOL_STATUS_SUCCESS;
 }