Complex

class ase2sprkkr.common.grammar_types.arrays.Complex(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='', delimiter='')

Class hierarchy

Constructor

Parameters:

• prefix (str | None)

• postfix (str | None)

• format (str)

• after_format (str | None)

• default_value (Any)

• condition (Callable[[Any], bool | str] | None)

• after_convert (Callable[[Any], Any] | None)

__init__(prefix=None, postfix=None, format='', after_format=None, default_value=None, condition=None, after_convert=None, description='', delimiter='')

Create the object.

Parameters:

• prefix (str | None) – The string, that will be printed before the value

• postfix (str | None) – The string, that will be printed after the value

• format (str) – The (python) format string, that will be used for outputing the value. The format is passed as format argument to str.format routine.

• after_format (str | None) – In some cases, the additional formating is required after converting to the string and adding postfix/prefix.

• default_value (Any) – The default value of the options of this type. None means no default value.

• condition (Callable[[Any], bool | str] | None) – Function, that check the validity of the value. It should return True for a valid value, and False or string for invalid. The string is interpreted as an error message that explains the invalidity of the value.

• after_convert (Callable[[Any], Any] | None) – Function, that - if it is given - is applied to the (entered or parsed) value. The function is applied on the result of the convert method

numpy_type

alias of complex

_build_grammar()

_parse_complex_tokens(tokens)

convert(value)

Convert a value from user to the “cannonical form”

_validate(value, why='set')

Return error message if the value is not valid.

_grammar_name()

transform_grammar(grammar, param_name=False)

The chance for the resulting class to alter the resulting prefixed grammar

_string(val)

Convert the value to the ouput.

The string() apply format and do some additional transformation (add prefix, postfix etc.), so the actual way how to convert the value for the output should be here.

I = <Complex>

allowed_types = (<class 'numpy.complex128'>, <class 'complex'>)

datatype

alias of complex

datatype_name = 'complex'