problem_metadata

class ProblemMetadata(problem: ProblemType)

Bases: ABC

Abstract class for the problem metadata.

Problem Metadata abstract class object constructor.

The constructor defines and holds common variables for different problems solved with CCVM solvers.

Parameters:

problem (ProblemType) – A problem type.

abstract generate_plot_data() → DataFrame

Generate data for plotting.

Plotting data will be varied by a different problem. Thus, for different problems, plotting data preparation code needs to be implemented in its inherited proble-specific metadata object.

Returns:

A new data for plotting.

Return type:

pd.DataFrame

abstract generate_success_prob_plot_data() → DataFrame

_summary_

Returns:

_description_

Return type:

pd.DataFrame

abstract ingest_metadata() → None

Take a file path to metadata and convert them into a pandas.DataFrame.

property problem: ProblemType

Problem type getter method.

Returns:

Problem Type.

Return type:

ProblemType

class ProblemType(value)

Bases: Enum

Problem type ENUM class.

BoxQP = 'BoxQP'

class TTSType(value)

Bases: Enum

Time-To-Solution Type ENUM class.

Either a CPU time (physical) or an optic device time (wallclock).

physical = 'physical'

wallclock = 'wallclock'