Listing Available Functions

Contents

Listing Available Functions#

uqtestfuns.list_functions(input_dimension: str | int | None = None, tag: str | None = None, output_dimension: int | None = None, parameterized: bool | None = None, tabulate: bool = True, tablefmt: str = 'grid') → List[UQTestFunABC] | str | None#

List of all the available functions.

Parameters:

  • input_dimension (Optional[Union[str, int]]) – Filter based on the number of input 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”.

  • output_dimension (Optional[Union[str, int]]) – Filter based on the number of output dimension.

  • parameterized (bool, optional) – Filter based on whether the test function is parameterized.

  • 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).

  • tablefmt (str, optional) – Format of the table output; use “html” to return a table in HTML format nicely rendered in Jupyter notebook.

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 input_dimension and tag are specified the results are intersected. Entries that satisfy both are returned.

Contents