Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
pyhyperiso.core.Common.Mapper.GroupMapper Class Reference

Public Member Functions

 __init__ (self)
 
 get_str (self)
 
 get_str_all (self)
 
 get_enum (self)
 

Static Public Member Functions

str str (group)
 
WGroupId id_of (group)
 
WGroupId to_id (WGroup group)
 
str canonical (WGroupId group_id)
 
str block_name (group, ScaleType scale, WilsonBasis basis=WilsonBasis.STANDARD)
 
bool register_custom (str canonical, aliases=None, Optional[str] external=None)
 

Detailed Description

Mapper for Wilson-coefficient groups.

The wrapper accepts both legacy :class:`WGroup` enums and runtime strings.
String lookups return :class:`WGroupId`, which is the preferred API for
custom groups and config/CLI driven workflows.

Definition at line 397 of file Mapper.py.

Constructor & Destructor Documentation

◆ __init__()

pyhyperiso.core.Common.Mapper.GroupMapper.__init__ (   self)

Definition at line 405 of file Mapper.py.

Member Function Documentation

◆ block_name()

str pyhyperiso.core.Common.Mapper.GroupMapper.block_name (   group,
ScaleType  scale,
WilsonBasis   basis = WilsonBasis.STANDARD 
)
static
Return the scale/basis block name used by Wilson parameter blocks.

Definition at line 437 of file Mapper.py.

◆ canonical()

str pyhyperiso.core.Common.Mapper.GroupMapper.canonical ( WGroupId  group_id)
static
Return the canonical name of a dynamic Wilson group id.

Definition at line 432 of file Mapper.py.

◆ get_enum()

pyhyperiso.core.Common.Mapper.GroupMapper.get_enum (   self)
Return builtin enum values known to the C++ mapper.

Definition at line 463 of file Mapper.py.

◆ get_str()

pyhyperiso.core.Common.Mapper.GroupMapper.get_str (   self)
Return the C++ mapper's primary string table.

Definition at line 455 of file Mapper.py.

◆ get_str_all()

pyhyperiso.core.Common.Mapper.GroupMapper.get_str_all (   self)
Return all string aliases known to the C++ mapper.

Definition at line 459 of file Mapper.py.

◆ id_of()

WGroupId pyhyperiso.core.Common.Mapper.GroupMapper.id_of (   group)
static
Resolve a group enum/name/alias to a dynamic :class:`WGroupId`.

Definition at line 418 of file Mapper.py.

◆ register_custom()

bool pyhyperiso.core.Common.Mapper.GroupMapper.register_custom ( str  canonical,
  aliases = None,
Optional[str]   external = None 
)
static
Register a custom Wilson group in the dynamic mapper.

Args:
    canonical: Canonical group name.
    aliases: Optional aliases accepted by :meth:`id_of`.
    external: Optional external key used by C++ mapper extensions.

Definition at line 445 of file Mapper.py.

◆ str()

str pyhyperiso.core.Common.Mapper.GroupMapper.str (   group)
static
Return the canonical string for a Wilson group enum or dynamic id.

Definition at line 409 of file Mapper.py.

◆ to_id()

WGroupId pyhyperiso.core.Common.Mapper.GroupMapper.to_id ( WGroup  group)
static
Convert a builtin Wilson-group enum to :class:`WGroupId`.

Definition at line 427 of file Mapper.py.


The documentation for this class was generated from the following file: