CffReport

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

`CffReport`

class CffReport

Generation counts for a CFF representation.

Compare candidate energy flows with the acyclic flows and denominator products retained in the result.

Examples

from symbolica.community import hepkit as hep
process = hep.Model.phi3().process(["phi"], ["phi", "phi"])
diagrams = process.generate_diagrams(
    loops=1, max_vertices=3, maximum_bridges=0, progress=None
)
diagram = diagrams.diagrams[0]
result = diagram.integrate_energy(method="cff")
report = result.report
assert report.candidate_orientations >= report.acyclic_orientations

Attributes

Name	Description
`acyclic_orientations`	Acyclic search count, or None for generalized numerator generation.
`candidate_orientations`	Candidate search count, or None for generalized numerator generation.
`interned_surfaces`	Return the number of unique denominator surfaces in the result.
`unfolded_terms`	Return the total number of unfolded denominator terms.

`acyclic_orientations`

CffReport.acyclic_orientations: typing.Optional[builtins.int]

Acyclic search count, or None for generalized numerator generation.

Examples

Using the setup in the CffReport class example:

assert report.acyclic_orientations == len(result.orientations)

`candidate_orientations`

CffReport.candidate_orientations: typing.Optional[builtins.int]

Candidate search count, or None for generalized numerator generation.

Examples

Using the setup in the CffReport class example:

assert report.candidate_orientations >= report.acyclic_orientations

`interned_surfaces`

CffReport.interned_surfaces: builtins.int

Return the number of unique denominator surfaces in the result.

Examples

Using the setup in the CffReport class example:

assert report.interned_surfaces == len(result.surfaces)

`unfolded_terms`

CffReport.unfolded_terms: builtins.int

Return the total number of unfolded denominator terms.

Examples

Using the setup in the CffReport class example:

term_count = report.unfolded_terms

Methods

Name	Description
`__repr__`	Return a concise constructor-style CFF generation summary.
`_repr_html_`	Render CFF generation statistics as a compact HTML table.
`_repr_pretty_`	Write a concise CFF summary to an IPython pretty printer.

`repr`

CffReport.__repr__() -> builtins.str

Return a concise constructor-style CFF generation summary.

Examples

Using the setup in the CffReport class example:

print(result.report)

`_repr_html_`

CffReport._repr_html_() -> builtins.str

Render CFF generation statistics as a compact HTML table.

Examples

Using the setup in the CffReport class example:

from IPython.display import display
display(report)

`_repr_pretty_`

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

Write a concise CFF summary to an IPython pretty printer.

Examples

Using the setup in the CffReport class example:

from IPython.lib.pretty import pretty
text = pretty(report)

Parameters

pretty (object) The IPython pretty-printer object.
cycle (bool) Whether this object is part of a recursive formatting cycle.