Skip to content

Commit e159f1c

Browse files
committed
🔖 Update CHANGELOG.md - Version 0.4.0
Note: the new CHANGELOG.md format using badges was inspired by the CHANGELOG.md file of JuliaDocs/Documenter.jl project.
1 parent dafbe55 commit e159f1c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CHANGELOG.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
ReferenceFrameRotations.jl Changelog
22
====================================
33

4+
Version 0.4.0
5+
-------------
6+
7+
- ![BREAKING][badge-breaking] The function `dcm2quat` forced the returned
8+
Quaternion to be of the same type of DCM. However, since some floating-point
9+
operations are required to convert between these two rotation representation,
10+
then it could lead to `InexactError` exception. Old code that depends on the
11+
quaternion type returned from `dcm2quat` may break.
12+
- ![BREAKING][badge-breaking] `DCM{T}` was defined as `SMatrix{3,3,T}`. However,
13+
this can lead to type-unstable functions in some cases. Hence, the definition
14+
was changed to `SMatrix{3,3,T,9}`. Code using `DCM{T}` will continue to work
15+
without problems.
16+
- ![Deprecation][badge-deprecation] The function `eye` has been marked as
17+
deprecated in favor of the initialization using the `UniformScalling` (`I`)
18+
object.
19+
- ![Bugfix][badge-bugfix] The `norm` function was not being exported.
20+
- ![Feature][badge-feature] The left and right division operations between two
21+
quaternions was defined. Hence, the operation `inv(q)*v*q` can be now written
22+
in the more compact form `q\v*q`.
23+
- ![Enhancement][badge-enhancement] DCMs and Quaternions now fully support the
24+
`UniformScalling` object for initialization and operations. Hence, an identity
25+
DCM can be created using `DCM(I)` and an identity quaternion can be created
26+
using `Quaternion(I)`.
27+
- ![Enhancement][badge-enhancement] The structures and operations no longer
28+
restrict the type of the rotation representation to be real numbers. Hence, it
29+
is now possible to perform, for example, the multiplication between two
30+
integer quaternions. The type of the result will be automatically inferred.
31+
- ![Info][badge-info] The package is not tested against Julia 0.7 anymore.
32+
Although it is still supposed to work with Julia 0.7, it is **highly**
33+
advisable to use Julia 1.0 or higher.
34+
- ![Info][badge-info] The documentation of the functions was modified to be less
35+
verbose.
36+
437
Version 0.3.0
538
-------------
639

@@ -71,3 +104,10 @@ Version 0.1.0
71104
* This version was based on the old package **Rotations.jl v0.4.0** that
72105
was renamed to **ReferenceFrameRotations** to be submitted to julia
73106
METADATA repo.
107+
108+
[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
109+
[badge-deprecation]: https://img.shields.io/badge/Deprecation-orange.svg
110+
[badge-feature]: https://img.shields.io/badge/Feature-green.svg
111+
[badge-enhancement]: https://img.shields.io/badge/Enhancement-blue.svg
112+
[badge-bugfix]: https://img.shields.io/badge/Bugfix-purple.svg
113+
[badge-info]: https://img.shields.io/badge/Info-gray.svg

0 commit comments

Comments
 (0)