absoluteValue

Return the absolute value.

Human Summary

Use it when only magnitude matters and the sign should be positive.

AI Contract

FieldValue
Kindinstance method
Canonical nameabsoluteValue
Aliasesabs
Mutates receiverNo
ReturnsArithInstance
Accepts (string, base) overloadNo
Configuration dependenciesNone
Related methodsabs

Signature

absoluteValue(): ArithInstance;

Parameters

ParameterTypeRequiredNotes
None--This method does not take parameters.

Returns

Returns a new Arith instance. The receiver is not modified.

Behavior

  • Negative finite values become positive.
  • Positive, zero, infinity, and NaN values keep their numeric category.
  • The receiver is not mutated.

Examples

import { Arith } from "@teakit/arith";

new Arith("-12.5").absoluteValue().toString(); // "12.5"

Errors

  • Does not take user arguments; no argument validation is performed.

Agent Notes

  • Import from @teakit/arith; prefer import { Arith } from "@teakit/arith".
  • Use new Arith(...) to construct values. Do not generate Arith(...) as a function call.
  • Use string inputs for exact decimal values, especially money-like values.
  • Treat Arith instances as immutable; methods that transform a value return a new instance.
  • Do not mutate internal fields such as c, e, s, or _isArith.

See Also