JuliaDynamics / ChaosTools.jl

Tools for the exploration of chaos and nonlinear dynamics
https://juliadynamics.github.io/DynamicalSystemsDocs.jl/chaostools/stable/
MIT License
186 stars 35 forks source link

typos #304

Closed spaette closed 1 year ago

spaette commented 1 year ago

BREAKING arguments chosen condition disproportionately alleviate exiting exponent immediately indices inefficient isinside minimum typos contributed optimization parallelepiped perturbation preferably possibilities returns satisfy suspicion torus transpose vertex

$ grep -nr BREAKINNG ChaosTools.jl
ChaosTools.jl/CHANGELOG.md:45:* **BREAKINNG** Function `basin_fractions_clustering` is removed.
$ grep -nr argumets ChaosTools.jl    
ChaosTools.jl/src/chaosdetection/expansionentropy.jl:118:Accepts the same argumets as `expansionentropy`, besides `batches`.
$ grep -nr choosen ChaosTools.jl
ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov_from_data.jl:45:have choosen sufficiently good `ks` such that the linear scaling region is bigger
$ grep -nr condtiion ChaosTools.jl
ChaosTools.jl/test/dimreduction/dyca.jl:30:                # eigenvalues satisfy `dyca` condtiion and have imaginary part = 0.0
$ grep -nr continous ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:41:        Hyper-rectangles are not yet supported in continous systems. If you need this,
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:99:        Hyper-rectangles are not yet supported in continous systems. If you need this,
ChaosTools.jl/src/chaosdetection/testchaos01.jl:35:For data sampled from continous dynamical systems, some
$ grep -nr disproportionally ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl:61:are not done here yet, which leads to disproportionally lower performance since
$ grep -nr eliviate ChaosTools.jl
ChaosTools.jl/src/chaosdetection/testchaos01.jl:39:Some possibilities to eliviate this exist, but are context specific on the application.
$ grep -nr exitting ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl:34:For discrete systems, exit time is recorded immediatelly after exitting of the set, and
ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl:44:For discrete systems, exit time is recorded immediatelly after exitting of the set, and
$ grep -nr expontent ChaosTools.jl
ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov.jl:19:  starting to measure the expontent. Should be `Int` for discrete systems.
$ grep -nr immediatelly ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl:34:For discrete systems, exit time is recorded immediatelly after exitting of the set, and
ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl:35:re-entry is recorded immediatelly on re-entry. This means that if an orbit needs
ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl:36:1 step to leave the set and then it re-enters immediatelly on the next step, the return time
ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl:44:For discrete systems, exit time is recorded immediatelly after exitting of the set, and
ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl:45:re-entry is recorded immediatelly on re-entry. This means that if an orbit needs
ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl:46:1 step to leave the set and then it re-enters immediatelly on the next step,
ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov_from_data.jl:44:identify the slope (= ``\\lambda``) immediatelly, assuming you
ChaosTools.jl/src/chaosdetection/partially_predictable.jl:34:  result is returned immediatelly.
$ grep -nr indixes ChaosTools.jl
ChaosTools.jl/src/periodicity/yin.jl:146:Calculates the parabolic (quadratic) interpolation for all the indixes of `y` given in
$ grep -nr inneficient ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_discrete.jl:50:    # A bit inneficient, maybe in the future someone can write a full version here...
$ grep -nr insinside ChaosTools.jl
ChaosTools.jl/src/chaosdetection/expansionentropy.jl:41:defined by the boolean function `insinside`.
$ grep -nr mininum ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:64:        # Obtain mininum distance and check which is the outermost box we are out of
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:123:        # Obtain mininum distance and check if we are out the box
$ grep -nr misstypos ChaosTools.jl
ChaosTools.jl/CHANGELOG.md:289:* Minor bug fixes resulting from misstypos.
$ grep -nr ontributed ChaosTools.jl
ChaosTools.jl/src/chaosdetection/gali.jl:114:# Metaprogramming ontributed by @saschatimme.
$ grep -nr optmization ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:10:To find the closest point we do a minimization/optmization using the integrator
$ grep -nr parallepiped ChaosTools.jl
ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunovspectrum.jl:35:The deviation vectors defining a `D`-dimensional parallepiped in tangent space
ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunovspectrum.jl:38:of the parallepiped. At each step the parallepiped is re-normalized to be orthonormal.
$ grep -nr pertrubation ChaosTools.jl
ChaosTools.jl/src/chaosdetection/lyapunovs/local_growth_rates.jl:9:growth rate is defined simply by `log(g/g0)/Δt` with `g0` the initial pertrubation size
ChaosTools.jl/src/chaosdetection/lyapunovs/local_growth_rates.jl:24:  outputs a pertrubation vector (preferrably `SVector`) given the system, current initial
$ grep -nr posibilities ChaosTools.jl
ChaosTools.jl/src/stability/fixedpoints.jl:37:  see the docs of IntervalRootFinding.jl for all posibilities.
$ grep -nr regurns ChaosTools.jl
ChaosTools.jl/src/periodicity/yin.jl:133:first minimum below the `harmonic_threshod`. If that doesn't exist, it regurns the index of the
$ grep -nr satisy ChaosTools.jl
ChaosTools.jl/test/dimreduction/dyca.jl:32:                # due to floating point errors more than 2 eigenvalues might satisy the above condition
$ grep -nr suspision ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:433:# Furthermore, I have a suspision that calling a callback
$ grep -nr torous ChaosTools.jl
ChaosTools.jl/test/rareevents/return_time_tests.jl:87:    # stability island torous
$ grep -nr tranpose ChaosTools.jl
ChaosTools.jl/src/dimreduction/dyca.jl:92:the tranpose of the input matrix must be given.
$ grep -nr vertix ChaosTools.jl
ChaosTools.jl/src/periodicity/yin.jl:155:    #calculate the vertix coordinates (xv, yv) for each triplet
$ 

Possibly _effect instead of _affect here.

$ grep -nr _affect ChaosTools.jl
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:330:    #     negative_affect!(integ) = push!(entries[i], integ.t)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:331:    #     positive_affect!(integ) = push!(exits[i], integ.t)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:332:    #     cb = ContinuousCallback(crossing, positive_affect!, negative_affect!;
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:341:    negative_affect!(integ) = push!(entries[1], integ.t)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:342:    positive_affect!(integ) = push!(exits[1], integ.t)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:343:    cb = ContinuousCallback(crossing, positive_affect!, negative_affect!;
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:447:    function positive_affect!(integ)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:459:    function negative_affect!(integ)
ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl:473:    cb = ContinuousCallback(crossing, positive_affect!, negative_affect!;
$ 

Should this be threshold?

$ grep -nr thresold ChaosTools.jl
ChaosTools.jl/src/dimreduction/dyca.jl:5:    dyca(data, eig_thresold) -> eigenvalues, proj_mat, projected_data
ChaosTools.jl/src/dimreduction/dyca.jl:48:function dyca(data, eig_thresold::AbstractFloat; norm_eigenvectors::Bool=false)
ChaosTools.jl/src/dimreduction/dyca.jl:62:    eigenvectors = eigenvectors[:, vec(eig_thresold .< abs.(eigenvalues) .<= 1.0)]
ChaosTools.jl/test/dimreduction/dyca.jl:11:        eigenthresold = collect(0.10:0.01:0.995)
ChaosTools.jl/test/dimreduction/dyca.jl:14:        for thresold in eigenthresold
ChaosTools.jl/test/dimreduction/dyca.jl:15:            eigenvalues,_ = dyca(Matrix(ts),thresold)
ChaosTools.jl/test/dimreduction/dyca.jl:22:        eigenthresold = collect(0.90:0.1:0.95)
ChaosTools.jl/test/dimreduction/dyca.jl:26:        for thresold in eigenthresold
ChaosTools.jl/test/dimreduction/dyca.jl:29:                eigenvals,_ = dyca(Embedded_system, thresold)
$ 
Datseris commented 1 year ago

feel free to do a PR for typos!

spaette commented 1 year ago

PR

The typo fixes to comments are straightforward.

For the 2nd and 3rd shell output sections a clarification is sought.

Are negative_affect! and positive_affect! as in the code to attend to results or something new to be changed?

_effect considered applicable in the former

_affect considered applicable in the latter

Are the current spellings _affect and/or _thresold accessed by other packages?

spaette commented 1 year ago

@Datseris

the linked to PR is a Draft as the current Issue includes some unresolved questions

spaette commented 1 year ago

as per your comment on the Draft PR _affect will remain

$ cat typos.sh
#!/bin/sh

sed -i "s/BREAKINNG/BREAKING/g" ChaosTools.jl/CHANGELOG.md
sed -i "s/argumets/arguments/g" ChaosTools.jl/src/chaosdetection/expansionentropy.jl
sed -i "s/choosen/chosen/g" ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov_from_data.jl
sed -i "s/condtiion/condition/g" ChaosTools.jl/test/dimreduction/dyca.jl
sed -i "s/continous/continuous/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl
sed -i "s/continous/continuous/g" ChaosTools.jl/src/chaosdetection/testchaos01.jl
sed -i "s/disproportionally/disproportionately/g" ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl
sed -i "s/eliviate/alleviate/g" ChaosTools.jl/src/chaosdetection/testchaos01.jl
sed -i "s/exitting/exiting/g" ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl
sed -i "s/exitting/exiting/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl
sed -i "s/expontent/exponent/g" ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov.jl
sed -i "s/immediatelly/immediately/g" ChaosTools.jl/src/rareevents/mean_return_times/transit_times_statistics.jl
sed -i "s/immediatelly/immediately/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_api.jl
sed -i "s/immediatelly/immediately/g" ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunov_from_data.jl
sed -i "s/immediatelly/immediately/g" ChaosTools.jl/src/chaosdetection/partially_predictable.jl
sed -i "s/indixes/indices/g" ChaosTools.jl/src/periodicity/yin.jl
sed -i "s/inneficient/inefficient/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_discrete.jl
sed -i "s/insinside/isinside/g" ChaosTools.jl/src/chaosdetection/expansionentropy.jl
sed -i "s/mininum/minimum/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl
sed -i "s/misstypos/typos/g" ChaosTools.jl/CHANGELOG.md
sed -i "s/ontributed/contributed/g" ChaosTools.jl/src/chaosdetection/gali.jl
sed -i "s/optmization/optimization/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl
sed -i "s/parallepiped/parallelepiped/g" ChaosTools.jl/src/chaosdetection/lyapunovs/lyapunovspectrum.jl
sed -i "s/pertrubation/perturbation/g" ChaosTools.jl/src/chaosdetection/lyapunovs/local_growth_rates.jl
sed -i "s/posibilities/possibilities/g" ChaosTools.jl/src/stability/fixedpoints.jl
sed -i "s/regurns/returns/g" ChaosTools.jl/src/periodicity/yin.jl
sed -i "s/satisy/satisfy/g" ChaosTools.jl/test/dimreduction/dyca.jl
sed -i "s/suspision/suspicion/g" ChaosTools.jl/src/rareevents/mean_return_times/mrt_continuous.jl
sed -i "s/thresold/threshold/g" ChaosTools.jl/src/dimreduction/dyca.jl
sed -i "s/thresold/threshold/g" ChaosTools.jl/test/dimreduction/dyca.jl
sed -i "s/torous/torus/g" ChaosTools.jl/test/rareevents/return_time_tests.jl
sed -i "s/tranpose/transpose/g" ChaosTools.jl/src/dimreduction/dyca.jl
sed -i "s/vertix/vertex/g" ChaosTools.jl/src/periodicity/yin.jl
$