System.Math and OpenToolkit.MathHelper symmetry

[frederikja163]

Purpose of this PR

Add symmetry between the System.Math and OpenToolkit.MathHelper.
For the issue discussing this PR see (#893)

Testing status

Tests haven't been written yet.

Comments

This is to help users (like myself) not having to look through two libraries as none of them are complete with all the features you need. This way you would only ever have to use MathHelper to do all your math stuff

[frederikja163]

I think it would also be handy to extend the trigonometry functions, to not only include radian versions but also have a degree version of each of the functions.

[jvbsl]

Some things I would change. Any second opinions on these?
As well as perhaps changing MathHelper to Math directly, as it does not only contain helper functions, but contains the Math-subset as well?

Edit: degree functions with Degree in name, or a corresponding Degree struct with implicit conversion from/to double?

[frederikja163]

As well as perhaps changing MathHelper to Math directly, as it does not only contain helper functions, but contains the Math-subset as well?

I agree with this, it would also make user coder look a lot cleaner since the name isn't as long. I would think this, however, would require the Mathhelper class to still exist but be marked as obsolete. If I could get the approval of a maintainer I could easily implement it in this PR

Edit: degree functions with Degree in name, or a corresponding Degree struct with implicit conversion from/to double?

As stated in my comment above, I too think this would be a good idea however I would like to get some opinions before I implement it, as well as some opinions on how to implement it.

[varon]

@Perksey @Nihlus @jvbsl

I'd like to rename MathHelper to Mathf or even just Math. It's way more terse when using these functions.

As they're actual math, not just helpers this seems to be clearer too.

What are some opinions here?

[frederikja163]

Just curious here, if it would be Mathf, what does the f mean? Unity uses the same, I always just assumed it might be some random letter.

[jvbsl]

mostly if a "f" is attached it is meant to stand for float, so therefore Mathf would contain math floating point functions. But tbh I would be against that, because:

1. d is often used for double, and a lot of functions in Math are double not float, therefore one could misinterpret f(even if double is a floating point as well).
2. Math(which shall implement the complete System.Math subset) contains functions for integer operations as well.

But with the name Math, I would be completely fine though.

[Perksey]

@varon I definitely agree. Math is fine with me.

[varon]

Seems we're all on the same page. @frederikja163 - feel free to change the class name to Math when you can.

[Perksey]

Actually, naming it Math will almost definitely require type aliasing as Math is in the System namespace - a commonly referenced namespace. We should investigate other names.

[frederikja163]

How about MathO, for opentk?

[Perksey]

I think we should just use Mathf.

[varon]

@Perksey - Great catch. Totally slipped past me as F# has no trouble resolving the right methods in this case.

At this point I'd just go for Mathf. It's terse and everyone will know where to look coming from unity anyway. Set up a poll on discord and go with what the contributors want.

[frederikja163]

I would like to note, like i did on discord aswell. In .netcore 3.0 preview it has MathF, it is with a capital F but it might be confusing.

[Perksey]

We're currently holding a vote in the discord and it will conclude at 4pm tomorrow (UK time)

So far it's looking like it shouldn't be changed.

[frederikja163]

The PR is currently ready with every System.Math function up to .netcore 2.0, there are still some functions from .netcore 3.0 preview that could easily be added, like clamp for every value type. I would like to know if i should complete the PR for those aswell, so we are a bit more future proof.

[Perksey]

If you're willing to, do it! :D

[Perksey]

Looks good so far, keep it up! I'll officially approve this after the member name vote has concluded in the Discord. Once you're done, remove the WIP tag from the title. :)

[Perksey]

Oh and also, fix the build errors please :P

[frederikja163]

Oh and also, fix the build errors please :P

Fixed