FormFactor

Symbolica documentation for getting started, symbolic expressions, numerical evaluation, pattern matching, and APIs in Python and Rust.

`FormFactor`

class FormFactor

A momentum-dependent form factor referenced by interaction rules.

Form factors keep their model type and symbolic value so specialized amplitude backends can evaluate them at the relevant kinematic point.

Examples

from symbolica import S, E
from symbolica.community import hepkit as hep
model = hep.Model.standard_model()
form_factors = {ff.name: ff.value for ff in model.form_factors}

Attributes

Name	Description
`name`	Return the form-factor name.
`type_name`	Return the model-defined form-factor type, when present.
`value`	Return the symbolic form-factor value, when present.

`name`

FormFactor.name: builtins.str

Return the form-factor name.

Examples

Using the setup in the FormFactor class example:

names = [ff.name for ff in model.form_factors]

`type_name`

FormFactor.type_name: typing.Optional[builtins.str]

Return the model-defined form-factor type, when present.

Examples

Using the setup in the FormFactor class example:

types = {ff.name: ff.type_name for ff in model.form_factors}

`value`

FormFactor.value: typing.Optional[Expression]

Return the symbolic form-factor value, when present.

Examples

Using the setup in the FormFactor class example:

formulas = {ff.name: ff.value for ff in model.form_factors}

Methods

Name	Description
`__repr__`	Summarize the defining data as well as the form-factor name.
`_repr_html_`	Display the model member’s physical data and defining expressions.
`_repr_pretty_`	Write the complete text summary to an IPython pretty printer.

`repr`

FormFactor.__repr__() -> builtins.str

Summarize the defining data as well as the form-factor name.

Examples

Using the setup in the FormFactor class example:

summaries = [repr(ff) for ff in model.form_factors]

`_repr_html_`

FormFactor._repr_html_() -> builtins.str

Display the model member’s physical data and defining expressions.

Examples

Using the setup in the FormFactor class example:

from IPython.display import display
display(model.form_factors)

`_repr_pretty_`

FormFactor._repr_pretty_(pretty: typing.Any, cycle: builtins.bool) -> None

Write the complete text summary to an IPython pretty printer.

Examples

Using the setup in the FormFactor class example:

from IPython.lib.pretty import pretty
text = pretty(model.form_factors)

Parameters

pretty (object) IPython pretty printer receiving the text.
cycle (bool) Whether the object occurs recursively in the current display.