httk.atomistic.models.cell.plain_view

A view presenting any cell backend as a raw 3-row tuple of cell vectors.

Classes

PlainCellView

A view presenting an underlying cell backend as the raw 3x3 basis matrix of floats.

Module Contents

class httk.atomistic.models.cell.plain_view.PlainCellView(obj, **hints)

Bases: httk.atomistic.models.cell.view_base.CellViewBase, tuple

A view presenting an underlying cell backend as the raw 3x3 basis matrix of floats.

This view is a genuine tuple of three cell-vector rows (the scaled lattice vectors rendered to floats from the exact basis), built eagerly and immutable.

Parameters:
unwrap()

Return the raw object behind the backend.

Returns:

The unwrapped source object.

Return type:

Any

unview()

Return the presented basis as a plain tuple.

Returns:

The three cell-vector rows.

Return type:

tuple[tuple[float, Ellipsis], Ellipsis]