Unit Description

Class Diagram

classDiagram
    mut_ring shift --|> mutator
    mut_rlitt_ringshift_config_t --|> notation_wptt
    mut_rlitt_ringshift_config_t --|> mut_config_t
    mut_ring shift *-- mut_rlitt_ringshift_config_t

    class mutator{
        <<interface>>
    }

    class mut_ringshift {
    <<>>
    }

    class notation_wptt{
    <<>>
    }

    class mut_rlitt_ringshift_config_t {
    <<struct>>
    note_wptt * wptt
    }

    class mut_config_t {
    <<interface>>
    }

Language

C

Implements

Mutator Interface

Uses

Notation Weighted Planar Tangle Tree

Libraries

None

Functionality

Public Structures

Configuration Structure

The configuration structure contains the data needed for mutating the tree with \(R^\pm\).

This includes:

A pointer to a notation structure for a WPTT.

Public Functions

Configuration Function

The configuration function configures the local instance variable of the mutation.

This process is described in the following state machines:

stateDiagram-v2
  state "Init local configuration" as Sc

    [*] --> Sc
    Sc --> [*]

Mutate Function

The mutate function carries out the arborescent tangle ring shift mutation. The function may contain submachines that can be broken out into functions in the implementation.

This process is described in the following state machines:

stateDiagram-v2
    walk: Walk the tree and execute for each vertex visited

    state walk{
        state "shift rings of tree to the right" as sr
        [*]--> sr
          sr  -->[*]
    }
    [*] --> walk
    walk --> [*]

Private Functions

Sort Children

The sort children function uses the C standard qsort function to sort the children vertices of the object vertex.

Validation

Configuration Function

Positive Tests

Valid Configuration

A valid configuration for the mutation is passed to the function.

Inputs:

A valid configuration.

Expected Output:

A positive response.

Negative Tests

Null Configuration

A null configuration for the mutation is passed to the function.

Inputs:

A null configuration.

Expected Output:

A negative response.

Null Configuration Parameters

A configuration with various null parameters is passed to the function.

Inputs:

A configuration with null wptt.

Expected Output:

A negative response.

Mutate Function

Positive Tests

A valid configuration

A valid configuration is set for the component. The mutation is executed and returns successfully.

Inputs:

A valid configuration is set.

Expected Output:

A positive response.
Mutation is correct.

Negative Tests

Not Configured

The mutate interface is called before configuration.

Inputs:

None.

Expected Output:

A negative response.