Merge branch 'master' into rmcis

Author: sethaxen

.github/workflows/Invalidations.yml

@@ -0,0 +1,40 @@
+name: Invalidations
+
+on:
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: always.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  evaluate:
+    # Only run on PRs to the default branch.
+    # In the PR trigger above branches can be specified only explicitly whereas this check should work for master, main, or any other default branch
+    if: github.base_ref == github.event.repository.default_branch
+    runs-on: ubuntu-latest
+    steps:
+    - uses: julia-actions/setup-julia@v1
+      with:
+        version: '1'
+    - uses: actions/checkout@v3
+    - uses: julia-actions/julia-buildpkg@v1
+    - uses: julia-actions/julia-invalidations@v1
+      id: invs_pr
+
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.repository.default_branch }}
+    - uses: julia-actions/julia-buildpkg@v1
+    - uses: julia-actions/julia-invalidations@v1
+      id: invs_default
+    
+    - name: Report invalidation counts
+      run: |
+        echo "Invalidations on default branch: ${{ steps.invs_default.outputs.total }} (${{ steps.invs_default.outputs.deps }} via deps)" >> $GITHUB_STEP_SUMMARY
+        echo "This branch: ${{ steps.invs_pr.outputs.total }} (${{ steps.invs_pr.outputs.deps }} via deps)" >> $GITHUB_STEP_SUMMARY
+    - name: Check if the PR does increase number of invalidations
+      if: steps.invs_pr.outputs.total > steps.invs_default.outputs.total
+      run: exit 1

CONTRIBUTION.md

@@ -1,20 +1,20 @@
-##### Quaternions.jl is released under the MIT License (MIT):
+MIT License
 
-> Copyright (c) 2013 Forio and [other contributors](https://github.com/forio/Quaternions.jl/graphs/contributors)
+Copyright (c) 2013 Forio and [Quaternions.jl contributors](https://github.com/JuliaGeometry/Quaternions.jl/graphs/contributors)
 
-> Permission is hereby granted, free of charge, to any person obtaining a copy of
-> this software and associated documentation files (the "Software"), to deal in
-> the Software without restriction, including without limitation the rights to
-> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-> the Software, and to permit persons to whom the Software is furnished to do so,
-> subject to the following conditions:
->
-> The above copyright notice and this permission notice shall be included in all
-> copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-> FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-> COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-> IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.md

@@ -1,6 +1,6 @@
 name = "Quaternions"
 uuid = "94ee1d12-ae83-5a48-8b1c-48b8ff168ae0"
-version = "0.5.2"
+version = "0.5.7"
 
 [deps]
 DualNumbers = "fa6b7ba4-c1ee-5f82-b5fc-ecf0adba8f74"

Project.toml

@@ -13,7 +13,7 @@ Implemented functions are:
 
     +-*/^
     real
-    imag  (a vector)
+    imag_part  (tuple)
     conj
     abs
     abs2
@@ -58,51 +58,9 @@ Implemented functions are:
     cospi
     sincos
     sincospi
-    linpol  (interpolate between 2 normalized quaternions)
+    slerp
     rand
     randn
 
-[Dual quaternions](http://en.wikipedia.org/wiki/Dual_quaternion) are an extension, combining quaternions with
-[dual numbers](https://github.com/scidom/DualNumbers.jl).
-On top of just orientation, they can represent all rigid transformations.
-
-There are two conjugation concepts here
-
-    conj  (quaternion conjugation)
-    dconj (dual conjugation)
-
-further implemented here:
-
-    Q0  (the 'real' quaternion)
-    Qe  ( the 'dual' part)
-    +-*/^
-    abs
-    abs2
-    normalize
-    normalizea
-    angleaxis
-    angle
-    axis
-    exp
-    log
-    sqrt
-    rand
-
-[Octonions](http://en.wikipedia.org/wiki/Octonion) form the logical next step on the Complex-Quaternion path.
-They play a role, for instance, in the mathematical foundation of String theory.
-
-    +-*/^
-    real
-    imag  (a vector)
-    conj
-    abs
-    abs2
-    exp
-    log
-    normalize
-    normalizea  (return normalized octonion and absolute value as a tuple)
-    exp
-    log
-    sqrt
-    rand
-    randn
+Currently, this package supports `DualQuaternion` and `Octonion` types, but these will be removed in the next breaking release.
+See https://github.com/JuliaGeometry/Quaternions.jl/issues/90 and https://github.com/JuliaGeometry/Quaternions.jl/pull/92 for more information.

README.md

@@ -0,0 +1,35 @@
+using Luxor, Colors
+
+L = 500
+R = 130
+r = 25
+t = 18
+h = 0.33
+
+path_svg = joinpath(@__DIR__, "src", "assets", "logo.svg")
+path_ico = joinpath(@__DIR__, "src", "assets", "favicon.ico")
+
+@svg begin
+	Drawing(L, L, path_svg)
+	setlinecap("round")
+	setlinejoin("round")
+	p₊ = Point(cos(π/6), -sin(π/6)) * 2R/√3
+	p₋ = -p₊/2
+	angles = (-2π/3, -π/3, 0, π/3, 4π/3)
+
+	for i in 1:3
+		origin(L/2, L/2)
+		rotate(4π/3*(i-1))
+		sethue(Colors.JULIA_LOGO_COLORS[(:red, :purple, :green)[i]])
+		circle(p₋, r, :fill)
+		circle(p₊, r, :fill)
+		setline(t)
+		for j in 1:4
+			arc(p₋, R, angles[j]+h, angles[j+1]-h, :stroke)
+		end
+		setline(t/2)
+		poly(ngon(p₋*(1+√3), t, 3, π), :stroke, close=true)
+	end
+end
+
+run(`convert -density 256x256 -background transparent $(path_svg) -define icon:auto-resize -colors 256 $(path_ico)`)

docs/logo.jl

@@ -10,7 +10,7 @@ makedocs(;
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
         canonical="https://JuliaGeometry.github.io/Quaternions.jl",
-        assets = ["assets/custom.css"],
+        assets = ["assets/custom.css", "assets/favicon.ico"],
     ),
     pages=[
         "Home" => "index.md",

docs/make.jl

@@ -0,0 +1,4 @@
+#documenter .docs-sidebar .docs-logo > img,
+html.theme--documenter-dark #documenter .docs-sidebar .docs-logo > img {
+    max-height: 9rem;
+}