MushroomRL/mushroom-rl

View on GitHub
mushroom_rl/solvers/dynamic_programming.py

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Function policy_iteration has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Wontfix

def policy_iteration(prob, reward, gamma):
    """
    Policy iteration algorithm to solve a dynamic programming problem.

    Args:
Severity: Minor
Found in mushroom_rl/solvers/dynamic_programming.py - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid deeply nested control flow statements.
Wontfix

                    if va > vmax and not np.isclose(va, vmax):
                        policy[state] = action
                        vmax = va
                        changed = True

Severity: Major
Found in mushroom_rl/solvers/dynamic_programming.py - About 45 mins to fix

    Function value_iteration has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Wontfix

    def value_iteration(prob, reward, gamma, eps):
        """
        Value iteration algorithm to solve a dynamic programming problem.
    
        Args:
    Severity: Minor
    Found in mushroom_rl/solvers/dynamic_programming.py - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    There are no issues that match your filters.

    Category
    Status