Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • bob.math bob.math
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1
    • Issues 1
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • bobbob
  • bob.mathbob.math
  • Issues
  • #1
Closed
Open
Issue created Dec 02, 2015 by André Anjos@andre.anjos💬Owner

bob.math.linsolve parameter documentation in inconsistent order

Created by: siebenkopf

I just saw that the documented order of the parameters of bob.math.linsolve (and similar) is not the same as they are actually used: https://github.com/bioidiap/bob.math/blob/master/bob/math/main.cpp#L93 https://github.com/bioidiap/bob.math/blob/master/bob/math/linsolve.cpp#L19 I think we should actually change the bindings, so that the parameters are actually as currently documented and not as currently used. This is the default way that we use in other packages as well, i.e., the optional output value should go last in the list of parameters, for example: https://github.com/bioidiap/bob.learn.linear/blob/master/bob/learn/linear/pca.cpp#L180

If not desired otherwise, I will update the code accordingly.

Also, I have seen that we are binding nocheck (aka linsolve_) functions, while in the other packages we removed the bindings for those. At the end, in the binding functions, in fact we are checking the parameters, even in the nocheck functions. Finally, the test does not take a lot of time, so the gain is not big. And, having no checks might result in crashes (SIGSEGV), which should be avoided in Python code.

So, if there are no objections, I will remove the bindings to those functions as well. Both modifications will end up in an API change, so we get new version 2.1.0.

Assignee
Assign to
Time tracking