Skip to content

docs(tensors): add Tensors API map - #1491

Merged
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
Robby955:physlib/tensors-api-map-20260806
Aug 8, 2026
Merged

docs(tensors): add Tensors API map#1491
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
Robby955:physlib/tensors-api-map-20260806

Conversation

@Robby955

@Robby955 Robby955 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Motivation

Related to #1414, the tracking maps for the tensor API in #908 and the Lorentz tensor API in #886. Both issues are still unfilled templates, so the map supplies the requirement list they ask for. An API map records the implemented status and source location of each requirement, so the gap between a planned API and the current library stays visible in-tree.

Changes

Adds Physlib/Relativity/Tensors/API-map.yaml, with 22 requirements, 16 of them done. The completed entries cover TensorSpecies and the types Tensor, Pure and ComponentIdx; the group action, index permutation, products, contraction of a dual pair, evaluation, and the unit and metric tensors with raising and lowering; the index-notation elaborator and Tensorial; conjugation; and the species realLorentzTensor and complexLorentzTensor with the semilinear map between them.

Six are recorded as not done: neither Lorentz species is extended to a ConjTensorSpecies, so reality and Hermiticity cannot yet be stated for them; the metrics and units of the real species are still built from ContrMod and CoMod rather than as intertwiners of Vector and CoVector; three commutation lemmas for evalT are absent; there is a Euclidean Levi-Civita symbol but no Euclidean tensor; TensorSpecies carries no condition relating the metrics to the basis vectors; and the tensor-level epsilon-epsilon identities leviCivita_contract_self and leviCivita_contract_three are stated but carry sorry, so they are recorded the way solidSphere_inertiaTensor is in the rigid body map. The componentwise identities euclidLeviCivita_symbol_contract_zero, _one and _two are proved and stay under the done entry. Nothing outside the new file changes, and no Lean source is touched.

Checks

python3 scripts/api_map_linter.py --repo . passes with no missing files and no missing names, resolving 289 declarations against the Lean sources.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Thank you for this pull-request (PR). If this is your first PR, welcome to the community!

Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.

  1. Some automated checks will be run on your PR. You can see the results of these checks at the buttom of your PR page. If any of these checks fail, you will need to fix the issues before your PR can be merged. You can learn more about these here, including how to run them locally, which is sometimes quicker than relying on the GitHub Actions. If you have never had a PR merged before, you may have to wait for a reviewer to manually start these checks (this is for security).

  2. A reviewer will look at your PR and may ask you to make changes. This may happen a couple of days after you submit your PR, so you may need to be patient. But it should not be longer than that - if it is please bring it to the attention of the community on the Zulip. The level of review will depend on where your PR is submitted. If it is submitted to ./Physlib or ./QuantumInfo, the review will be more thorough than if it is submitted to ./PhyslibAlpha. You can find out more about what the review process is looking for in our review guidelines. If a reviewer adds an awaiting-author label to your PR, address the review comments, then please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

  3. The reviewer will either approve your PR, or request more changes (in which case we return to step 2). Once your PR is approved, it will be merged by a maintainer, this should happen shortly after approval, though you may get more comments at this stage.

Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages.

If you have any problems or questions, please reach out to the community on the Zulip.

@github-actions github-actions Bot added the t-relativity Relativity label Aug 7, 2026
@Robby955
Robby955 marked this pull request as ready for review August 7, 2026 18:58

@jstoobysmith jstoobysmith left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - approved. Will merge shortly

@jstoobysmith jstoobysmith added the ready-to-merge This PR is approved and will be merged shortly label Aug 8, 2026
@jstoobysmith
jstoobysmith merged commit 09aa847 into leanprover-community:master Aug 8, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge This PR is approved and will be merged shortly t-relativity Relativity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants