Move the declarations of all keyword arguments into kw.hpp.

Also rename the pendulum length kawrg form kw::l to kw::length.
bluescarni · Dec 10, 2023 · 0b10735 · 0b10735
1 parent a53f34c
commit 0b10735
Show file tree

Hide file tree

Showing 141 changed files with 197 additions and 101 deletions.
diff --git a/benchmark/burrau_3bp.cpp b/benchmark/burrau_3bp.cpp
@@ -20,6 +20,7 @@
 #include <xtensor/xadapt.hpp>
 #include <xtensor/xview.hpp>
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/event_allocations.cpp b/benchmark/event_allocations.cpp
@@ -15,6 +15,7 @@
 #include <boost/program_options.hpp>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/math/sin.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/event_overhead.cpp b/benchmark/event_overhead.cpp
@@ -12,6 +12,7 @@
 #include <iostream>
 #include <vector>
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/hh_event.cpp b/benchmark/hh_event.cpp
@@ -15,6 +15,7 @@
 #include <boost/program_options.hpp>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/taylor.hpp>
 
 #include "benchmark_utils.hpp"

diff --git a/benchmark/large_cfunc.cpp b/benchmark/large_cfunc.cpp
@@ -14,6 +14,7 @@
 #include <vector>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/llvm_state.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/model/mascon.hpp>

diff --git a/benchmark/mascon_models.cpp b/benchmark/mascon_models.cpp
@@ -14,7 +14,6 @@
 #include <iostream>
 #include <vector>
 
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/expression.hpp>
 #include <heyoka/kw.hpp>
 #include <heyoka/llvm_state.hpp>

diff --git a/benchmark/mb.cpp b/benchmark/mb.cpp
@@ -26,6 +26,7 @@
 #include <spdlog/stopwatch.h>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/outer_ss_long_term.cpp b/benchmark/outer_ss_long_term.cpp
@@ -39,6 +39,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/outer_ss_long_term_batch.cpp b/benchmark/outer_ss_long_term_batch.cpp
@@ -40,6 +40,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/pcr3bp.cpp b/benchmark/pcr3bp.cpp
@@ -12,6 +12,7 @@
 #include <tuple>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/math/pow.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/pendulum_bench.cpp b/benchmark/pendulum_bench.cpp
@@ -11,6 +11,7 @@
 #include <iostream>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/math/sin.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/pendulum_mp.cpp b/benchmark/pendulum_mp.cpp
@@ -17,6 +17,7 @@
 #include <mp++/real.hpp>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/math/sin.hpp>
 #include <heyoka/taylor.hpp>

diff --git a/benchmark/pendulum_quad.cpp b/benchmark/pendulum_quad.cpp
@@ -17,6 +17,7 @@
 #include <mp++/real128.hpp>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/math/sin.hpp>
 #include <heyoka/taylor.hpp>

diff --git a/benchmark/sims_flanagan_jac.cpp b/benchmark/sims_flanagan_jac.cpp
@@ -20,6 +20,7 @@
 #include <spdlog/spdlog.h>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/llvm_state.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/math/cos.hpp>

diff --git a/benchmark/ss_3bp.cpp b/benchmark/ss_3bp.cpp
@@ -18,6 +18,7 @@
 #include <boost/program_options.hpp>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/ss_event_overhead.cpp b/benchmark/ss_event_overhead.cpp
@@ -41,6 +41,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/ss_maker.cpp b/benchmark/ss_maker.cpp
@@ -35,6 +35,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/logging.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>

diff --git a/benchmark/taylor_jl_01.cpp b/benchmark/taylor_jl_01.cpp
@@ -12,6 +12,7 @@
 #include <iostream>
 
 #include <heyoka/expression.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/taylor.hpp>
 
 #include "benchmark_utils.hpp"

diff --git a/benchmark/two_body_step.cpp b/benchmark/two_body_step.cpp
@@ -30,6 +30,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/benchmark/two_body_step_batch.cpp b/benchmark/two_body_step_batch.cpp
@@ -25,6 +25,7 @@
 
 #endif
 
+#include <heyoka/kw.hpp>
 #include <heyoka/model/nbody.hpp>
 #include <heyoka/taylor.hpp>
 

diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -7,6 +7,9 @@ Changelog
 Changes
 ~~~~~~~
 
+- Move the declarations of all :ref:`keyword arguments <kwargs>`
+  into the ``kw.hpp`` header
+  (`#372 <https://github.com/bluescarni/heyoka/pull/372>`__).
 - The call operators of the event callbacks are not
   ``const`` any more
   (`#369 <https://github.com/bluescarni/heyoka/pull/369>`__).

diff --git a/include/heyoka/expression.hpp b/include/heyoka/expression.hpp
@@ -47,7 +47,6 @@
 
 #include <heyoka/detail/func_cache.hpp>
 #include <heyoka/detail/fwd_decl.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/llvm_fwd.hpp>
 #include <heyoka/detail/type_traits.hpp>
 #include <heyoka/detail/visibility.hpp>
@@ -424,14 +423,6 @@ HEYOKA_DLL_PUBLIC expression diff(const expression &, const param &);
 HEYOKA_DLL_PUBLIC expression diff(const expression &, const std::string &);
 HEYOKA_DLL_PUBLIC expression diff(const expression &, const expression &);
 
-namespace kw
-{
-
-IGOR_MAKE_NAMED_ARGUMENT(diff_args);
-IGOR_MAKE_NAMED_ARGUMENT(diff_order);
-
-} // namespace kw
-
 namespace detail
 {
 
@@ -713,14 +704,6 @@ function_decompose(const std::vector<expression> &);
 HEYOKA_DLL_PUBLIC std::vector<expression> function_decompose(const std::vector<expression> &,
                                                              const std::vector<expression> &);
 
-namespace kw
-{
-
-IGOR_MAKE_NAMED_ARGUMENT(vars);
-IGOR_MAKE_NAMED_ARGUMENT(batch_size);
-
-} // namespace kw
-
 namespace detail
 {
 

diff --git a/include/heyoka/kw.hpp b/include/heyoka/kw.hpp
@@ -12,32 +12,80 @@
 #include <heyoka/config.hpp>
 #include <heyoka/detail/igor.hpp>
 
-// NOTE: these are keyword arguments that are
-// shared among several files.
+// NOTE: all keyword arguments are gathered
+// in this file in order to make it easier to
+// prevent name collisions.
 
 HEYOKA_BEGIN_NAMESPACE
 
 namespace kw
 {
 
-IGOR_MAKE_NAMED_ARGUMENT(masses);
-IGOR_MAKE_NAMED_ARGUMENT(omega);
-IGOR_MAKE_NAMED_ARGUMENT(Gconst);
+// llvm_state.
+IGOR_MAKE_NAMED_ARGUMENT(mname);
+IGOR_MAKE_NAMED_ARGUMENT(opt_level);
+IGOR_MAKE_NAMED_ARGUMENT(fast_math);
+// NOTE: this flag is used to force the use of 512-bit AVX512
+// registers (if the CPU supports them). At the time of this writing,
+// LLVM defaults to 256-bit registers due to CPU downclocking issues
+// which can lead to performance degradation. Hopefully we
+// can get rid of this in the future when AVX512 implementations improve
+// and LLVM learns to discriminate good and bad implementations.
+IGOR_MAKE_NAMED_ARGUMENT(force_avx512);
+IGOR_MAKE_NAMED_ARGUMENT(slp_vectorize);
+
+// cfunc API.
+IGOR_MAKE_NAMED_ARGUMENT(vars);
+IGOR_MAKE_NAMED_ARGUMENT(batch_size);
+
+// taylor_adaptive and friends.
+IGOR_MAKE_NAMED_ARGUMENT(tol);
+IGOR_MAKE_NAMED_ARGUMENT(pars);
+IGOR_MAKE_NAMED_ARGUMENT(t_events);
+IGOR_MAKE_NAMED_ARGUMENT(nt_events);
+// NOTE: these are used for constructing events.
+IGOR_MAKE_NAMED_ARGUMENT(callback);
+IGOR_MAKE_NAMED_ARGUMENT(cooldown);
+IGOR_MAKE_NAMED_ARGUMENT(direction);
+// NOTE: these are used in the
+// propagate_*() functions.
+IGOR_MAKE_NAMED_ARGUMENT(max_steps);
+IGOR_MAKE_NAMED_ARGUMENT(max_delta_t);
+IGOR_MAKE_NAMED_ARGUMENT(write_tc);
+IGOR_MAKE_NAMED_ARGUMENT(c_output);
+
+// Diff tensors API.
+IGOR_MAKE_NAMED_ARGUMENT(diff_args);
+IGOR_MAKE_NAMED_ARGUMENT(diff_order);
+
+// Used in several APIs.
 IGOR_MAKE_NAMED_ARGUMENT(time);
+IGOR_MAKE_NAMED_ARGUMENT(prec);
 IGOR_MAKE_NAMED_ARGUMENT(compact_mode);
 IGOR_MAKE_NAMED_ARGUMENT(high_accuracy);
 IGOR_MAKE_NAMED_ARGUMENT(parallel_mode);
-IGOR_MAKE_NAMED_ARGUMENT(prec);
-IGOR_MAKE_NAMED_ARGUMENT(mu);
-IGOR_MAKE_NAMED_ARGUMENT(thresh);
 
-// kwargs for the ffnn
+// ffnn model.
 IGOR_MAKE_NAMED_ARGUMENT(inputs);
 IGOR_MAKE_NAMED_ARGUMENT(nn_hidden);
 IGOR_MAKE_NAMED_ARGUMENT(n_out);
 IGOR_MAKE_NAMED_ARGUMENT(activations);
 IGOR_MAKE_NAMED_ARGUMENT(nn_wb);
 
+// Fixed centres model.
+IGOR_MAKE_NAMED_ARGUMENT(positions);
+
+// Pendulum model.
+IGOR_MAKE_NAMED_ARGUMENT(gconst);
+IGOR_MAKE_NAMED_ARGUMENT(length);
+
+// Used in multiple models.
+IGOR_MAKE_NAMED_ARGUMENT(masses);
+IGOR_MAKE_NAMED_ARGUMENT(omega);
+IGOR_MAKE_NAMED_ARGUMENT(Gconst);
+IGOR_MAKE_NAMED_ARGUMENT(mu);
+IGOR_MAKE_NAMED_ARGUMENT(thresh);
+
 } // namespace kw
 
 HEYOKA_END_NAMESPACE

diff --git a/include/heyoka/llvm_state.hpp b/include/heyoka/llvm_state.hpp
@@ -19,7 +19,6 @@
 #include <tuple>
 #include <type_traits>
 #include <utility>
-#include <vector>
 
 #if defined(HEYOKA_HAVE_REAL128)
 
@@ -34,10 +33,10 @@
 #endif
 
 #include <heyoka/detail/fwd_decl.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/llvm_fwd.hpp>
 #include <heyoka/detail/type_traits.hpp>
 #include <heyoka/detail/visibility.hpp>
+#include <heyoka/kw.hpp>
 #include <heyoka/s11n.hpp>
 
 HEYOKA_BEGIN_NAMESPACE
@@ -73,23 +72,6 @@ HEYOKA_DLL_PUBLIC const target_features &get_target_features();
 
 } // namespace detail
 
-namespace kw
-{
-
-IGOR_MAKE_NAMED_ARGUMENT(mname);
-IGOR_MAKE_NAMED_ARGUMENT(opt_level);
-IGOR_MAKE_NAMED_ARGUMENT(fast_math);
-// NOTE: this flag is used to force the use of 512-bit AVX512
-// registers (if the CPU supports them). At the time of this writing,
-// LLVM defaults to 256-bit registers due to CPU downclocking issues
-// which can lead to performance degradation. Hopefully we
-// can get rid of this in the future when AVX512 implementations improve
-// and LLVM learns to discriminate good and bad implementations.
-IGOR_MAKE_NAMED_ARGUMENT(force_avx512);
-IGOR_MAKE_NAMED_ARGUMENT(slp_vectorize);
-
-} // namespace kw
-
 HEYOKA_DLL_PUBLIC std::ostream &operator<<(std::ostream &, const llvm_state &);
 
 template <typename T>

diff --git a/include/heyoka/model/cr3bp.hpp b/include/heyoka/model/cr3bp.hpp
@@ -14,7 +14,6 @@
 #include <vector>
 
 #include <heyoka/config.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/visibility.hpp>
 #include <heyoka/expression.hpp>
 #include <heyoka/kw.hpp>

diff --git a/include/heyoka/model/elp2000.hpp b/include/heyoka/model/elp2000.hpp
@@ -14,7 +14,6 @@
 #include <vector>
 
 #include <heyoka/config.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/visibility.hpp>
 #include <heyoka/expression.hpp>
 #include <heyoka/kw.hpp>

diff --git a/include/heyoka/model/ffnn.hpp b/include/heyoka/model/ffnn.hpp
@@ -19,7 +19,6 @@
 #include <boost/safe_numerics/safe_integer.hpp>
 
 #include <heyoka/config.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/type_traits.hpp>
 #include <heyoka/detail/visibility.hpp>
 #include <heyoka/expression.hpp>

diff --git a/include/heyoka/model/fixed_centres.hpp b/include/heyoka/model/fixed_centres.hpp
@@ -14,20 +14,12 @@
 #include <vector>
 
 #include <heyoka/config.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/visibility.hpp>
 #include <heyoka/expression.hpp>
 #include <heyoka/kw.hpp>
 
 HEYOKA_BEGIN_NAMESPACE
 
-namespace kw
-{
-
-IGOR_MAKE_NAMED_ARGUMENT(positions);
-
-} // namespace kw
-
 namespace model
 {
 

diff --git a/include/heyoka/model/nbody.hpp b/include/heyoka/model/nbody.hpp
@@ -17,7 +17,6 @@
 #include <boost/numeric/conversion/cast.hpp>
 
 #include <heyoka/config.hpp>
-#include <heyoka/detail/igor.hpp>
 #include <heyoka/detail/visibility.hpp>
 #include <heyoka/expression.hpp>
 #include <heyoka/kw.hpp>
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,6 +39,7 @@ @@
     #endif
+    #include <heyoka/kw.hpp>
     #include <heyoka/model/nbody.hpp>
     #include <heyoka/taylor.hpp>
@@ Expand Down @@