Find subset relations

saf_find_subset_relations is a function defined in rel.c.

Synopsis:

int saf_find_subset_relations(SAF_ParMode pmode, SAF_Db *db, SAF_Set *sup, SAF_Set *sub, SAF_Cat *sup_cat, SAF_Cat *sub_cat, SAF_BoundMode sbmode, SAF_BoundMode cbmode, int *num, SAF_Rel **found)

Formal Arguments:

  • pmode: The parallel mode.
  • db: Database in which to limit the search.
  • sup: The superset to limit search to.
  • sub: The subset to limit search to.
  • sup_cat: The collection category on the superset to limit search to. Pass SAF__ANY_CAT if you do not want to limit the search to any particular category.
  • sub_cat: The collection category on the subset to limit search to. Pass SAF__ANY_CAT if you do not want to limit the search to any particular category.
  • sbmode: If SAF__BOUNDARY_TRUE, limit search to relations in which the subset is the boundary of the superset.
  • cbmode: If SAF__BOUNDARY_TRUE, limit search to relations in which the members of the subset are on the boundaries of the members of the superset.
  • num: For this and the succeeding argument, (see *Returned Handles*).
  • found: For this and the preceding argument, (see *Returned Handles*).

Description: This function finds any subset relations that might exist between two sets or a subset relation on a specific collection category.

Preconditions:

  • pmode must be valid. (low-cost)
  • db must be a valid database. (low-cost)
  • sup_cat must either be a valid category handle or SAF__ANY_CAT. (low-cost)
  • sub_cat must either be a valid category handle or SAF__ANY_CAT. (low-cost)
  • sub must be a valid set handle. (low-cost)
  • sup must be a valid set handle. (low-cost)
  • num and found must be compatible for the return value allocation. (low-cost)

Return Value: The constant SAF__SUCCESS is returned when this function is successful. Otherwise this function either returns an error number or throws an exception, depending on the value of the library’s error handling property.

See Also: