Skip to content

Overview

The "PrimitiveDPs" objects corresponds to the morphisms in the category of design problems DP.

Common interface

All of them are subclasses of PrimitiveDP.

PrimitiveDP dataclass

Bases: Generic[Fcov, Rcov]

A generic PrimitiveDP; a morphism of the category DP.

Other classes derive from this.

Attributes:

Name Type Description
description Optional[str]

An optional string description.

F Poset[Fcov]

The functionality poset \(\F\)

R Poset[Rcov]

The resources poset \(\R\)

Note

This class is only a general superclass for morphisms of the category DP. It does not contain interface/information regarding the feasible relationship itself.

Source code in src/act4e_mcdp/primitivedps.py
@dataclass(frozen=True)
class PrimitiveDP(Generic[Fcov, Rcov]):
    r"""
    A generic PrimitiveDP; a morphism of the category DP.

    Other classes derive from this.

    Attributes:
        description: An optional string description.
        F: The functionality poset $\F$
        R: The resources poset $\R$


    Note:
        This class is only a general superclass
        for morphisms of the category DP.
        It does not contain interface/information
        regarding the feasible relationship itself.

    """

    description: Optional[str]
    F: Poset[Fcov]
    R: Poset[Rcov]

Identity

The simplest DP is the identity design problem, described by the class IdentityDP.

IdentityDP dataclass

Bases: Generic[T], PrimitiveDP[T, T]

This is the identity DP (\(\F = \R\))

Relation:

$$
  \fun \leq \res
$$

Attributes:

F (Poset): The functionality poset $\F$
R (Poset): The resources poset $\R$

Note:

It can be seen as a special case
of [AmbientConversion][act4e_mcdp.primitivedps.AmbientConversion]
where $\common = \F = \R$.
Source code in src/act4e_mcdp/primitivedps.py
@dataclass(frozen=True)
class IdentityDP(Generic[T], PrimitiveDP[T, T]):
    r"""
    This is the identity DP ($\F = \R$)

    Relation:

        $$
          \fun \leq \res
        $$


    Attributes:

        F (Poset): The functionality poset $\F$
        R (Poset): The resources poset $\R$


    Note:

        It can be seen as a special case
        of [AmbientConversion][act4e_mcdp.primitivedps.AmbientConversion]
        where $\common = \F = \R$.
    """
    F: Poset[T]
    R: Poset[T]