algorithms_configurations module¶

A collection of algorithms configurations.

class gemseo_benchmark.algorithms.algorithms_configurations.AlgorithmsConfigurations(*algorithms_configurations, name='')[source]¶

A collection of algorithms configurations.

Parameters:

*algorithms_configurations (AlgorithmConfiguration) – The algorithms configurations.
name (str) –

By default it is set to “”.

add(algorithm_configuration)[source]¶

Add an algorithm configuration to the collection.

Parameters:: algorithm_configuration (AlgorithmConfiguration) – The algorithm configuration.
Raises:: ValueError – If the collection already contains an algorithm configuration with the same name.
Return type:: None

clear()¶

This is slow (creates N new iterators!) but effective.

discard(algorithm_configuration)[source]¶

Remove an algorithm configuration.

Parameters:: algorithm_configuration (AlgorithmConfiguration) – The algorithm configuration to remove.
Return type:: None

isdisjoint(other)¶

Return True if two sets have a null intersection.

pop()¶

Return the popped value. Raise KeyError if empty.

remove(value)¶

Remove an element. If not a member, raise a KeyError.

property algorithms: list[str]¶: The names of the algorithms in alphabetical order.

property configurations: list[AlgorithmConfiguration]¶: The algorithms configurations.

property name: str¶

The name of the collection of algorithms configurations.

Raises:: ValueError – If the collection of algorithms configurations has no name.

property names: list[str]¶: The names of the algorithms configurations in alphabetical order.