Merge pull request #6 from Krekep/master

Python examples

Author: EgorOrachyov

docs/examples/python_examples.md

@@ -0,0 +1,28 @@
+"""
+Example of element-wise addition of two matrices
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)
+a[0, 0] = True
+a[2, 0] = True
+
+shape = (3, 3)                          # Matrix shape
+b = cb.Matrix.empty(shape=shape)
+b[1, 1] = True
+b[1, 2] = True
+
+#
+#  Matrix element-wise addition
+#
+
+result = a.ewiseadd(b)                  # result = a + b
+
+print("Matrix element-wise addition:")
+print(result, sep='\n')                 # Matrix output

python/examples/add_example.py

@@ -0,0 +1,61 @@
+"""
+Examples of different ways to create matrices 
+"""
+
+import pycubool as cb
+
+#
+#  Creation an empty matrix of a known form
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)        # Creating matrix
+
+#
+#  Filling values by indices
+#
+
+a[1, 0] = True                          # Set "True" value to (1, 0) cell
+a[1, 1] = True                          # Set "True" value to (1, 1) cell
+a[1, 2] = True                          # Set "True" value to (1, 2) cell
+a[0, 0] = True                          # Set "True" value to (0, 0) cell
+
+print("First example:")
+print(a, sep='\n')                      # Matrix output
+
+#
+# Creation an empty matrix of known shape and filling with given arrays of indices
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)        # Creating matrix
+rows = [0, 1, 1, 1]                     # Row indices of values
+cols = [0, 0, 1, 2]                     # Column indices of values
+a.build(rows, cols)                     # Filling matrix
+
+print("Second example:")
+print(a, sep='\n')                      # Matrix output
+
+#
+# Creating a matrix via shape and arrays of significant element indices
+#
+
+shape = (3, 3)                          # Matrix shape
+rows = [0, 1, 1, 1]                     # Row indices of values
+cols = [0, 0, 1, 2]                     # Column indices of values
+a = cb.Matrix.from_lists(shape=shape, rows=rows, cols=cols)
+
+print("Third example:")
+print(a, sep='\n')                      # Matrix output
+
+
+#
+# Generate random matrix by determining the shape and density - the percentage of non-zeros elements
+#
+
+shape = (4, 4)                          # Matrix shape
+density = 0.5                           # Matrix filling density
+a = cb.Matrix.generate(shape=shape, density=density)
+
+print("Fourth example:")
+print(a, sep='\n')                      # Matrix output

python/examples/create_example.py

@@ -0,0 +1,6 @@
+# pycubool sparse boolean matrix
+3 3 4
+0 0
+0 1
+2 1
+2 2

python/examples/data/input_matrix.mtx

@@ -0,0 +1,6 @@
+# pycubool sparse boolean matrix
+3 3 4
+0 0
+1 0
+1 1
+1 2

python/examples/data/output_matrix.mtx

@@ -0,0 +1,25 @@
+"""
+Example of matrix duplication 
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 1] = True
+
+#
+#  Matrix duplicate operation
+#
+
+result = a.dup()
+
+print("Result of matrix duplication operation:")
+print(result, sep='\n')                 # Matrix output

python/examples/dup_example.py

@@ -0,0 +1,31 @@
+"""
+An example of writing a matrix to a file in .mtx format
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+a = cb.Matrix.empty(shape=(3, 3))               # Creating an empty matrix of a given shape
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 0] = True
+
+#
+#  Export matrix to file
+#
+
+path = "data/output_matrix.mtx"                 # relative path to target matrix
+cb.export_matrix_to_mtx(path, a)                # write matrix to file
+
+#
+#  Import this matrix to check the correctness of the writing
+#
+
+result = cb.import_matrix_from_mtx(path)        # read matrix from file
+
+print("Result matrix:")
+print(result, sep='\n')                         # Matrix output

python/examples/export_example.py

@@ -0,0 +1,16 @@
+"""
+An example of reading a matrix from a file in .mtx format
+"""
+
+import pycubool as cb
+
+
+#
+#  Import matrix from file
+#
+
+path = "data/input_matrix.mtx"              # relative path to target matrix
+a = cb.import_matrix_from_mtx(path)         # read matrix from file
+
+print("Result of import matrix from file:")
+print(a, sep='\n')                          # Matrix output

python/examples/import_example.py

@@ -0,0 +1,25 @@
+"""
+Example of iterating over matrix cells 
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 1] = True
+
+
+#
+#  Iterating over matrix elements
+#
+
+print("Filled cell indices (row, column):")
+for i, j in a:
+    print(f"({i}, {j})", end=" ")

python/examples/iteration_example.py

@@ -0,0 +1,26 @@
+"""
+Example of kronecker product of two matrices
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+a = cb.Matrix.empty(shape=(2, 2))           # Creating an empty matrix of a given shape
+a[0, 0] = True
+a[1, 0] = True
+
+b = cb.Matrix.empty(shape=(2, 2))           # Creating an empty matrix of a given shape
+b[1, 1] = True
+b[1, 0] = True
+
+#
+#  Matrix kronecker product
+#
+
+result = a.kronecker(b)                     # result = a x b
+
+print("Matrix kronecker product:")
+print(result, sep='\n')                     # Matrix output

python/examples/kronecker_example.py

@@ -0,0 +1,47 @@
+"""
+Example of start the logger
+"""
+
+import pycubool as cb
+
+#
+#  Example of starting the logger
+#
+
+path = "my-example-log.textlog"                     # Set file name in current directory to logged messages
+cb.setup_logger(path)
+
+#
+#  Matrix initialization
+#
+
+a = cb.Matrix.empty(shape=(3, 3))                   # Creating an empty matrix of a given shape
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 0] = True
+
+a.set_marker("a-log-example-matrix")                # Set debug marker for "a" matrix
+
+b = cb.Matrix.empty(shape=(3, 3))                   # Creating an empty matrix of a given shape
+b[0, 1] = True
+b[0, 2] = True
+
+#
+#  Simple matrix multiplication
+#
+
+result = a.mxm(b)                                   # result = a * b
+
+print("Simple matrix multiplication:")
+print(result, sep='\n')                             # Matrix output
+
+#
+# Matrix multiplication with accumulate
+#
+
+result = a.mxm(b, out=a, accumulate=True)           # result = a + a * b
+
+print("Matrix multiplication with accumulation:")
+print(result, sep='\n')                             # Matrix output
+

python/examples/log_example.py

@@ -0,0 +1,37 @@
+"""
+Examples of matrix multiplication of two matrices
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+a = cb.Matrix.empty(shape=(3, 3))           # Creating an empty matrix of a given shape
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 0] = True
+
+b = cb.Matrix.empty(shape=(3, 3))           # Creating an empty matrix of a given shape
+b[0, 1] = True
+b[0, 2] = True
+
+#
+#  Simple matrix multiplication
+#
+
+result = a.mxm(b)                           # result = a * b
+
+print("Simple matrix multiplication:")
+print(result, sep='\n')                     # Matrix output
+
+#
+# Matrix multiplication with accumulate
+#
+
+result = a.mxm(b, out=a, accumulate=True)   # result = a + a * b
+
+print("Matrix multiplication with accumulation:")
+print(result, sep='\n')                     # Matrix output

python/examples/mxm_example.py

@@ -0,0 +1,24 @@
+"""
+An example of matrix reduction
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+a = cb.Matrix.empty(shape=(3, 3))               # Creating an empty matrix of a given shape
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 1] = True
+
+#
+#  Matrix reduce operation
+#
+
+result = a.reduce()
+
+print("Result of matrix reduce operation:")
+print(result, sep='\n')                         # Matrix output

python/examples/reduce_example.py

@@ -0,0 +1,37 @@
+"""
+Examples of extracting sub-matrices 
+"""
+
+import pycubool as cb
+
+#
+#  Matrix initialization
+#
+
+shape = (3, 3)                          # Matrix shape
+a = cb.Matrix.empty(shape=shape)
+a[1, 0] = True
+a[1, 1] = True
+a[1, 2] = True
+a[0, 1] = True
+
+#
+#  Cut of a 2x2 (third param) matrix
+#  below and to the right of the specified index (first and second params)
+#  of the original matrix
+#
+
+result = a.extract_matrix(1, 1, (2, 2))
+
+print("First result of extract sub-matrix operation:")
+print(result, sep='\n')                 # Matrix output
+
+
+#
+#  Create duplicate of original matrix by extract a matrix with 3x3 shape
+#
+
+result = a.extract_matrix(0, 0, (3, 3))
+
+print("Second result of extract sub-matrix operation:")
+print(result, sep='\n')                 # Matrix output