Absolute value function for scalar fields

[mjungmath]

Currently, the abs operator cannot be applied to scalar fields:

sage: M = Manifold(2, 'M', structure='topological')
sage: X.<x,y> = M.chart()
sage: f = M.scalar_field({X: x*y}, name='f', latex_name=r"\Phi")
sage: abs(f)
Traceback (most recent call last)
...
TypeError: bad operand type for abs(): 'ScalarFieldAlgebra_with_category.element_class'

In this ticket, we add this feature.

CC: @egourgoulhon @tscrim

Component: manifolds

Author: Michael Jung

Branch/Commit: 2095de3

Reviewer: Travis Scrimshaw

Issue created by migration from https://trac.sagemath.org/ticket/32396

[mjungmath]

Branch: u/gh-mjungmath/abs_function_for_scalar_fields

[mjungmath]

Commit: fcd64c9

[mjungmath]

New commits:

fcd64c9

Trac #32396: add `__abs__` to chart_func and scalarfield

[tscrim]

Reviewer: Travis Scrimshaw

[tscrim]

comment:5

LGTM.

[mjungmath]

comment:6

Thank you for the review!

[egourgoulhon]

comment:7

Thanks for implementing this. Any reason for the choice of Abs rather than abs for the function name?

[mjungmath]

comment:8

No particular reason. Do you prefer abs or maybe |.|?

[egourgoulhon]

comment:9

Replying to @mjungmath:

No particular reason. Do you prefer abs or maybe |.|?

I don't have any strong preference. abs sounds more inline with other function names in Sage, while |.| is closer to mathematical notation, so I would slightly prefer the latter. Travis, what do you think?

[tscrim]

comment:10

I am slightly worried about possible ambiguity with |.|. I might go with abs over Abs just because of \lvert compared to \lVert and to match Sages's abs. However, I didn't (and still don't) really care for which one as it is clear documentation-wise what it is doing (and hidden from the causal user). So I am not the person to ask for a real opinion on this.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

2095de3

Trac #32396: adjust abs function name to general Sage convention

[sagetrac-git]

Changed commit from fcd64c9 to 2095de3

[mjungmath]

comment:12

Alright, I changed it to abs with small letters. I find it a strong argument to say that this follows general Sage convention.

[tscrim]

comment:13

Thanks. I am setting back to a positive review.

[vbraun]

Changed branch from u/gh-mjungmath/abs_function_for_scalar_fields to 2095de3