decompositions: Rewrite comments in constructors in BDCSVD

Author: Lucas-Haubert

include/eigenpy/decompositions/BDCSVD.hpp

@@ -29,14 +29,22 @@ struct BDCSVDVisitor
             bp::args("self", "rows", "cols"),
             "Default Constructor with memory preallocation. "))
         .def(bp::init<Eigen::DenseIndex, Eigen::DenseIndex, unsigned int>(
-            bp::args("self", "rows", "cols", "computationOptions"),
-            "Default Constructor with memory preallocation. "))
+            bp::args("self", "rows", "cols", "computationOptions "),
+            "Default Constructor with memory preallocation. \n\n"
+            "Like the default constructor but with preallocation of the "
+            "internal "
+            "data according to the specified problem size and the "
+            "computationOptions. "))
         .def(bp::init<MatrixType>(
             bp::args("self", "matrix"),
             "Constructor performing the decomposition of given matrix. "))
         .def(bp::init<MatrixType, unsigned int>(
-            bp::args("self", "matrix", "computationOptions"),
-            "Constructor performing the decomposition of given matrix. "))
+            bp::args("self", "matrix", "computationOptions "),
+            "Constructor performing the decomposition of given matrix. \n\n"
+            "One cannot request unitiaries using both the Options template "
+            "parameter "
+            "and the constructor. If possible, prefer using the Options "
+            "template parameter."))
 
         .def("cols", &Solver::cols, bp::arg("self"),
              "Returns the number of columns. ")
@@ -52,7 +60,7 @@ struct BDCSVDVisitor
              (Solver & (Solver::*)(const MatrixType &matrix,
                                    unsigned int computationOptions)) &
                  Solver::compute,
-             bp::args("self", "matrix"),
+             bp::args("self", "matrix", "computationOptions"),
              "Method performing the decomposition of given matrix, as "
              "specified by the computationOptions parameter.  ",
              bp::return_self<>())

include/eigenpy/decompositions/JacobiSVD.hpp

@@ -25,8 +25,6 @@ struct JacobiSVDVisitor
   template <class PyClass>
   void visit(PyClass &cl) const {
     cl.def(bp::init<>(bp::arg("self"), "Default constructor"))
-        // TODO: Management of _Options, put default options for default
-        // constructor
         .def(bp::init<Eigen::DenseIndex, Eigen::DenseIndex>(
             bp::args("self", "rows", "cols"),
             "Default Constructor with memory preallocation. "))
@@ -62,7 +60,7 @@ struct JacobiSVDVisitor
              (Solver & (Solver::*)(const MatrixType &matrix,
                                    unsigned int computationOptions)) &
                  Solver::compute,
-             bp::args("self", "matrix"),
+             bp::args("self", "matrix", "computationOptions"),
              "Method performing the decomposition of given matrix, as "
              "specified by the computationOptions parameter.  ",
              bp::return_self<>())