API Reference

paramita.plugins module

ParameterSpace

Manages a collection of parameters, each identified by a unique name.

all_parameters

all_parameters()

Get all the valid parameters from this space.

Returns:

Type	Description
list[str]	The parameters' names.

get_parameter

get_parameter(name)

Get the parameter with this name.

Parameters:

Name	Type	Description	Default
name	str	The name of the parameter to retrieve.	required

Returns:

Type	Description
Parameter	The parameter identified by the name.

Parameter

Base class for all parameter types.

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

CategoricalParameter

Bases: Parameter

Represents a categorical parameter with discrete choices.

Values for the choices are std::string.

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

IntegerParameter

Bases: Parameter

Represents an integer-valued parameter with a range of valid values.

The domain is an inclusive .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

RealParameter

Bases: Parameter

Represents a floating-point parameter with range constraints.

The domain is an inclusive .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

BooleanParameter

Bases: Parameter

Represents a boolean-valued parameter.

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

PluginParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

ClauseContainerParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

NonIncrSatSolverParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

SatSolverParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

WClauseContainerParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

NonIncrMaxSatSolverParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

PbToCnfEncoderParameter

Bases: Parameter

Represents a .

default_value

default_value()

The default value for this parameter.

Returns:

Type	Description
str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The default value.

is_valid

is_valid(value)

Checks that the value is in the domain and has the correct type.

Parameters:

Name	Type	Description	Default
value	str | int | float | bool | SatSolver | NonIncrSatSolver | ClauseContainer | NonIncrMaxSatSolver | WClauseContainer | PbToCnfEncoder | Plugin	The value to check.	required

Returns:

Type	Description
bool	True if the value is valid.

UnsupportedMethodException

Bases: Exception

read_interface_info

read_interface_info(arg)

default_plugin_search_paths

default_plugin_search_paths()

fetch_sources

fetch_sources(url, workdir)

BuildError

Bases: Exception

CMakeBuilder

find_plugins

find_plugins(directory)

Builder module-attribute

Builder = NewType('Builder', Callable[[Path, Path, Path, int, Dict[str, str]], None])

build_plugins

build_plugins(url, builder, *, install_dir, work_dir=None, njobs=1, env=None, stdout=None, stderr=None)