Documentation: Improve description of vector length function
Hello Blaze team,
In Matlab, length(vector) represents the number of elements in the vector. In the documentation, there is little indication in the description of the length function that it is actually computing the magnitude (vector 2-norm) of the vector; From reading the documentation, someone (especially a Matlab user like me) might think that it is the same as the .size() function (if we didn't happen to read the normalize() function description as well).
This isn't really such a big deal, but I think a small change (e.g.using "calculate the length (magnitude) of a vector" instead of "calculate the length of a vector") could save some people a good chunk of time in the future.
Best, Ben Beach
Comments (3)
-
-
reporter Great, thanks!
-
- changed status to resolved
The documentation of the
length()
andsqrLength()
function has been been updated and improved in the documentation, the tutorial and the wiki. - Log in to comment
Hi Benjamin!
Thanks a lot for the valuable hint. We will improve the documentation as quickly as possible according to your suggestion. In the long run, we will rework the
length()
andsqrLength()
in the context of issue #89. Thanks again,Best regards,
Klaus!