vix.ing · top · new · best · stats · spec

Flowgen: Flowchart-Based Documentation for C++ Codes

2014/05/13 by David A. Kosower, Kosower, David A., J. J. Lopez-Villarejo +1
Computer Science · Physics and Astronomy · #Computational Engineering #FOS: Computer and information sciences #FOS: Physical sciences #Finance #High Energy Physics - Experiment (hep-ex) #High Energy Physics - Lattice (hep-lat) #High Energy Physics - Phenomenology (hep-ph) #Software Engineering (cs.SE) #and Science (cs.CE) #cs.CE #cs.SE #hep-ex #hep-lat #hep-ph

paper · pdf · doi:10.48550/arxiv.1405.3240

17 pages, 10 figures, supplemental material (two ancillary files)

arxiv created 2014/05/13 · arxiv updated 2014/05/14

Abstract

We present the Flowgen tool, which generates flowcharts from annotated C++ source code. The tool generates a set of interconnected high-level UML activity diagrams, one for each function or method in the C++ sources. It provides a simple and visual overview of complex implementations of numerical algorithms. Flowgen is complementary to the widely-used Doxygen documentation tool. The ultimate aim is to render complex C++ computer codes accessible, and to enhance collaboration between programmers and algorithm or science specialists. We describe the tool and a proof-of-concept application to the VINCIA plug-in for simulating collisions at CERN's Large Hadron Collider.

Related