PK_GEOM_is_coincident

PK_ERROR_code_t     PK_GEOM_is_coincident
(
--- received arguments ---
PK_GEOM_t           geom_1,         --- first geometric entity
PK_GEOM_t           geom_2,         --- second geometric entity

--- returned arguments ---
PK_LOGICAL_t *const is_coincident   --- whether coincident
)


This function will compare two geometric entities to detect whether they
occupy the same position(s) in space.


Specific Errors:
    PK_ERROR_invalid_geometry       geometry is invalid
    PK_ERROR_wrong_sub_type         geometry is wrong sub-type


This function will compare two geometric entities. If they occupy the same
position(s) in space, 'is_coincident' will be returned as PK_LOGICAL_true,
otherwise it will be returned as PK_LOGICAL_false.

In cases of mixed dimension, e.g. a surface and a curve, the entirety of the
geometry with the lower dimension must be coincident with the geometry with
the higher dimension.

All comparisons of length or position are made to within modeller resolution.

PK_GEOM_is_coincident is not guaranteed to detect equivalence but it will
never claim two entities are equivalent when they are not.

Any curve or surface must be capable of passing the full checks imposed by
PK_GEOM_check.

Two meshes are considered coincident only if the meshes are identical.

Lattices can only be compared to other lattices and two lattices are
considered coincident only if the lattices are identical.