Skip to content
Snippets Groups Projects
Commit eb6caec0 authored by zkasmi's avatar zkasmi
Browse files

Readme files added to examples.

parent d8b14cc8
No related branches found
No related tags found
No related merge requests found
Showing
with 282 additions and 0 deletions
## 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.
## 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
## 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
## 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
## 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.
## 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.
## 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.
## 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.
## 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.
## 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.
## 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.
## 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.
## 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment