Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
  • Loading branch information
isamu-takagi committed Feb 27, 2025
1 parent e7676ba commit 1de1415
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
11 changes: 0 additions & 11 deletions autoware_utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,6 @@ The geometry module provides classes and functions for handling 2D and 3D points
- Intersection checks for convex polygons using GJK.
- Conversion between different coordinate systems.

#### Math Module

The math module offers a variety of mathematical utilities:

- **`accumulator.hpp`**: A class for accumulating statistical data, supporting min, max, and mean calculations.
- **`constants.hpp`**: Defines commonly used mathematical constants like π and gravity.
- **`normalization.hpp`**: Functions for normalizing angles and degrees.
- **`range.hpp`**: Functions for generating sequences of numbers (arange, linspace).
- **`trigonometry.hpp`**: Optimized trigonometric functions for faster computation.
- **`unit_conversion.hpp`**: Functions for converting between different units (e.g., degrees to radians, km/h to m/s).

#### ROS Module

The ROS module provides utilities for working with ROS messages and nodes:
Expand Down
11 changes: 8 additions & 3 deletions autoware_utils_math/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
## Overview

The **autoware_utils_math** library is a comprehensive toolkit designed to facilitate the development of autonomous driving applications.
This package provides essential utilities for geometry.
It is extensively used in the Autoware project to handle common tasks such as geometric calculations and message conversions.
This package provides essential utilities for mathematics.
It is extensively used in the Autoware project to handle common tasks such as value normalization and unit conversion.

## Design

- **`transform_listener.hpp`**: Manages transformation listeners.
- **`accumulator.hpp`**: A class for accumulating statistical data, supporting min, max, and mean calculations.
- **`constants.hpp`**: Defines commonly used mathematical constants like π and gravity.
- **`normalization.hpp`**: Functions for normalizing angles and degrees.
- **`range.hpp`**: Functions for generating sequences of numbers (arange, linspace).
- **`trigonometry.hpp`**: Optimized trigonometric functions for faster computation.
- **`unit_conversion.hpp`**: Functions for converting between different units (e.g., degrees to radians, km/h to m/s).

0 comments on commit 1de1415

Please sign in to comment.