Source code for qcp.cli.options

# Copyright 2022 Tiernan8r
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Defines the enums that encode the CLI option values
"""
import enum
from typing import List

from qcp.algorithms import Grovers, PhaseEstimation, Sudoku


class AlgorithmOption(enum.Enum):
    """
    Enum of the different algorithms to simulate
    """

    Grovers = "g"
    PhaseEstimation = "pe"
    Sudoku = "s"

    @classmethod
    def list(cls) -> List[str]:
        """
        Return all the enum options' values

        returns:
            List[str]: All the strings the enums correspond to
        """
        return list(map(lambda ao: ao.value, cls))  # type: ignore

    def get_constructor(self):
        """
        Return the constructor that matches the enum
        """
        if self is AlgorithmOption.Grovers:
            return Grovers

        elif self is AlgorithmOption.PhaseEstimation:
            return PhaseEstimation

        elif self is AlgorithmOption.Sudoku:
            return Sudoku

    def get_name(self):
        """
        Return a string name of the Algorithm

        returns:
            str: The Algorithm display name.
        """
        if self is AlgorithmOption.Grovers:
            return "Grover's"

        elif self is AlgorithmOption.PhaseEstimation:
            return "Phase Estimation"

        elif self is AlgorithmOption.Sudoku:
            return "Sudoku"