Constraints API

Apply constraints to any SDV synthesizer.

Constraints API

add_constraints

Use this function to add constraints to your synthesizer.

Parameters

• (required) constraints: A list of constraint objects or an auto-detected ConstraintList object to add to your synthesizer. You can supply auto-detected constraints, predefined constraints or program your own constraints.

Output (None)

synthesizer.add_constraints(
    constraints=[my_constraint]
)

get_constraints

Use this function to inspect all of the constraints your synthesizer contains.

Parameters None

Output A list of the constraint objects that you have supplied to your synthesizer

synthesizer.get_constraints()

get_metadata

Adding constraints to your synthesizer may internally modify the metadata. Use this function to get the modified metadata after the constraints have been added.

Parameters

• version: The version of metadata to get. Supply 'modified' to get the modified version of the metadata (after applying the constraints).

Output A Metadata object with the modified metadata

modified_metadata = synthesizer.get_metadata(version='modified')