libcellml icon indicating copy to clipboard operation
libcellml copied to clipboard

Document methods in src/utilities.h

Open hsorby opened this issue 4 years ago • 0 comments

These methods should be documented in src/utilities.h:

void recordVariableEquivalences(const ComponentPtr &component, EquivalenceMap &equivalenceMap, IndexStack &indexStack);
void generateEquivalenceMap(const ComponentPtr &component, EquivalenceMap &map, IndexStack &indexStack);
void applyEquivalenceMapToModel(const EquivalenceMap &map, const ModelPtr &model);
NameList componentNames(const ModelPtr &model);
NameList unitsNamesUsed(const ComponentPtr &component);
EquivalenceMap rebaseEquivalenceMap(const EquivalenceMap &map, const IndexStack &originStack, const IndexStack &destinationStack);
std::vector<UnitsPtr> unitsUsed(const ModelPtr &model, const ComponentPtr &component);
ComponentNameMap createComponentNamesMap(const ComponentPtr &component);
void findAndReplaceComponentsCnUnitsNames(const ComponentPtr &component, const StringStringMap &replaceMap);

hsorby avatar Apr 28 '21 00:04 hsorby