Listing Available Functions#

uqtestfuns.list_functions(spatial_dimension: Optional[Union[str, int]] = None, tag: Optional[str] = None, tabulate: bool = True) → Optional[List[uqtestfuns.core.uqtestfun_abc.UQTestFunABC]]#

List of all the available functions.

Parameters

  • spatial_dimension (Optional[Union[str, int]]) – Filter based on the number of spatial dimension. For variable dimension (i.e., M-dimensional test functions), use the string “M”.

  • tag (Optional[str]) – Filter based on the application tag. Supported tags: “metamodeling”, “sensitivity”, “optimization”, “reliability”.

  • tabulate (bool, optional) – The flag whether to print a table on the console or a list of the available functions (each in fully-qualified class name).

Returns

Either a tabulated view of the list of available functions, or a list of fully-qualified class name (each is callable). The function may return None if after filtering there is no entry.

Return type

Optional[List[UQTestFunABC]]

Notes

  • When both spatial_dimension and tag are specified the results are intersected. Entries that satisfy both are returned.