timeloopfe.v4.constraints Namespace Reference

Classes
class	Constraint
	A constraint in the system. More...
class	ConstraintGroup
	A group of constraints. More...
class	Constraints
	Class representing constraints. More...
class	ConstraintsList
	A class representing a list of constraints. More...
class	Dataspace
	A constraint class for specifying dataspace properties. More...
class	Factor
	A loop factor (e.g., P=1) More...
class	Factors
	A list of factors used to describe loop bounds. More...
class	Iteration
	An iteration (spatial or temporal) constraint. More...
class	MaxOverbookedProportion
	A constraint that defines the maximum overbooked proportion. More...
class	Permutation
	A permutation of ranks. More...
class	ProblemDataspaceList
	A list of problem dataspaces. More...
class	Spatial
	A spatial iteration constraint. More...
class	Temporal
	A temporal iteration constraint. More...
class	Utilization
	A constraint that defines the utilization of a component. More...

Functions
"ConstraintGroup"	dummy_constraints (problem.Problem prob, bool create_spatial_constraint=False)
	Creates a dummy constraint group for the given problem.
	constraint_factory (dict constraint)
	Factory function to create constraint objects based on the provided dictionary.

Function Documentation

constraint_factory()

timeloopfe.v4.constraints.constraint_factory

(

dict

constraint

)

Factory function to create constraint objects based on the provided dictionary.

Args: constraint (dict): A dictionary containing the constraint information.

Returns: object: An instance of the appropriate constraint class based on the 'type' field in the dictionary.

Raises: ValueError: If the 'type' field is missing or not recognized.

dummy_constraints()

"ConstraintGroup" timeloopfe.v4.constraints.dummy_constraints	(	problem.Problem	prob,
		bool	create_spatial_constraint = False )

Creates a dummy constraint group for the given problem.

Args: prob (problem.Problem): The problem for which the constraints are created. create_spatial_constraint (bool, optional): Whether to create a spatial constraint. Defaults to False.

Returns: ConstraintGroup: The created constraint group.