httk.atomistic.models.formula.composition_view

Lazy composition presentation view.

Classes

CompositionView

Present any chemical-formula backend as a lazy composition.

Module Contents

class httk.atomistic.models.formula.composition_view.CompositionView(obj, **hints)

Bases: httk.atomistic.models.formula.view_base.ChemicalFormulaViewBase, httk.atomistic.models.formula.composition.Composition

Present any chemical-formula backend as a lazy composition.

Parameters:

• obj (httk.atomistic.models.formula.like.ChemicalFormulaLike) – The chemical-formula-like object to present.

• **hints (Any) – Backend-selection hints.

property amounts: tuple[tuple[str, fractions.Fraction], Ellipsis]

Return the lazily materialized elemental amounts.

property uncertainties: tuple[tuple[str, fractions.Fraction | None], Ellipsis]

Return the lazily materialized amount precisions.

property complete: bool

Return whether the presented composition is complete.

property exact: bool

Return whether the presented amounts are exact.

property normalized: bool

Return whether the presented composition is normalized.

property normalization_status: str

Return the presented composition’s normalization status.

property diagnostics: tuple[httk.atomistic.models.formula.diagnostics.CompositionDiagnostic, Ellipsis]

Return diagnostics associated with the presented composition.

unwrap()

Return the raw object behind the backend.

Returns:

The unwrapped source object.

Return type:

Any

unview()

Return the presented composition as a standalone value.

Returns:

The materialized composition value.

Return type:

httk.atomistic.models.formula.composition.Composition