Merge pull request #545 from ManifoldFR/topic/add-arg-literal

Add user-defined literal `""_a` for `bp::arg`

Author: ManifoldFR

.github/workflows/linux.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       matrix:
         python: [3]
-        ubuntu: [20, 22]
+        ubuntu: [22, 24]
     steps:
       - uses: actions/checkout@v3
         with:

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+
+- Add user-defined literal ""_a for bp::arg ([#545)(https://github.com/stack-of-tasks/eigenpy/pull/545))
+
 ### Fixed
 
 - Fix handling of non sorted sparse matrix ([#538](https://github.com/stack-of-tasks/eigenpy/pull/538))

include/eigenpy/fwd.hpp

@@ -196,6 +196,16 @@ struct has_operator_equal_impl {
 template <class T1, class T2 = T1>
 struct has_operator_equal : internal::has_operator_equal_impl<T1, T2>::type {};
 
+namespace literals {
+/// \brief A string literal returning a boost::python::arg.
+///
+/// Using-declare this operator or do `using namespace eigenpy::literals`. Then
+/// `bp::arg("matrix")` can be replaced by the literal `"matrix"_a`.
+inline boost::python::arg operator"" _a(const char *name, std::size_t) {
+  return boost::python::arg(name);
+}
+}  // namespace literals
+
 }  // namespace eigenpy
 
 #include "eigenpy/alignment.hpp"

unittest/user_type.cpp

@@ -150,12 +150,13 @@ Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> build_matrix(int rows,
 template <typename Scalar>
 void expose_custom_type(const std::string& name) {
   using namespace Eigen;
+  using eigenpy::literals::operator"" _a;
   namespace bp = boost::python;
 
   typedef CustomType<Scalar> Type;
 
-  bp::class_<Type>(name.c_str(), bp::init<Scalar>(bp::arg("value")))
-
+  // use ""_a literal
+  bp::class_<Type>(name.c_str(), bp::init<Scalar>("value"_a))
       .def(bp::self + bp::self)
       .def(bp::self - bp::self)
       .def(bp::self * bp::self)