RFC: add `angle` for computing the argument of a complex number

Open
#595 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the RFC proposal and its linked NumPy, PyTorch, TensorFlow, and C99 prior art. Resolve whether the API should be named angle, arg, or phase and whether it accepts only complex arrays; done means the specification has an agreed API and behavior.

Written by the indexing model from the issue text.

Description

API extension RFC

This RFC requests to include a new API in the array API specification for the purpose of computing the argument of a complex number.

Overview

Based on array comparison data, the API is available in the majority of libraries in the PyData ecosystem.

The Array API specification does not currently include an API for computing the argument of a complex number.

Prior art

Proposal:

def angle(x: array, /) -> array

Questions

  • okay with angle as name? arg? phase?
  • only operate on complex arrays, similar to conj et al?

cc @kgryte

Dominant language
Python
Stars
281
Forks
52
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from data-apis/array-api

All issues in data-apis/array-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.