httk.atomistic.models.formula.formula_view

Eager reduced-formula presentation view.

Classes

ChemicalFormulaView

Present a complete composition as an eager canonical reduced formula.

Module Contents

class httk.atomistic.models.formula.formula_view.ChemicalFormulaView(obj, **hints)[source]

Bases: httk.atomistic.models.formula.view_base.ChemicalFormulaViewBase, httk.atomistic.models.formula.formula.ChemicalFormula

Present a complete composition as an eager canonical reduced formula.

Parameters:
property amounts[source]

Return the presented elemental amounts.

property uncertainties[source]

Return the presented amount precisions.

property complete[source]

Return whether the presented composition is complete.

property exact[source]

Return whether the presented amounts are exact.

property normalized[source]

Return whether the presented composition is normalized.

property normalization_status[source]

Return the presented composition’s normalization status.

property diagnostics[source]

Return diagnostics associated with the presented composition.

property is_anonymous[source]

Return whether this formula uses anonymous labels.

unview()[source]

Return the presented formula as a standalone value.

Returns:

The canonical reduced formula value.

Return type:

httk.atomistic.models.formula.formula.ChemicalFormula

unwrap()[source]

Return the raw object behind the backend.

Returns:

The unwrapped source object.

Return type:

Any