libRosetta Users Guide

File Naming

libRosetta class source files are named with the class name:

   Class.fwd.hh    Class forward declaration header

   Class.hh    Class definition header

   Class.cc    Class implementation source (not all classes have these)

Classes and their files are generally given mixed case names like AminoAcid.

The forward declarations should, generally, be included instead of the full definition headers wherever it is legal to do so: this decoupling improves build times and lowers maintenance.

Private/implementation/detail classes and their sources have names ending with '_', such as Protein_.hh or AminoAcid_.hh. These should only be of interest for developers wanting to extend libRosetta or those curious about implementation details and algorithms.

Special Files

A few classes are named with a .ii extension. These are sources that could be separately compiled like .cc files but are included in another .cc file, generally for the purpose of controlling the initialization order of some global objects that are needed at startup time.