"""
Geometric comparison utilities for UPXO entities.
Usage
-----
from upxo.geoEntities.geoCmp import cmp_edges, cmp_rings
Functions
---------
cmp_edges : Compare two edge objects.
cmp_muledges : Compare two multi-edge objects.
cmp_rings : Compare two ring objects.
cmp_xtals : Compare two crystal objects.
cmp_pxtals : Compare two poly-crystal objects.
Limitations
-----------
- All functions are stubs awaiting implementation.
"""
import math
[docs]
def cmp_edges(ref_edge, edge):
"""
Compare two edge objects for geometric equivalence.
Parameters
----------
ref_edge : edge2d
Reference edge.
edge : edge2d
Edge to compare against the reference.
Returns
-------
None
Limitations
-----------
- Not yet implemented.
"""
raise NotImplementedError("cmp_edges is not yet implemented.")
[docs]
def cmp_muledges(ref_medge, medge):
"""
Compare two multi-edge objects for geometric equivalence.
Parameters
----------
ref_medge : muledge2d
Reference multi-edge.
medge : muledge2d
Multi-edge to compare against the reference.
Returns
-------
None
Limitations
-----------
- Not yet implemented.
"""
raise NotImplementedError("cmp_muledges is not yet implemented.")
[docs]
def cmp_rings(ref_ring, ring):
"""
Compare two ring objects for geometric equivalence.
Parameters
----------
ref_ring : ring2d
Reference ring.
ring : ring2d
Ring to compare against the reference.
Returns
-------
None
Limitations
-----------
- Not yet implemented.
"""
raise NotImplementedError("cmp_rings is not yet implemented.")
[docs]
def cmp_xtals(ref_xal, xtal):
"""
Compare two crystal objects for geometric equivalence.
Parameters
----------
ref_xal : object
Reference crystal.
xtal : object
Crystal to compare against the reference.
Returns
-------
None
Limitations
-----------
- Not yet implemented.
"""
raise NotImplementedError("cmp_xtals is not yet implemented.")
[docs]
def cmp_pxtals(ref_pxtal, pxtal):
"""
Compare two poly-crystal objects for geometric equivalence.
Parameters
----------
ref_pxtal : object
Reference poly-crystal.
pxtal : object
Poly-crystal to compare against the reference.
Returns
-------
None
Limitations
-----------
- Not yet implemented.
"""
raise NotImplementedError("cmp_pxtals is not yet implemented.")