Merge pull request #55 from bmad-sim/dev1

Mixing ComplexTPS/TPS allowed, significant cleanup of operators.jl, unit testing

.github/workflows/CI.yml

@@ -18,11 +18,14 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.8'
+          #- '1.8'
           - '1.9'
-          - 'nightly'
+          - '1.10'
+          #- 'nightly'
         os:
           - ubuntu-latest
+          #- macos-latest
+          #- windows-latest
         arch:
           - x64
     steps:

Project.toml

@@ -12,7 +12,10 @@ julia = "1.8"
 
 [extras]
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
+ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
+TaylorSeries = "6aa5eb33-94cf-58f4-a9d0-e4b2c4fc25ea"
+BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Downloads"]
+test = ["Test", "Downloads", "ForwardDiff", "TaylorSeries", "BenchmarkTools"]

README.md

@@ -11,7 +11,7 @@ GTPSA, which uses the Truncated Power Series Algebra method for performing autom
 4. **Distinction Between "Variables" and "Parameters"**: When the TPS represents a *Taylor map* of a dynamical system, which defines the evolution of map *variables* given some variations in map *parameters*, distinguishing between the two proves advantageous for analyses of Taylor maps, such as normal form
 
 
-**GTPSA is fast!** See the `benchmark/fodo.jl` example for a speed comparison of `GTPSA.jl` with `ForwardDiff.jl` and `TaylorSeries.jl` in calculating a multivariable Taylor map to 2nd order.
+**GTPSA is fast!** See the `benchmark/taylormap.jl` example for a speed comparison of `GTPSA.jl` with `ForwardDiff.jl` and `TaylorSeries.jl` in calculating a multivariable Taylor map to 2nd order.
 
 ## Setup
 To use `GTPSA.jl`, in the Julia REPL run

benchmark/fodo.jl → benchmark/taylormap.jl

@@ -116,24 +116,29 @@ function benchmark_ForwardDiff()
     coefs[4 ,i] = mpy(0,0,0,0,k1_0,0)
     coefs[5 ,i] = mk1(0,0,0,0,k1_0,0)
     coefs[6 ,i] = mk2l(0,0,0,0,k1_0,0)
+
     coefs[7 ,i] = mxx(0,0,0,0,k1_0,0)
     coefs[8 ,i] = mpxpx(0,0,0,0,k1_0,0)
     coefs[9 ,i] = myy(0,0,0,0,k1_0,0)   
     coefs[10,i] = mpypy(0,0,0,0,k1_0,0) 
     coefs[11,i] = mk1k1(0,0,0,0,k1_0,0) 
     coefs[12,i] = mk2lk2l(0,0,0,0,k1_0,0)
+
     coefs[13,i] = mxpx(0,0,0,0,k1_0,0)  
     coefs[14,i] = mxy(0,0,0,0,k1_0,0)   
     coefs[15,i] = mxpy(0,0,0,0,k1_0,0)  
     coefs[16,i] = mxk1(0,0,0,0,k1_0,0)  
     coefs[17,i] = mxk2l(0,0,0,0,k1_0,0) 
+
     coefs[18,i] = mpxy(0,0,0,0,k1_0,0)  
     coefs[19,i] = mpxpy(0,0,0,0,k1_0,0) 
     coefs[20,i] = mpxk1(0,0,0,0,k1_0,0) 
     coefs[21,i] = mpxk2l(0,0,0,0,k1_0,0)
+
     coefs[22,i] = mypy(0,0,0,0,k1_0,0)  
     coefs[23,i] = myk1(0,0,0,0,k1_0,0)  
-    coefs[24,i] = myk2l(0,0,0,0,k1_0,0) 
+    coefs[24,i] = myk2l(0,0,0,0,k1_0,0)
+
     coefs[25,i] = mpyk1(0,0,0,0,k1_0,0) 
     coefs[26,i] = mpyk2l(0,0,0,0,k1_0,0)
     coefs[27,i] = mk1k2l(0,0,0,0,k1_0,0)
@@ -155,6 +160,6 @@ function benchmark_TaylorSeries()
 end
 
 
-m_GTPSA = @btime benchmark_GTPSA()
-m_ForwardDiff = @btime benchmark_ForwardDiff()
-m_TaylorSeries = @btime benchmark_TaylorSeries()
+#m_GTPSA = @btime benchmark_GTPSA()
+#m_ForwardDiff = @btime benchmark_ForwardDiff()
+#m_TaylorSeries = @btime benchmark_TaylorSeries()

docs/src/index.md

@@ -12,7 +12,7 @@ GTPSA, which uses the Truncated Power Series Algebra method for performing autom
 4. **Distinction Between "Variables" and "Parameters"**: When the TPS represents a *Taylor map* of a dynamical system, which defines the evolution of map *variables* given some variations in map *parameters*, distinguishing between the two proves advantageous for analyses of Taylor maps, such as normal form
 
 
-**GTPSA is fast!** See the `benchmark/fodo.jl` example for a speed comparison of `GTPSA.jl` with `ForwardDiff.jl` and `TaylorSeries.jl` in calculating a multivariable Taylor map to 2nd order.
+**GTPSA is fast!** See the `benchmark/taylormap.jl` example for a speed comparison of `GTPSA.jl` with `ForwardDiff.jl` and `TaylorSeries.jl` in calculating a multivariable Taylor map to 2nd order.
 
 ## Setup
 To use `GTPSA.jl`, in the Julia REPL run

docs/src/usage.md

@@ -77,8 +77,8 @@ z2[params=(2=>1,)] = 1  # Set first-order part for second parameter equal to 1
 z2 == k2                # Is true
 ```
 
-## Using Complex TPSs
+## Promotion of TPS to ComplexTPS
 
-Mixing `ComplexTPS`s with `TPS`s is currently not allowed, however this may be added in the future. The usage for `ComplexTPS`s is the same as with regular `TPS`s, with the addition of some extra functions including `real` and `imag`.
+`TPS`s and `ComplexTPS`s can be mixed freely without concern. Any time an operation with a `TPS` and a `ComplexTPS` or a `Complex` number occurs, the result will be a `ComplexTPS`. A `ComplexTPS` can be converted back to a `TPS` using the `real` and `imag` operators.