diff --git a/README.md b/README.md index 01c2a4a..510bd51 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,5 @@ The functions are available in: Each function has a commented section above it explaining the inputs required for its use as well as an example of how it can be used and what the output will be. This repository also contains a pdf document that provides an overview of the available functions using MATLAB syntax. Functions are organized according to the chapter in which they are introduced in the book. Basic functions, such as functions to calculate the magnitude of a vector, normalize a vector, test if the value is near zero, and perform matrix operations such as multiplication and inverses, are not documented here. The primary purpose of the provided software is to be easy to read and educational, reinforcing the concepts in the book. The code is optimized neither for efficiency nor robustness. + +An unofficial C++ version is developing in [this repository](https://github.com/Le0nX/ModernRoboticsCpp). Any contribution is welcomed but the maintenance team for this library here doesn't vouch for the reliability of that project. \ No newline at end of file diff --git a/packages/Python/README.md b/packages/Python/README.md index 79312d4..a6b2a7e 100644 --- a/packages/Python/README.md +++ b/packages/Python/README.md @@ -1,5 +1,9 @@ # "modern_robotics" Python Package Instructions # +## Dependency Requirement + +`numpy` should be preinstalled. + ## Installing the Package ## ### Recommended Method ### diff --git a/packages/Python/modern_robotics/core.py b/packages/Python/modern_robotics/core.py index 18cb64e..4b44235 100644 --- a/packages/Python/modern_robotics/core.py +++ b/packages/Python/modern_robotics/core.py @@ -531,7 +531,7 @@ def TestIfSO3(mat): def TestIfSE3(mat): """Returns true if mat is close to or on the manifold SE(3) - :param mat: A 3x3 matrix + :param mat: A 4x4 matrix :return: True if mat is very close to or in SE(3), false otherwise Computes the distance d from mat to the SE(3) manifold using the following method: