From eb6caec0baeaf40bc11e0ece2a3623dfb98ee81d Mon Sep 17 00:00:00 2001 From: zkasmi <zkasmi@inf.fu-berlin.de> Date: Sun, 22 Mar 2020 16:41:24 +0100 Subject: [PATCH] Readme files added to examples. --- examples/linear_algebra/README.md | 20 +++++++++++++++ .../linear_algebra/basic_operations/README.md | 20 +++++++++++++++ .../matrix_decompositions/README.md | 21 ++++++++++++++++ .../linear_algebra/pseudo_inverse/README.md | 20 +++++++++++++++ .../solve_linear_equations/README.md | 24 ++++++++++++++++++ examples/linear_algebra/utilities/README.md | 25 +++++++++++++++++++ examples/localization/README.md | 19 ++++++++++++++ .../position_algos/distance_based/README.md | 22 ++++++++++++++++ .../position_algos/magnetic_based/README.md | 22 ++++++++++++++++ .../position_algos/pos_algos_common/README.md | 22 ++++++++++++++++ examples/non_linear_algebra/README.md | 19 ++++++++++++++ .../non_linear_algebra/optimization/README.md | 24 ++++++++++++++++++ .../solve_non_linear_equations/README.md | 24 ++++++++++++++++++ 13 files changed, 282 insertions(+) create mode 100644 examples/linear_algebra/README.md create mode 100644 examples/linear_algebra/basic_operations/README.md create mode 100644 examples/linear_algebra/matrix_decompositions/README.md create mode 100644 examples/linear_algebra/pseudo_inverse/README.md create mode 100644 examples/linear_algebra/solve_linear_equations/README.md create mode 100644 examples/linear_algebra/utilities/README.md create mode 100644 examples/localization/README.md create mode 100644 examples/localization/position_algos/distance_based/README.md create mode 100644 examples/localization/position_algos/magnetic_based/README.md create mode 100644 examples/localization/position_algos/pos_algos_common/README.md create mode 100644 examples/non_linear_algebra/README.md create mode 100644 examples/non_linear_algebra/optimization/README.md create mode 100644 examples/non_linear_algebra/solve_non_linear_equations/README.md diff --git a/examples/linear_algebra/README.md b/examples/linear_algebra/README.md new file mode 100644 index 0000000..49e32bb --- /dev/null +++ b/examples/linear_algebra/README.md @@ -0,0 +1,20 @@ +## Linear algebra examples + +### About + +These examples show how to use the RcdMathLib's linear algebra module composed +of the following sub-modules: basic_operations, matrix_decompositions, pseudo_inverse, +solve_linear_equations, and utilities sub-modules. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/linear_algebra/basic_operations/README.md b/examples/linear_algebra/basic_operations/README.md new file mode 100644 index 0000000..3a45ea3 --- /dev/null +++ b/examples/linear_algebra/basic_operations/README.md @@ -0,0 +1,20 @@ +## Basic matrix operations examples + +### About + +This example shows how to use the basic matrix operations such as the addition +or the multiplication. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type of the matrices can be set in the matrix.h file. The user can choose +between the float or the double data types. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. \ No newline at end of file diff --git a/examples/linear_algebra/matrix_decompositions/README.md b/examples/linear_algebra/matrix_decompositions/README.md new file mode 100644 index 0000000..7f3609f --- /dev/null +++ b/examples/linear_algebra/matrix_decompositions/README.md @@ -0,0 +1,21 @@ +## Matrix decomposition examples + +### About + +These examples show how to use algorithms to decompose matrices. +The algorithms implemented are the Gaussian Elimination with pivoting, Givens, the +Householder, and the SVD methods. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type of the matrices can be set in the matrix.h file. The user can choose +between the float or the double data types. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. \ No newline at end of file diff --git a/examples/linear_algebra/pseudo_inverse/README.md b/examples/linear_algebra/pseudo_inverse/README.md new file mode 100644 index 0000000..62667da --- /dev/null +++ b/examples/linear_algebra/pseudo_inverse/README.md @@ -0,0 +1,20 @@ +## Pseudo-inverse matrix examples + +### About + +These examples show how to use algorithms to compute the pseudo-inverse matrices. +The algorithms implemented are the Moore-Penrose and the QR-based methods. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type of the matrices can be set in the matrix.h file. The user can choose +between the float or the double data types. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. \ No newline at end of file diff --git a/examples/linear_algebra/solve_linear_equations/README.md b/examples/linear_algebra/solve_linear_equations/README.md new file mode 100644 index 0000000..b944953 --- /dev/null +++ b/examples/linear_algebra/solve_linear_equations/README.md @@ -0,0 +1,24 @@ +## Solving linear equations examples + +### About + +These examples show how to use algorithms to solve linear equation systems. +The algorithms implemented to solve linear equations are based on the Moore-penrose, +Householder, Givens and Gaussian elimination with pivoting methods. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/linear_algebra/utilities/README.md b/examples/linear_algebra/utilities/README.md new file mode 100644 index 0000000..05c3f9c --- /dev/null +++ b/examples/linear_algebra/utilities/README.md @@ -0,0 +1,25 @@ +## Utilities examples + +### About + +These examples show how to use the utilities of the RcdMathLib. +The utilities module provide various functions needed by the linear algebra-module +as well as other module such as methods to compute moving average or the save +square root. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/localization/README.md b/examples/localization/README.md new file mode 100644 index 0000000..2e6c29f --- /dev/null +++ b/examples/localization/README.md @@ -0,0 +1,19 @@ +## Localization examples + +### About + +These examples show how to use the RcdMathLib's localization module composed of +the following sub-modules: position_algos and non_linear_algebra. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/localization/position_algos/distance_based/README.md b/examples/localization/position_algos/distance_based/README.md new file mode 100644 index 0000000..5bfd74d --- /dev/null +++ b/examples/localization/position_algos/distance_based/README.md @@ -0,0 +1,22 @@ +## Examples of localization distance-based algorithms + +### About + +These examples show how to use algorithms of distance-based localization systems. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/localization/position_algos/magnetic_based/README.md b/examples/localization/position_algos/magnetic_based/README.md new file mode 100644 index 0000000..143c848 --- /dev/null +++ b/examples/localization/position_algos/magnetic_based/README.md @@ -0,0 +1,22 @@ +## Examples of localization magnetic-based algorithms + +### About + +These examples show how to use algorithms of magnetic-based localization systems. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/localization/position_algos/pos_algos_common/README.md b/examples/localization/position_algos/pos_algos_common/README.md new file mode 100644 index 0000000..d9f8e8c --- /dev/null +++ b/examples/localization/position_algos/pos_algos_common/README.md @@ -0,0 +1,22 @@ +## Examples of localization common algorithms + +### About + +These examples show how to use common algorithms of localization systems. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/non_linear_algebra/README.md b/examples/non_linear_algebra/README.md new file mode 100644 index 0000000..06cf81d --- /dev/null +++ b/examples/non_linear_algebra/README.md @@ -0,0 +1,19 @@ +## Non-linear algebra examples + +### About + +These examples show how to use the RcdMathLib's non-linear algebra module composed +of the following sub-modules: optimization and solve_non_linear_equations sub-module. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/non_linear_algebra/optimization/README.md b/examples/non_linear_algebra/optimization/README.md new file mode 100644 index 0000000..ec99269 --- /dev/null +++ b/examples/non_linear_algebra/optimization/README.md @@ -0,0 +1,24 @@ +## Optimization algorithms examples + +### About + +These examples show how to use algorithms for optimization. +The algorithms implemented to solve optimization algorithms are based on the modified Gauss-Newton +and the Levenberg�Marquardt algorithms. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + diff --git a/examples/non_linear_algebra/solve_non_linear_equations/README.md b/examples/non_linear_algebra/solve_non_linear_equations/README.md new file mode 100644 index 0000000..02a837f --- /dev/null +++ b/examples/non_linear_algebra/solve_non_linear_equations/README.md @@ -0,0 +1,24 @@ +## Examples of Solving Multi-variant Nonlinear Equation Systems + +### About + +These examples show how to use algorithms for solving multi-variant nonlinear +equation systems. The algorithms implemented to solve multi-variant nonlinear +equation systems are based on the damped or the Newton-Raphson methods. + +### How to run + +Type `make all` to program your board. + +## Note 1 + +The data type used can be set in the matrix.h and vector.h files. The user +can choose between the float or the double data types. We recommend to set +the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + +## Note 2 + +Set the same data type in the the matrix.h and vector.h files to avoid a data +type conflict in the application. + -- GitLab