Class DivideBeforeMultiply

A detector that identifies and corrects instances of division before multiplication to ensure accurate mathematical operations.

Why is it bad?

Performing division before multiplication can lead to unexpected results due to precision loss and rounding errors:

  • Precision Loss: Dividing first can result in significant precision loss, especially when dealing with integers or fixed-point numbers.
  • Rounding Errors: Early division might cause rounding errors that propagate through subsequent calculations.
  • Unexpected Behavior: Incorrectly ordered operations can lead to incorrect outcomes, making debugging and maintenance more challenging.

Example

let a: Int = 10;
let b: Int = 3;
let c: Int = 2;
// Bad: Division before multiplication
let result: Int = a / b * c;

Use instead:

let a: Int = 10;
let b: Int = 3;
let c: Int = 2;
// Correct: Multiplication before division
let result: Int = a * c / b;

Hierarchy (view full)

Constructors

constructor

Properties

ctx

Accessors

id kind shareImportedWarnings usesSouffle

Methods

check createSouffleContext executeSouffle makeWarning skipUnused

Constructors

constructor

Properties

Readonlyctx

ctx: MistiContext

Accessors

id

  • get id(): string

  • Gets the short identifier of the detector, used in analyzer warnings.

    Returns string

    The unique identifier of the detector.

kind

shareImportedWarnings

  • get shareImportedWarnings(): WarningsBehavior

  • Defines the behavior of warnings generated by this detector when working with multiple projects within a single Tact configuration.

    Here are the available options:

    1. "union" Leave this value if you don't care about warnings generated in other projects.
    2. "intersect" If the warning is generated for some source location of the imported file, it should be generated by each of the projects. Example: Constants from an imported file should not be reported iff they are unused in all the projects, so you need "intersect".

    Returns WarningsBehavior

usesSouffle

  • get usesSouffle(): boolean

  • Checks whether this detector needs the Soufflé binary to be executed.

    Returns boolean

Methods

check

ProtectedcreateSouffleContext

  • createSouffleContext(cu, docstring?): SouffleContext<SrcInfo>

  • Creates a Soufflé context with unique name.

    Parameters

    • cu: CompilationUnit
    • docstring: undefined | string | string[] = ...

      A comment introduced on the top of the generated program if ctx.config.souffleVerbose is set.

      It should be used to avoid name clashes in the Soufflé directory when working with multiple projects.

    Returns SouffleContext<SrcInfo>

ProtectedexecuteSouffle

ProtectedmakeWarning

ProtectedskipUnused

Settings

Member Visibility

On This Page

Why is it bad?Example
Constructors
Properties
Accessors
Methods