gemseo / uncertainty / use_cases / ishigami

Show inherited members

ishigami_function module

The Ishigami function.

class gemseo.uncertainty.use_cases.ishigami.ishigami_function.IshigamiFunction

Bases: MDOFunction

The Ishigami function.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

• func – The original function to be actually called. If None, the function will not have an original function.

• name – The name of the function.

• f_type – The type of the function.

• jac – The original Jacobian function to be actually called. If None, the function will not have an original Jacobian function.

• expr – The expression of the function, e.g. “2*x”, if any.

• input_names – The names of the inputs of the function. If None, the inputs of the function will have no names.

• dim – The dimension of the output space of the function. If 0, the dimension of the output space of the function will be deduced from the evaluation of the function.

• output_names – The names of the outputs of the function. If None, the outputs of the function will have no names.

• force_real – Whether to cast the output values to real.

• special_repr – The string representation of the function. If empty, use default_repr().

• original_name – The original name of the function. If empty, use the same name than the name input.

force_real: bool

Whether to cast the results to real value.

has_default_name: bool

Whether the name has been set with a default value.

last_eval: OutputType | None

The value of the function output at the last evaluation.

None if it has not yet been evaluated.

special_repr: str

The string representation of the function overloading its default string ones.