make_canonical

libcasm.xtal.make_canonical(

obj: Lattice | Prim | Structure,

) → Any

Make an equivalent Lattice, Prim, or Structure with the canonical form of the lattice

Parameters:

obj (Union[Lattice, Prim, Structure]) – A Lattice, Prim, or Structure, which determines whether make_canonical_lattice(), or make_canonical_prim(), make_canonical_structure() is called.

Returns:

canonical_obj – The equivalent Lattice, Prim, or Structure with canonical form of the lattice.

Return type:

Union[Lattice, Prim, Structure]