Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ign -> gz Namespace Migration : gz-math #430

Merged
merged 24 commits into from
May 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See the [Ignition Robotics contributing guide](https://ignitionrobotics.org/docs/all/contributing).
See the [Gazebo contributing guide](https://gazebosim.org/docs/all/contributing).
452 changes: 226 additions & 226 deletions Changelog.md

Large diffs are not rendered by default.

79 changes: 41 additions & 38 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Deprecated code produces compile-time warnings. These warning serve as
notification to users that their code should be upgraded. The next major
release will remove the deprecated code.

## Ignition Math 6.X to 7.X
## Gazebo Math 6.X to 7.X

### Breaking Changes

Expand Down Expand Up @@ -61,24 +61,27 @@ release will remove the deprecated code.
1. **Helpers.hh**
+ **Deprecation:** template<typename T> inline void appendToStream(std::ostream, T, int)
+ **Replacement:** template<typename T> inline void appendToStream(std::ostream, T)
1. The `ignition` namespace is deprecated and will be removed in future versions. Use `gz` instead.
1. Header files under `ignition/...` are deprecated and will be removed in future versions.
Use `gz/...` instead.

### Modifications

1. The out stream operator is guaranteed to return always plain 0 and not to
return -0, 0.0 or other instances of zero value.

## Ignition Math 6.9.2 to 6.10.0
## Gazebo Math 6.9.2 to 6.10.0

1. **Color::HSV()**: A bug related to the hue output of this function was fixed.

## Ignition Math 6.8 to 6.9
## Gazebo Math 6.8 to 6.9

1. **SphericalCoordinates**: A bug related to the LOCAL frame was fixed. To
preserve behaviour, the `LOCAL` frame was left with the bug, and a new
`LOCAL2` frame was introduced, which can be used to get the correct
calculations.

## Ignition Math 4.X to 5.X
## Gazebo Math 4.X to 5.X

### Additions

Expand Down Expand Up @@ -124,7 +127,7 @@ release will remove the deprecated code.
1. **Inertial.hh**
+ The MOI functions have been renamed to Moi.

## Ignition Math 3.X to 4.X
## Gazebo Math 3.X to 4.X

### Added dependencies

Expand Down Expand Up @@ -161,7 +164,7 @@ release will remove the deprecated code.
+ ***Deprecation:*** public: void Translate(T _x, T _y, T _z)
+ ***Replacement:*** public: void SetTranslation(T _x, T _y, T _z)

## Ignition Math 2.X to 3.X
## Gazebo Math 2.X to 3.X

### Modifications

Expand All @@ -181,97 +184,97 @@ release will remove the deprecated code.

1. **Helpers.hh**
+ ***Deprecation:*** IGN_DBL_MAX
+ ***Replacement:*** ignition::math::MAX_D
+ ***Replacement:*** gz::math::MAX_D

+ ***Deprecation:*** IGN_DBL_MIN
+ ***Replacement:*** ignition::math::MIN_D
+ ***Replacement:*** gz::math::MIN_D

+ ***Deprecation:*** IGN_DBL_LOW
+ ***Replacement:*** ignition::math::LOW_D
+ ***Replacement:*** gz::math::LOW_D

+ ***Deprecation:*** IGN_DBL_INF
+ ***Replacement:*** ignition::math::INF_D
+ ***Replacement:*** gz::math::INF_D

+ ***Deprecation:*** IGN_FLT_MAX
+ ***Replacement:*** ignition::math::MAX_F
+ ***Replacement:*** gz::math::MAX_F

+ ***Deprecation:*** IGN_FLT_MIN
+ ***Replacement:*** ignition::math::MIN_F
+ ***Replacement:*** gz::math::MIN_F

+ ***Deprecation:*** IGN_FLT_LOW
+ ***Replacement:*** ignition::math::LOW_F
+ ***Replacement:*** gz::math::LOW_F

+ ***Deprecation:*** IGN_FLT_INF
+ ***Replacement:*** ignition::math::INF_F
+ ***Replacement:*** gz::math::INF_F

+ ***Deprecation:*** IGN_UI16_MAX
+ ***Replacement:*** ignition::math::MAX_UI16
+ ***Replacement:*** gz::math::MAX_UI16

+ ***Deprecation:*** IGN_UI16_MIN
+ ***Replacement:*** ignition::math::MIN_UI16
+ ***Replacement:*** gz::math::MIN_UI16

+ ***Deprecation:*** IGN_UI16_LOW
+ ***Replacement:*** ignition::math::LOW_UI16
+ ***Replacement:*** gz::math::LOW_UI16

+ ***Deprecation:*** IGN_UI16_INF
+ ***Replacement:*** ignition::math::INF_UI16
+ ***Replacement:*** gz::math::INF_UI16

+ ***Deprecation:*** IGN_I16_MAX
+ ***Replacement:*** ignition::math::MAX_I16
+ ***Replacement:*** gz::math::MAX_I16

+ ***Deprecation:*** IGN_I16_MIN
+ ***Replacement:*** ignition::math::MIN_I16
+ ***Replacement:*** gz::math::MIN_I16

+ ***Deprecation:*** IGN_I16_LOW
+ ***Replacement:*** ignition::math::LOW_I16
+ ***Replacement:*** gz::math::LOW_I16

+ ***Deprecation:*** IGN_I16_INF
+ ***Replacement:*** ignition::math::INF_I16
+ ***Replacement:*** gz::math::INF_I16

+ ***Deprecation:*** IGN_UI32_MAX
+ ***Replacement:*** ignition::math::MAX_UI32
+ ***Replacement:*** gz::math::MAX_UI32

+ ***Deprecation:*** IGN_UI32_MIN
+ ***Replacement:*** ignition::math::MIN_UI32
+ ***Replacement:*** gz::math::MIN_UI32

+ ***Deprecation:*** IGN_UI32_LOW
+ ***Replacement:*** ignition::math::LOW_UI32
+ ***Replacement:*** gz::math::LOW_UI32

+ ***Deprecation:*** IGN_UI32_INF
+ ***Replacement:*** ignition::math::INF_UI32
+ ***Replacement:*** gz::math::INF_UI32

+ ***Deprecation:*** IGN_I32_MAX
+ ***Replacement:*** ignition::math::MAX_I32
+ ***Replacement:*** gz::math::MAX_I32

+ ***Deprecation:*** IGN_I32_MIN
+ ***Replacement:*** ignition::math::MIN_I32
+ ***Replacement:*** gz::math::MIN_I32

+ ***Deprecation:*** IGN_I32_LOW
+ ***Replacement:*** ignition::math::LOW_I32
+ ***Replacement:*** gz::math::LOW_I32

+ ***Deprecation:*** IGN_I32_INF
+ ***Replacement:*** ignition::math::INF_I32
+ ***Replacement:*** gz::math::INF_I32

+ ***Deprecation:*** IGN_UI64_MAX
+ ***Replacement:*** ignition::math::MAX_UI64
+ ***Replacement:*** gz::math::MAX_UI64

+ ***Deprecation:*** IGN_UI64_MIN
+ ***Replacement:*** ignition::math::MIN_UI64
+ ***Replacement:*** gz::math::MIN_UI64

+ ***Deprecation:*** IGN_UI64_LOW
+ ***Replacement:*** ignition::math::LOW_UI64
+ ***Replacement:*** gz::math::LOW_UI64

+ ***Deprecation:*** IGN_UI64_INF
+ ***Replacement:*** ignition::math::INF_UI64
+ ***Replacement:*** gz::math::INF_UI64

+ ***Deprecation:*** IGN_I64_MAX
+ ***Replacement:*** ignition::math::MAX_I64
+ ***Replacement:*** gz::math::MAX_I64

+ ***Deprecation:*** IGN_I64_MIN
+ ***Replacement:*** ignition::math::MIN_I64
+ ***Replacement:*** gz::math::MIN_I64

+ ***Deprecation:*** IGN_I64_LOW
+ ***Replacement:*** ignition::math::LOW_I64
+ ***Replacement:*** gz::math::LOW_I64

+ ***Deprecation:*** IGN_I64_INF
+ ***Replacement:*** ignition::math::INF_I64
+ ***Replacement:*** gz::math::INF_I64
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Ignition Math : Math classes and functions for robot applications
# Gazebo Math : Math classes and functions for robot applications

**Maintainer:** nate AT openrobotics DOT org

[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-math.svg)](https://github.com/ignitionrobotics/ign-math/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-math.svg)](https://github.com/ignitionrobotics/ign-math/pulls)
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-math.svg)](https://github.com/gazebosim/gz-math/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-math.svg)](https://github.com/gazebosim/gz-math/pulls)
[![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Build | Status
-- | --
Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-math/branch/ign-math7/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-math)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-math/branch/ign-math7/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-math)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-ign-math7-focal-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-ign-math7-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math-ci-ign-math7-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_math-ci-ign-math7-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_math-ign-7-win)](https://build.osrfoundation.org/job/ign_math-ign-7-win)

Ignition Math, a component of [Ignition
Robotics](https://ignitionrobotics.org), provides general purpose math
Gazebo Math, a component of [Ignition
Robotics](https://gazebosim.org), provides general purpose math
classes and functions designed for robotic applications.

# Table of Contents
Expand All @@ -38,7 +38,7 @@ classes and functions designed for robotic applications.

# Features

Ignition Math provides a wide range of functionality, including:
Gazebo 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.
Expand All @@ -48,11 +48,11 @@ Math types.

# Install

See the [installation tutorial](https://ignitionrobotics.org/api/math/6.8/install.html).
See the [installation tutorial](https://gazebosim.org/api/math/6.8/install.html).

# Usage

Please refer to the [examples directory](https://github.com/ignitionrobotics/ign-math/raw/ign-math7/examples/).
Please refer to the [examples directory](https://github.com/gazebosim/gz-math/raw/ign-math7/examples/).

# Folder Structure

Expand All @@ -78,17 +78,17 @@ ign-math
# Contributing

Please see
[CONTRIBUTING.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md).
[CONTRIBUTING.md](https://github.com/gazebosim/gz-sim/blob/main/CONTRIBUTING.md).

# Code of Conduct

Please see
[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md).
[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-sim/blob/main/CODE_OF_CONDUCT.md).

# Versioning

This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition Robotics project](https://ignitionrobotics.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for version and release information.
This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information.

# License

This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/ignitionrobotics/ign-math/blob/main/LICENSE) file.
This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-math/blob/main/LICENSE) file.
2 changes: 1 addition & 1 deletion api.md.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Ignition @IGN_DESIGNATION_CAP@

Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of
Ignition @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of
libraries designed to rapidly develop robot and simulation applications.
This library defines a general set of math classes and functions with an eye
toward simulation and robotics.
Expand Down
Loading