Ignition Math : Math classes and functions for robot applications
Maintainer: nate AT openrobotics DOT org
| Build | Status |
|---|---|
| Test coverage |  |
| Ubuntu Focal | |
| Homebrew | |
| Windows |
Ignition Math, a component of Ignition Robotics, provides general purpose math classes and functions designed for robotic applications.
Table of Contents
Features
Ignition Math provides a wide range of functionality, including:
- Type-templated pose, matrix, vector, and quaternion classes.
- Shape representations along with operators to compute volume, density, size and other properties.
- Classes for material properties, mass, inertial, temperature, PID, kmeans, spherical coordinates, and filtering.
- Optional Eigen component that converts between a few Eigen and Ignition Math types.
Install
See the installation tutorial.
Usage
Please refer to the examples directory.
Folder Structure
Refer to the following table for information about important directories and files in this repository.
ign-math
├── examples Example programs.
├── include/ignition/math Header files.
├── src Source files and unit tests.
│ └── graph Source files for the graph classes.
│ └── python SWIG Python interfaces.
│ └── ruby SWIG Ruby interfaces.
├── eigen3 Files for Eigen component.
├── test
│ ├── integration Integration tests.
│ ├── performance Performance tests.
│ └── regression Regression tests.
├── tutorials Tutorials, written in markdown.
├── Changelog.md Changelog.
└── CMakeLists.txt CMake build script.
Contributing
Please see CONTRIBUTING.md.
Code of Conduct
Please see CODE_OF_CONDUCT.md.
Versioning
This library uses Semantic Versioning. Additionally, this library is part of the Ignition Robotics project which periodically releases a versioned set of compatible and complimentary libraries. See the Ignition Robotics website for version and release information.
License
This library is licensed under Apache 2.0. See also the LICENSE file.