Masala Core library

Description

The Masala Core library version 1.1 defines the plugin system, the API definition system, and static singletons for managing shared resources like memory, output loggers (tracers), disk i/o, CPU threads, and MPI processes. It also defines base classes for certain types of Masala plugin modules.

Authors

• Vikram K. Mulligan, Ph.D., Research Scientist, Center for Computational Biology, Flatiron Institute (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org).
• Tristan Zaborniak, Ph.D. Candidate, Department of Computer Science, University of Victoria (tzabo.nosp@m.rnia.nosp@m.k@fla.nosp@m.tiro.nosp@m.ninst.nosp@m.itut.nosp@m.e.org).
• Noora Azadvari, Ph.D. Candidate, Department of Bioengineering, University of Oregon (eazad.nosp@m.var@.nosp@m.uoreg.nosp@m.on.e.nosp@m.du).
• Qiyao Zhu, Ph.D., Flatiron Research Fellow, Center for Computational Biology, Flatiron Institute (qzhu@.nosp@m.flat.nosp@m.ironi.nosp@m.nsti.nosp@m.tute..nosp@m.org).
• S.M. Bargeen A. Turzo, Ph.D., Flatiron Research Fellow, Center for Computational Biology, Flatiron Institute (bturz.nosp@m.o@fl.nosp@m.atiro.nosp@m.nins.nosp@m.titut.nosp@m.e.or.nosp@m.g).
• P. Douglas Renfrew, Ph.D., Research Scientist, Center for Computatinoal Biology, Flatiron Institute (pdren.nosp@m.frew.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org).

Library organization

This library is divided into hand-written sub-libraries and auto-generated API sub-libraries. All sub-libraries are in appropriately named sub-directories of the src/ directory; all namespaces start with masala, and then follow the directory structure. The namespaces of the hand-written sub-libraries are:

• masala::base
• masala::numeric
• masala::core

The corresponding auto-generated libraries are in the following namespaces:

• masala::numeric_api
• masala::core_api

Linking this library

If you link this library at compilation time, it is only safe to directly call functions or instantiate classes in the auto-generated API namespaces, or in the masala::base namespace. These have stable APIs that will be preserved in future versions of the Standard Masala Plugins library, or deprecated in a manner that provides ample warning. Handwritten sub-libraries other than the base sub-libarry are not part of the API, and can change without warning.