ReductionStatus

Symbolica documentation for getting started, symbolic expressions, numerical evaluation, pattern matching, and APIs in Python and Rust.

ReductionStatus

class ReductionStatus

Completion of a tensor reduction under its selected settings.

Complete means no eligible work remains. Deferred means exact eligible work remains for another operation. Capped means an explicitly requested work limit stopped processing. A partial result still represents the exact original tensor; completion is relative to the requested operations, not every possible identity.

Examples

from symbolica.community.tensor import TensorExpression, ReductionStatus
result = TensorExpression(3).contract()
result.reduction_status == ReductionStatus.Complete
True

Attributes

Name Description
Capped An explicit work limit stopped processing; the remaining expression is exact.
Complete No eligible work remains under the requested settings.
Deferred Exact eligible work remains for a subsequent operation.

Capped

Capped: typing.ClassVar[ReductionStatus]

An explicit work limit stopped processing; the remaining expression is exact.

Complete

Complete: typing.ClassVar[ReductionStatus]

No eligible work remains under the requested settings.

Deferred

Deferred: typing.ClassVar[ReductionStatus]

Exact eligible work remains for a subsequent operation.

Methods

Name Description
__int__ Return the underlying integer discriminant.

__int__

ReductionStatus.__int__() -> builtins.int

Return the underlying integer discriminant.