relation¶

class pyrecodes.relation.relation.Binary(parameters={})¶

Bases: ConcreteRelation

Class for a binary relation that returns 1 if input is 1 and 0 otherwise.

get_output(input: float) → float¶

class pyrecodes.relation.relation.ConcreteRelation(parameters={})¶

Bases: Relation

get_output(input: float)¶

valid_input(input: float) → bool¶

class pyrecodes.relation.relation.Constant(parameters={})¶

Bases: ConcreteRelation

Class for a relation that always returns 1.0 for any valid input.

get_output(input: float) → float¶

class pyrecodes.relation.relation.Linear(parameters={})¶

Bases: ConcreteRelation

Class for a relation that returns the input value - that is the relation between the input and output is linear with a coefficient of 1.

get_output(input: float) → float¶

class pyrecodes.relation.relation.MultipleStep(parameters={})¶

Bases: ConcreteRelation

Multiple step relation between input and output.

Step limits define the values at which the output changes. Step values define the output values.
if limit smaller than the lowest limit, output is 0.0
if limit larger than the largest limit, output is 1.0

Note: input has to be rounded, otherwise comparison does not work.

get_output(input: float) → float¶

get_step_id(input: float) → int¶

set_steps(step_limits: list[float], step_values: list[float])¶

class pyrecodes.relation.relation.Relation(parameters: dict)¶

Bases: ABC

Class used to define various relations between component attributes in pyrecodes.

abstract get_output(input: float) → float¶

class pyrecodes.relation.relation.ReverseBinary(parameters={})¶

Bases: ConcreteRelation

Class for a binary relation that returns 1 if input is 0 and 0 otherwise.

get_output(input: float) → float¶

class pyrecodes.relation.relation.ReverseLinear(parameters={})¶

Bases: ConcreteRelation

Class for a relation that returns 1 - input value.

get_output(input: float) → float¶