orocos_kinematics_dynamics
orocos_kinematics_dynamics copied to clipboard
Is E_INCREMENT_JOINTS_TOO_SMALL an error or not?
It seems to me that when ChainIkSolverPos_LMA returns E_INCREMENT_JOINTS_TOO_SMALL it is not actually an error but would be a desired result, yes? It indicates that the IK computation didnt require a full 500 iterations and thus the calculation has exited early. So shouldn't this not be identified as an error? For example use I_ prefix for INFO and/or document appropriately that the output is still valid when these error codes are returned.
The reason I ask is because I've been tripping up on this for months assuming that anything not E_NOERROR should considered unusable. I struggled to try and generate E_NOERROR trajectories but it seemed the littlest thing would cause E_INCREMENT_JOINTS_TOO_SMALL. Couldnt find anything on SO or Google to tell me otherwise so perhaps it's just me. lol
So modifying an E_ prefix could make a lot of people angry but if you could help me with some wording I could do a PR for doc update. Newbies like myself could RTM and make it clear. I have no idea what to do with the gradient one E_GRADIENT_JOINTS_TOO_SMALL though. Is that an error? or another early-exit it's your lucky day return code. :)