Skip to content

refactor(Tensors): rename Tensor.toField to Tensor.toScalar - #1677

Merged
zhikaip merged 1 commit into
masterfrom
rename_toField_toScalar
Sep 23, 2026
Merged

zhikaip merged 1 commit into
masterfrom
rename_toField_toScalar

Conversation

@zhikaip

@zhikaip zhikaip commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator

Tensor.toField maps a rank-zero tensor to its underlying scalar in k. In the electromagnetism files it sits right next to toFieldStrength, for example toField {A.toFieldStrength x | [μ] [ν]}ᵀ, where "field" reads as a physical field. k is also only assumed to be a CommRing, not a field. This PR renames the map and its lemmas; no statements or proofs change.

Renamed (old toField → new toScalar)

  • Relativity/Tensors/Basic.lean: toScalar (def), toScalar_default, toScalar_injective, toScalar_pure, toScalar_permT, toScalar_basis_default, toScalar_basis, toScalar_eq_repr, toScalar_equivariant, eq_smul_toScalar
  • Relativity/Tensors/RealTensor/Basic.lean: contrT_toScalar
  • Relativity/Tensors/RealTensor/Vector/Tensorial.lean: Vector.toScalar_eval_eval_eq_tensorProduct_repr
  • Particles/SuperSymmetry/N1/Basic.lean: toScalar_conjScalar

No deprecated aliases are added.

Reviewer map

  1. Tensors/Basic.lean: the definition and its core lemmas. Docstrings and the section heading now say "scalars" instead of "field".
  2. The rest is a mechanical find-and-replace in the other Tensors files, the Electromagnetism files, N1 and API-map.yaml.

🤖 Generated with Claude Code

Rename the map from rank-zero tensors to the scalars `k`, `Tensor.toField`, to
`Tensor.toScalar`, together with its lemmas (`toScalar_default`,
`toScalar_injective`, `toScalar_pure`, `toScalar_permT`, `toScalar_basis_default`,
`toScalar_basis`, `toScalar_eq_repr`, `toScalar_equivariant`, `eq_smul_toScalar`,
`contrT_toScalar`, `Vector.toScalar_eval_eval_eq_tensorProduct_repr`,
`toScalar_conjScalar`). The old name was easily confused with fields in the
electromagnetism files, e.g. `toField {A.toFieldStrength x | [μ] [ν]}ᵀ`.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

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.

@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.

Approved - makes sense and looks good

@zhikaip
zhikaip merged commit d2df5c9 into master Sep 23, 2026
11 checks passed
@zhikaip
zhikaip deleted the rename_toField_toScalar branch September 23, 2026 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants