lib.parameter.find_names_latex

lib.parameter.find_names_latex(allnames, name, latex=None, quiet=True)

Search parameter name name in list of names allnames, matching template forms [::]; return corresponding parameter names and latex.

>>> find_names_latex(['a_1','a_2','b_1'],'a_[:]',latex='\alpha_[:]')
[('a_1','\alpha_{1}'), ('a_2','\alpha_{2}')]
Parameters

  • allnames (list) – List of parameter names (strings).

  • name (string) – Parameter name to match in allnames.

  • latex (string, default=None) – Latex for parameter.

  • quiet (bool, default=True) – If False and no match for name was found is allnames, raise ParamError.

Returns

toret – List of string tuples (name, latex). latex is None if input latex is None.

Return type

list