Sign upLogin

q-optimize/c3

View on GitHub
Star
c3/libraries/propagation.py

Summary

Maintainability
F
3 days
Test Coverage

File propagation.py has 744 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"A library for propagators and closely related functions"
import numpy as np
import tensorflow as tf
from typing import Dict
from c3.model import Model
Severity: Major
Found in c3/libraries/propagation.py - About 1 day to fix

    Cyclomatic complexity is too high in function pwc. (11)
    Open

    @unitary_deco
def pwc(
    model: Model,
    gen: Generator,
    instr: Instruction,
    Severity: Minor
    Found in c3/libraries/propagation.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function tf_batch_propagate has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def tf_batch_propagate(
    hamiltonian, hks, signals, dt, batch_size, col_ops=None, lindbladian=False
):
    """
    Propagate signal in batches
    Severity: Minor
    Found in c3/libraries/propagation.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

    Cyclomatic complexity is too high in function tf_batch_propagate. (8)
    Open

    def tf_batch_propagate(
    hamiltonian, hks, signals, dt, batch_size, col_ops=None, lindbladian=False
):
    """
    Propagate signal in batches
    Severity: Minor
    Found in c3/libraries/propagation.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function pwc has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def pwc(
    model: Model,
    gen: Generator,
    instr: Instruction,
    folding_stack: list,
    Severity: Minor
    Found in c3/libraries/propagation.py - About 1 hr 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

    Function tf_batch_propagate has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def tf_batch_propagate(
    Severity: Major
    Found in c3/libraries/propagation.py - About 50 mins to fix

      Function tf_propagation_lind has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def tf_propagation_lind(h0, hks, col_ops, cflds_t, dt, history=False):
      Severity: Minor
      Found in c3/libraries/propagation.py - About 45 mins to fix

        Function ode_solver_final_state has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def ode_solver_final_state(
        Severity: Minor
        Found in c3/libraries/propagation.py - About 45 mins to fix

          Function ode_solver has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          def ode_solver(
          Severity: Minor
          Found in c3/libraries/propagation.py - About 45 mins to fix

            Function tf_dU_of_t_lind has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

            def tf_dU_of_t_lind(h0, hks, col_ops, cflds_t, dt):
            Severity: Minor
            Found in c3/libraries/propagation.py - About 35 mins to fix

              Function rk38 has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

              def rk38(func, rho, h, dt, col=None):
              Severity: Minor
              Found in c3/libraries/propagation.py - About 35 mins to fix

                Function tsit5 has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                def tsit5(func, rho, h, dt, col=None):
                Severity: Minor
                Found in c3/libraries/propagation.py - About 35 mins to fix

                  Function pwc has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                  def pwc(
                  Severity: Minor
                  Found in c3/libraries/propagation.py - About 35 mins to fix

                    Function rk4 has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                    def rk4(func, rho, h, dt, col=None):
                    Severity: Minor
                    Found in c3/libraries/propagation.py - About 35 mins to fix

                      Function rk5 has 5 arguments (exceeds 4 allowed). Consider refactoring.
                      Open

                      def rk5(func, rho, h, dt, col=None):
                      Severity: Minor
                      Found in c3/libraries/propagation.py - About 35 mins to fix

                        Function evaluate_sequences has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                        Open

                        def evaluate_sequences(propagators: Dict, sequences: list):
    """
    Compute the total propagator of a sequence of gates.

    Parameters
                        Severity: Minor
                        Found in c3/libraries/propagation.py - About 35 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

                        Refactor this function to reduce its Cognitive Complexity from 18 to the 15 allowed.
                        Open

                        def tf_batch_propagate(
                        Severity: Critical
                        Found in c3/libraries/propagation.py by sonar-python

                        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

                        See

                        Remove this commented out code.
                        Open

                            # U = tf_matmul_left(tf.cast(dUs, tf.complex128))
                        Severity: Major
                        Found in c3/libraries/propagation.py by sonar-python

                        Programmers should not comment out code as it bloats programs and reduces readability.

                        Unused code should be deleted and can be retrieved from source control history if required.

                        See

                        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
                        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
                        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
                        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

                        Rename function "step_vonNeumann_psi" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
                        Wontfix

                        def step_vonNeumann_psi(psi, h, dt):
                        Severity: Major
                        Found in c3/libraries/propagation.py by sonar-python

                        Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

                        Noncompliant Code Example

                        With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

                        def MyFunction(a,b):
    ...

                        Compliant Solution

                        def my_function(a,b):
    ...

                        Rename function "tf_dU_of_t_lind" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
                        Invalid

                        def tf_dU_of_t_lind(h0, hks, col_ops, cflds_t, dt):
                        Severity: Major
                        Found in c3/libraries/propagation.py by sonar-python

                        Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

                        Noncompliant Code Example

                        With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

                        def MyFunction(a,b):
    ...

                        Compliant Solution

                        def my_function(a,b):
    ...

                        Rename function "tf_dU_of_t" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
                        Invalid

                        def tf_dU_of_t(h0, hks, cflds_t, dt):
                        Severity: Major
                        Found in c3/libraries/propagation.py by sonar-python

                        Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

                        Noncompliant Code Example

                        With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

                        def MyFunction(a,b):
    ...

                        Compliant Solution

                        def my_function(a,b):
    ...

                        There are no issues that match your filters.

                        Category
                        Status