Question: Complex Numbers in Scope

[sigmasternchen]

Hi there. o/

I recently worked on a project that required complex numbers, but I wasn't able to find any existing library for them.

So, I wanted to ask: Are complex numbers in the scope of this project?
If so, I would be happy to contribute.

Thanks in advance,
Sigma

[NicklasXYZ]

Hello :)

So, I wanted to ask: Are complex numbers in the scope of this project? If so, I would be happy to contribute.

I would say yes, it could definitely be a nice addition to the library.
I think we'd just need to figure out how to design the API and integrate the additional set of functions for complex numbers nicely with the current structure of the library.

Maybe a separate 'cmath' module could work mirroring the naming of functions in the current 'math' module? I think @hayleigh-dot-dev would probably have more expertise in this area :)

Best, Nicklas

[hayleigh-dot-dev]

I think a gleam_community/maths/complex module that mirrors the api for complex numbers could be good!

[sigmasternchen]

I quickly went through the maths API. The relevant functions should be:

• weighted_sum
• weighted_product
• cumulative_sum
• cumulative_product
• exponential
• nth_root
• absolute_difference
• mean
• median
• is_close
• all_close
• arange
• linear_space
• logarithmic_space
• geometric_space

For the rounding functions, we could have 2 precision parameters:

• round_to_nearest
• round_ties_away
• round_ties_up
• round_to_zero
• round_down
• round_up

Some relevant functions that probably need a different name:

• from_polar (instead of polar_to_cartesian)
• to_polar (instead of cartesian_to_polar)

Relevant function where I don't know how to implement them:

• logarithm (and related functions)
• sign (and related functions - maybe something for quadrants?)
• gamma (and related functions)

From the stdlib float package, this would be interesting:

• absolute_value
• add
• divide
• loosely_equals
• multiply
• power
• product
• random
• square_root
• subtract
• sum
• to_string

Some additional functions:

• conjugate
• argument
• compare_real
• compare_imaginary
• compare_absolute_value
• compare_argument

What do you think?

[NicklasXYZ]

Thank you for spending the time going through the current API and finding the relevant functions to implement for complex numbers :)

For a start I think it could make sense to implement the functions in stages. For example, we could start with the ones that are more stright-forward to implement, then later dicuss some of the more non-trivial ones. I am thinking the following functions could be suitable to start with:

• add
• subtract
• multiply
• divide
• power
• square_root
• nth_root
• absolute_value
• sum
• product
• weighted_sum
• weighted_product
• cumulative_sum
• cumulative_product
• exponential
• absolute_difference
• mean
• median
• is_close (similar to loosely_equal, but also with a relative tolerance specified)
• all_close
• to_polar (rename in the maths module)
• from_polar (move from maths to the new maths/complex module)
• compare_real
• compare_imaginary
• conjugate
• argument
• to_string

We can then later discuss and have a look at:

• the rounding functions
• logarithm
• sign
• gamma
• random
• compare_absolute_value
• arrange
• linear_space
• logarithmic_space
• geometric_space

[sigmasternchen]

Sounds good! I'm happy to work on an initial version.

However, just to manage expectations: I'm on holiday over Christmas, so it might be a few weeks until I have something ready.

[NicklasXYZ]

Sounds good! I'm happy to work on an initial version.

However, just to manage expectations: I'm on holiday over Christmas, so it might be a few weeks until I have something ready.

Awesome!
That is completely fine, no worries :)