Skip to content

IndicatorFunctionConfig ¶

Bases: BaseModel, _EnableMixin

Configuration for indicator functions to implement inequality constraints.

Attributes:

Name	Type	Description
`penalty`	`PenaltySetting`	Custom penalty setting for indicator functions.
`method`	`Literal['const', 'str']`	Indicator function implementation method. Default: `"const"` Two options are available: `"const"`: Applies a constant penalty for every constraint violation. `"if"`: Applies the objective function only if all constraints are satisfied. Automatically ensures objective to be negative.
`enable`	`bool`	Toggle to enable or disable this method. Default: True.

enable `class-attribute` `instance-attribute` ¶

enable: bool = True

method `class-attribute` `instance-attribute` ¶

method: Literal["if", "const"] = Field(
    default="const",
    description="Method of indicator function implementation. Constant Penalty (const) or conditional application of cost function (if).",
)

penalty `class-attribute` `instance-attribute` ¶

penalty: PenaltySetting = Field(
    default_factory=lambda: PenaltySetting(scaling=1),
    description="Penalty setting for indicator functions.",
)