Unit Description

Authors

Joe Starr, Ph.D.

I specialize in computational knot theory. I’m also a professional embedded software engineer.

Class Diagram

classDiagram
   cli *-- toml_parser
   cli *-- resolution_machine
   cli *-- prodstr_store 
   cli *-- argparse 
   cli -- pdgl 

   class cli{
    <<executable>>
    int main()
    }

   class pdgl{
    + pdgl(string)
    + pdgl(string,int,int)
    + ~pdgl()
    + bool run() 
    - string language
    - prodstr_store_t *store
    - resmach_stack_t *stack 
    - size_t stack_size
    - size_t seed
    }

   class prodstr_store{<<External>>}
   class toml_parser{<<External>>}
   class resolution_machine {<<External>>}
   class argparse{<<External>>}

Interfaces

None

Libraries

argparse

Functionality

Public Classes

PDGL

Container class used for producing and running a PDGL stack.

Public Functions

Constructor

The class has two constructors:

A constructor with three arguments for:
language specification
stack_size
random seed
A constructor with an argument for the language specification. The stack size is defaulted to 100 and the random seed is generated in the function.

De-constructor

The de-constructor handles the freeing of the memory allocated in the C stack.

Run

The run function executes the generation of a single word of the configured language.

stateDiagram-v2
    state "Parse toml" as pt
    state "Init random" as ir 
    state "Execute resolution machine" as erm
    [*] --> pt
    pt --> ir
    ir --> erm
    erm -->  [*]

Public Functions

Main

Main calling routine. Uses argparse for parsing arguments and reads file content off stdin.

stateDiagram-v2
    state "Parse arguments" as pa
    state "Read from stdin" as rfs
    state "Execute PDGL" as ep
    state "word--" as wm 
    state is_complete <<choice>>
    [*] --> pa
    pa  -->  rfs
    rfs --> is_complete
    is_complete --> ep: Word count is not reached
    ep --> wm 
    wm --> is_complete
    is_complete --> [*]: Word count is reached

Validation

Integration Test Toolchain

Integration tests are to be performed manually. This is accomplished by running the tool with the supplied language specifications as:

cat <language> | <pdgl_cli> -c <n>

or with heaptrack

cat <language> | heaptrack <pdgl_cli> -c <n>

language specification TOML files can be found in the language directory or in the ./wrappers/cli/test directory.

Tests

Positive tests

Valid configuration

The tool is configured for generation of 10 words.

Inputs:

A valid configuration:
The Dyck language specification
10 words
Stack size is 100
A valid configuration:
The Dyck language specification
10 words
Stack size is 1

Expected Output:

Output is valid

Negative tests

Detect memory leaks

The tool is configured for generation of 100000 words. Execution is profiled by heaptrack.

Inputs:

A valid configuration:
The Dyck language specification
100000 words

Expected Output:

No memory leaks detected in heaptrack

[!test-card] "Invalid language configured"

The tool is configured for generation of 10 word but with Invalid language specification.

Inputs:

An invalid language specification is configured.

Expected Output:

Error in toml is reported.