Categorize functions in std.math

[markisaa]

Add a table to std.math so that the functions/constants are categorized similarly to std.algorithm.

I intend to ramp this up and perform similar modifications across the board assuming this gets positive feedback.

https://issues.dlang.org/show_bug.cgi?id=13555

Precedent: 7fdfa02

Results:

[andralex]

Nice, thanks! cc @ibuclaw

[andralex]

Could you please add this to std.ddoc:

SCRIPT = <script type="text/javascript">$0</script>

then use it on this line like so:

$(SCRIPT inhibitQuickIndex = 1;)

Thanks! That way we won't get the PDF generation messed up.

[quickfur]

Thanks for doing this!!

[quickfur]

I suggest to merge the "classics" and "trigonomery" categories into a single section, perhaps call it "standard mathematical functions". I don't see much point in singling out things like sqrt or cbrt into its own category.

Also, in English it's more common to use the terms "exponentiation & logarithm" rather than "exponents".

I would break up the "miscellaneous" section into "Hardware control", and move poly and conj into one of the other sections. I'm not 100% sure what to do with conj, since we're supposed to be deprecating built-in complex types, so any operation specific to complex numbers really should be in std.complex instead. I notice also that sin, cos, exp, etc., have complex overloads. Perhaps these should cease being documented (but leave it in the code to avoid breaking existing user code)? std.complex ought to take over these overloads anyway.

In the meantime, though, perhaps conj can be put into a "complex numbers" category, where sin, cos, etc., will also be put (I don't think it's a problem for the same functions to appear in multiple categories if they belong to multiple categories).

Finally, it's probably a good idea to put the "constants" section at the top, instead of somewhere in the middle where it's not so obvious to find.

[markisaa]

@quickfur - Thanks for the feedback :). Here's my thoughts:

1. The separation of classics/trigonometry is not there to separate out sqrt and cbrt but rather to recognize that trigonometry is its own rightful category. It certainly has enough stuff in it to warrant it. I'm opposed to this merger. On the bright side, this gives me somewhere to move poly.
2. My task here is not to reorganize the contents of the files. That can be done as a separate diff with its own concise purpose. The goal here is to make it easier to find what exists today.
3. When I Google I find that the terms exponents, exponentials, and exponentiation are all equally prevalent in headers to math tutorials (searching for "X and logarithms"). I actually find that exponentiation shows up least. I don't actually care which one we use, so if you want me to use exponentiation, that's fine, but English is my first language and that strikes me as less natural/terse.

The hardware control category, complex numbers category, and rearranging of constants section sound reasonable. I intend to push revisions by end of day.

[markisaa]

Made the requested changes. @andralex - Made the PR for std.ddoc dlang/dlang.org#668 and changed std/string.d so that it also uses this new macro.

[andralex]

Pulled that, @quickfur are we in good shape?

[quickfur]

Yes, let's do it. We can do cleanups later if necessary.

[quickfur]

Auto-merge toggled on

[ibuclaw]

@andralex looks good to me %-)