12. Changes¶
Renamed FlowSequenceQuery to CausalityFlowQuery and require a DG for construction. So instead of FlowSequenceQuery() do CausalityFlowQuery(flow.dg). And instead of s.hasDAG(q) and s.getDAG(q) do q.findDAG(s). It returns either a DAG or None if none can be found.
Renamed dgFlowDump to Flow.load, a staticmethod.
Flow.vertexFilter/flow::Flow::setVertexFilter has been replaced with Flow.excludeVertex(x).
Potentially less bfsExclusion in overallAutocatalysis when vFilter was used, as now incident edges are also excluded. The old behaviour was wrong.
Flow.calc() -> Flow.findSolutions()
Removed config.dg.productLimit
Stochsim: add sphinx-autoapi as dependency
12.1. v0.11.0 (2020-08-31)¶
12.1.1. Incompatible Changes¶
Bump version requirement of Boost to 1.72.
dg::Printer::pushVertexVisible()
/DGPrinter.pushVertexVisible()
,dg::Printer::pushVertexLabel()
/DGPrinter.pushVertexLabel()
, anddg::Printer::pushVertexColour()
/DGPrinter.pushVertexColour()
now requies a callback taking adg::DG::Vertex
/DGVertex
, instead of agraph::Graph
/Graph
anddg::DG
/DG
. The previous style is removed in libMØD and deprecated in PyMØD.dg::DG::HyperEdge::print()
/DGHyperEdge.print()
now throws exceptions if either no rules are associated with the hyperedge or if at least one of the associated rules does not lead to a derivation.dg::PrintData
/DGPrintData
, many interface changes, including proper argument checking.dg::DG::dumpImport()
has been renamed todg::DG::load()
.dgDump()
has been renamed toDG.load()
.dg::DG::load()
/DG.load()
has additional arguments and pre-conditions.Do not install a pkg-config file. It was broken and there doesn’t seem to be an easy way to fix it.
12.1.2. New Features¶
Added
dg::Builder::apply()
/DGBuilder.apply()
as a lower-level function for computing proper direct derivations.graph::Graph::smiles()
/smiles()
:Generalize the parser to accept almost arbitrary strings as symbols inside brackets. See SMILES. This is only allowed when passing
allowPartial=True
tosmiles()
.Generalize the parser to accept ring-bonds and branches in mixed order.
Generalize the parser to accept non-standard charges:
+++
,++
,---
,--
, and magnitudes larger than +/-9.
Added the PyMØD submodule EpiM.
Added
SmilesClassPolicy
/SmilesClassPolicy
argument tograph::Graph::smiles()
/smiles()
.Support using either Open Babel 2 or 3 as dependency.
Make
DGPrinter.graphPrinter
writeable as well.Make
graph::Printer
/GraphPrinter
equality comparable.Added
dg::Printer::setGraphvizPrefix()
/dg::Printer::getGraphvizPrefix()
/DGPrinter.graphvizPrefix
.Improve verbosity level 8 information from
dg::Builder::execute()
/DGBuilder.execute()
to the unvierse size.Make
LabelSettings
/LabelSettings
equality comparable.Added
rngUniformReal()
/rngUniformReal()
.
12.1.3. Bugs Fixed¶
Fix handling of null pointers:
Derivation
/Derivation
printing.Derivations
/Derivations
printing.Static and dynamic “add” strategies,
dg::Strategy::makeAdd()
/DGStrat.makeAddStatic()
andDGStrat.makeAddDynamic()
.Sequence strategies,
dg::Strategy::makeSequence()
/DGStrat.makeSequence()
Rule strategies,
dg::Strategy::makeRule()
/DGStrat.makeRule()
Parallel strategies,
dg::Strategy::makeParallel()
/DGStrat.makeParallel()
Filter strategies,
dg::Strategy::makeFilter()
Execute strategies,
dg::Strategy::makeExecute()
Left/right predicate strategies,
dg::Strategy::makeLeftPredicate()
/DGStrat.makeLeftPredicate()
,dg::Strategy::makeRightPredicate()
/DGStrat.makeRightPredicate()
Revive strategies,
dg::Strategy::makeRevive()
/DGStrat.makeRevive()
Repeat strategies,
dg::Strategy::makeRepeat()
/DGStrat.makeRepeat()
Fix handling of empty functions given as callbacks:
graph::Graph::smiles()
/smiles()
:Improve parsing error messages.
Fix missing external ID for bracketed wildcard atoms with class label, e.g.,
[*:42]
.Fix handling of an atom which contains a ring-closure and ring-opening using the same ID, e.g.,
C1CCCP11NNNN1
.When there is a bond mismatch in a ring closure (e.g.,
C-1CCCC=1
), throw aInputError
/InputError
instead of aFatalError
/FatalError
.
dg::DG::print()
/DG.print()
, fix missing labels on shortcut edges when using adg::Printer
/DGPrinter
with “labels as Latex math” set to false.dg::Builder::addAbstract()
/DGBuilder.addAbstract()
:Improve parsing error messages.
Fix assertion on non-ASCII input.
include()
, read files in binary instead of ASCII.PostMØD: scale figures based on height as well to avoid them being clipped. Thanks to Christoph Flamm.
Fix
rule::Rule::getGMLString()
/Rule.getGMLString()
to not perform coordinate instantiation when not needed.Fix Python export of
RuleContextGraphVertex
.Properly throw exceptions from all
pop
functions indg::Printer
/DGPrinter
when there is nothing to pop.PostMØD: remove extranous escape of a quote in AWK script in
coordsFromGV
.Graph printing, fix coordinate overwrite when printing the same graph multiple times, but with different rotation or mirror settings, the layout of the last printing would be used for all of them. Those with non-zero rotaion and mirroring now have their own file name.
DG printing: fix bending of head/tail arrows when a tail vertex is also a head vertex so arrows don’t overlap.
#8: remove some linker flags when AppleClang is used.
12.1.4. Other¶
Doc, update theming again to increase readability.
Doc, add more formal API for the embedded strategy language for derivation graphs.
Doc, fix typo resulting in missing documentation of
Doc, various typo fixes.
Doc, clarify that
DGPrinter.pushVertexVisible()
,DGPrinter.pushEdgeVisible()
,DGPrinter.pushVertexLabel()
,DGPrinter.pushEdgeLabel()
,DGPrinter.pushVertexColour()
,DGPrinter.pushEdgeColour()
,DGPrinter.setRotationOverwrite()
,DGPrinter.setMirrorOverwrite()
accepts a constant as well as a callback.Doc, fix callback type for
DGPrinter.setRotationOverwrite()
andDGPrinter.setMirrorOverwrite()
. They must take aGraph
, not aGraphPrinter
.Doc, add return type to
DG.findEdge()
.Added
bindep.txt
andrequirements.txt
to make installation of dependencies much easier. The installation instructions are updated with a Quick Start guide and notes on the use of the dependency files.CMake, default
BUILD_EXAMPLES=on
.
12.2. v0.10.0 (2020-02-05)¶
12.2.1. Incompatible Changes¶
dg::DG::abstract
/dgAbstract
has been removed. Usedg::Builder::addAbstract()
/DGBuilder.addAbstract()
instead. Added slightly better documentation as well, Abstract Derivation Graphs.dg::DG::derivations
has been removed. Use the repeated calls todg::Builder::addDerivation()
instead.dg::DG::ruleComp
anddg::DG::calc()
has been removed. Use the newdg::Builder::execute()
instead.dgRuleComp
andDG.calc
has been deprecated, and their implementation is now based onDGBuilder.execute()
. UseDGBuilder.execute()
directly instead.The implementation of
dgDerivations
has changed and the function is now deprecated. Use repeated calls toDGBuilder.addDerivation()
instead.dg::Strategy::makeAdd()
overloads,DGStrat.makeAddStatic()
, andDGStrat.makeAddDynamic()
now requires another argument of typeIsomorphismPolicy
/IsomorphismPolicy
.Add Subset and Add Universe now accepts a new optional keyword argument
graphPolicy
of typeIsomorphismPolicy
.dg::DG::list
/DG.list
has been removed, usedg::ExecuteResult::list()
/DGExecuteResult.list()
instead.Information from strategies has been updated.
12.2.2. New Features¶
Added new incremental build interface for
DG
/dg::DG
. It includes:DG.__init__()
/dg::DG::make()
for constructing a derivation graph with this new interface.DG.build()
/dg::DG::build()
for obtaining an RAII-style proxy object for controlling the construction (DGBuilder
/dg::Builder
).
Added
Derivations
/Derivations
as an alternative toDerivation
/Derivation
which contains a list of rules instead of at most a single rule. The latter is implicitly convertible to the former.Rule
now has an overloaded operator<
.IsomorphismPolicy
/IsomorphismPolicy
has been added to help configure various algorithms by users.Added
MOD_NO_DEPRECATED
to make it easier to find usage of deprecated behaviour.Added
Rule.isomorphicLeftRight()
/rule::Rule::isomorphicLeftRight()
.
12.2.3. Bugs Fixed¶
Changed assert to a proper error message at code related to Open Babel. If MØD, or an extension library, is loaded with
dlopen
without theRTLD_GLOBAL
flag, there can be multiple copies of Open Babel symbols at the same time, which prevent MØD from accessing Open Babel operations..Document and check precondition on
dg::DG::HyperEdge::getInverse()
/DGHyperEdge.inverse
, that it is only avilable after the DG is locked.Properly throw an exception if
DGStrat.makeSequence()
/dg::Strategy::makeSequence()
if given an empty list of strategies.Properly implementing stringification of
LabelType
/LabelType
,LabelRelation
/LabelRelation
,LabelSettings
/LabelSettings
, andIsomorphismPolicy
/IsomorphismPolicy
.Build: disallow use of experimental Boost CMake support due to a linking problem.
12.2.4. Other¶
Various fixes for documentation formatting including new themeing.
Installation, highlight the more relevant
CMAKE_PREFIX_PATH
instead ofCMAKE_PROGRAM_PATH
.Bump recommended lower bound on GCC version to 6.1 in the documentation.
Updated documentation for
mod::Derivation
/Derivation
.Documentation, added explicit example section.
12.3. v0.9.0 (2019-08-02)¶
12.3.1. Incompatible Changes¶
Change to CMake as build system. See Installation for how to build the package, or used it as a submodule in another CMake project.
Now requires v0.4 of GraphCanon (and PermGroup).
dg::DG::getGraphDatabase()
now returns astd::vector
instead of astd::unordered_set
.Hide internal symbols in the library to increase optimization opportunities, and hide symbols in library dependencies. Libraries linking against libmod may stop linking, but configuration options has been added to disable symbol hiding.
12.3.2. New Features¶
dgDump
/dg::DG::dump
should now be much, much faster in parsing the input file and loading the contained derivation graph.dgRuleComp
/dg::DG::ruleComp
should now be much faster during calculation.Added
Graph.instantiateStereo()
/graph::Graph::instantiateStereo()
.Added
rngReseed()
/rngReseed()
.
12.3.3. Bugs Fixed¶
Fixed off-by-one error in DG dump loading,
dgDump
/dg::DG::dump
.Fixed issues with
auto
in function signatures which is not yet in the C++ standard.
12.3.4. Other¶
The functions
prefixFilename()
,pushFilePrefix()
, andpopFilePrefix()
used by theinclude()
function are now documented. A new classCWDPath
has been added.Use interprocedural/link-time optimization as default. It can be disabled with a configuration option.
12.4. v0.8.0 (2019-04-04)¶
12.4.1. Incompatible Changes¶
Now requires v0.3 of GraphCanon (and PermGroup).
graph::Graph::getMolarMass
/Graph.molarMass
has been removed.Python interface: remove auto-generated hash-functions from all classes. Note, most code broken by this was already silemtly broken.
Python interface: consistently disable all custom attributes on all classes.
Removed
dg::Strategy::GraphState::getHyperEdges
/DGStratGraphState.hyperEdges
. Use the graph interface ofdg::DG
/DG
instead.All atoms, including hydrogens, are now present with ids in strings from
graph::Graph::getSmilesWithIds()
/Graph.smilesWithIds
.dg::DG::print()
/DG.print
now returns a pair of strings, instead of just one string. The first entry is the old return value. The second entry is the tex-file to depend on for layout coordinates.SMILES parsing: disallow isotope 0 as it is equivalent to not specifying an isotope.
All classes in the Python interface without a custom hash function has their hash function removed. This is to prevent inconsistencies between hash and equality.
12.4.2. New Features¶
Added support for isotopes (see Molecule Encoding).
Added optional
printInfo
parameter todg::DG::calc
/DG.calc
. to allow disabling of messages to stdout during calculation.The graph interface on
dg::DG
/DG
can now be used before and during calculation.Added include of the PGFPlots package in the summary preamble.
Added
AtomId::symbol()
/AtomId.symbol
.Added an
add
parameter tographGMLString
,graphGML
,graphDFS
,smiles
,ruleGMLString
, andruleGML
. It controls whether the graph/rule is appended toinputGraphs
/inputRules
or not. It defaults toTrue
.Add
graph::Graph::getGraphDFSWithIds()
/Graph.graphDFSWithIds
for getting a string annotated with the internal vertex ids in form of the class labels. This mirrors the previously addedgraph::Graph::getSmilesWithIds()
/Graph.smilesWithIds
.Improve error messages from GML parsing of lists.
Changed the return type of
dg::DG::getGraphDatabase()
from a std::set to a std::unordered_set.dg::DG::HyperEdge::print()
/DGHyperEdge.print()
now returns a list of file data.The vertices and edges of all graph interfaces now have a conversion to bool:
graph::Graph::Vertex
/GraphVertex
,graph::Graph::Edge
/GraphEdge
rule::Rule::LeftGraph::Vertex
/RuleLeftGraphVertex
,rule::Rule::LeftGraph::Edge
/RuleLeftGraphEdge
rule::Rule::ContextGraph::Vertex
/RuleContextGraphVertex
,rule::Rule::ContextGraph::Edge
/RuleContextGraphEdge
rule::Rule::RightGraph::Vertex
/RuleRightGraphVertex
,rule::Rule::RightGraph::Edge
/RuleRightGraphEdge
The vertices of all graph interfaces now have a proper hash support.
Added
dg::Printer::setRotationOverwrite()
/DGPrinter.setRotationOverwrite()
anddg::Printer::setMirrorOverwrite()
/DGPrinter.setMirrorOverwrite()
.
12.4.3. Bugs Fixed¶
Throw
InputError
/InputError
when loading a DG dump when a rule in the dump can not be linked to a rule from the user.Fix molecule decoding of atoms with negative charge and a radical.
Fix dangling reference bug in first-order term handling.
Fix inifiinite loop bug in first-order term handling.
Remove extraneous template parameter lists to make it compile on GCC 8.
Fix the documentation of
Graph.minExternalId
,Graph.maxExternalId
,Rule.minExternalId
, andRule.maxExternalId
. It was not being rendered.Fixed documentation of the constructor for
AtomData
.Fix dangling references in morphism callbacks.
Make sure Open Babel is not called in some cases where it is not needed.
Find the library file for Boost.Python for Boost >= 1.67.
Fix ambiguity between variadic arguments and function parameter packs, making term morphisms and stereo morphisms slow.
Removed sanity check from GraphDFS loading which dominated the run time.
Document
inputGraphs
andinputRules
.
12.4.4. Other¶
Now compiles with
-fno-stack-protector
(some OS distributions messes with default flags).The Makefile from
mod --get-latex
now cleans.vrb
,.snm
, and.nav
files as well.
12.5. v0.7.0 (2018-03-08)¶
12.5.1. Incompatible Changes¶
Boost >= 1.64 is now required.
Two new libraries, GraphCanon and PermGroup, are now required dependencies.
Sphinx 1.7.1 is now required for building the documentation.
dg::DG::HyperEdge::print()
/DGHyperEdge.print
now also takes an argument for colouring vertices/edges that are not matched by the rule. The default is now that matched vertices/edges are the default colour, while those that are not matched are grey.Most of the outer interface headers have now been moved to subfolders, and their content has been moved to corresponding namespaces. Several classes has been slightly renamed during the move, and some headers has been split into multiple header files.
The previously deprecated class
DerivationRef
has now been removed along withDG.derivations
in the Python interface.The previously deprecated method
DG.vertexGraphs
in the Python interface has been removed.
12.5.2. New Features¶
Added functions to map external ids of graphs and rules to internal vertices.
Added functions to get vertex coordinates for rules.
dg::DG::print()
/DG.print
now returns the name of the PDF-file that will be created in post-processing.Add
dg::Printer::setWithInlineGraphs()
/DGPrinter.withInlineGraphs
to input raw tex files for graphs in nodes instead of compiled PDFs. The generated tex code for the graphs is different to ensure unique Tikz node names.Add
inline
as a special argument for the graph Latex macros to input the raw tex file, instead of including a compiled PDF.Add
graph::Graph::getSmilesWithIds()
/Graph.smilesWithIds
for getting a string annotated with the internal vertex ids in form of the class labels.The automorphism group of each graph is now available.
12.5.3. Experimental New Features¶
Vertex/edge labels in graphs/rules can now be interpreted as first-order terms. Syntactic unification is then performed during morphism finding. See where
LabelSettings
/LabelSettings
is being used. Each rule has an optionalLabelType
/LabelType
to signify whether it was designed for use withLabelType::String
/LabelType.String
orLabelType::Term
/LabelType.Term
. Some algorithms will check this property for safety reasons, but the check can be disbled.There is now a prototype-implementation of http://doi.org/10.1007/978-3-319-61470-0_4, for adding stereo-information to graphs/rules. Use
LabelSettings
/LabelSettings
objects to enable it. See the paper for examples on how to use it. The full framework will be implemented and documented in a future version.
12.5.4. Bugs Fixed¶
Multiple rules for the same derivation is now properly recorded.
Fix documentation of
rule::Rule::makeInverse()
/Rule.makeInverse
, it throwsLogicError
/LogicError
notInputError
/InputError
.Set the name of a rule from
rule::Rule::makeInverse()
/Rule.makeInverse
to something more descriptive.Fix graph/rule depiction bug with non-zero rotation.
Fix DG dump loading to also load derivations with no rules.
Don’t crash when trying
dg::DG::findVertex()
/DG.findVertex
with a graph not in the derivation graph.Don’t crash when trying to print derivations with multiple rules.
Fix documentation formatting errors.
#2, throw exceptions from
dg::DG::ruleComp
/dgRuleComp
anddg::DG::calc
/DG.calc
when isomorphic graphs are given.Throw more appropriate exception if
dg::DG::print()
/DG.print
is called beforedg::DG::calc
/DG.calc
.Various issues in graph/rule depiction related to positioning of hydrogens, charges, etc.
Build system: give better error messages if a file is given where a path is expected.
The produced SMILES strings are now truely canonical, as the new GraphCanon library is used.
Fix
AtomData
/AtomData
to properly print radicals on uncharged atoms.Throw more friendly exceptions when loading graphs/rules that have loop/parallel edges.
12.5.5. Other¶
The documentation now has a “Known Issues” section, describing an issue where post-processing may fail if
pdflatex
has been upgraded after installation
12.6. v0.6.0 (2016-12-22)¶
12.6.1. Incompatible Changes¶
A C++14 compiler is now required (e.g., GCC 5.1 or later).
The required Boost version is now either 1.59 or at least 1.61. Version 1.60 do not work due to https://github.com/boostorg/python/issues/56.
Make filenames in post-processing more Latex friendly.
Rules specified in GML using
constrainAdj
must now enclose the operator in double quotes.DG: remove most of the interface related to
DerivationRef
. Use the graph interface instead. E.g.,Deprecate
DerivationRef
. They now interconvert withdg::DG::HyperEdge
/DGHyperEdge
.Change
DG::getDerivationRef
intodg::DG::findEdge()
/DG.findEdge
.Make
DG.derivations
return the edges instead in the Python interface. It is removed in the C++ interface. It will be removed from Python in the future.Remove
DG::inDerivations
andDG::outDerivations
.Deprecate
DG::vertexGraphs
in Python, remove in C++.
Move the graph interface for DG and Graph into separate headers:
DGGraphInterface.h
andGraphGraphInterface.h
.Move
GraphPrinter
into a separate header.Move
DGPrinter
andDGPrintData
into a separate header.All SBML features have been removed from the library.
The deprecated
DG::printMatrix
function has been removed.dg::DG::calc
/DG.calc
will no longer print a message when it is done.dg::DG::print()
/DG.print
by default now only prints the hypergraph rendering. (For now, setConfig::DG::printNonHyper
to enable printing of the non-hypergraph rendering)graph::Graph::print()
/Graph.print
andrule::Rule::print()
/Rule.print
will now emit only one depiction when the two printers are equal.rule::Rule::print()
/Rule.print
, change the default colours used to indicate changes. Now different colours are used in L, K, R.DGHyperEdge.print
, change the default match colour.Add < operator to vertices and edges of Graph, Rule, and DG.
12.6.2. New Features¶
Reimplementation of GML parsing. It is now less strict with respect to ordering.
Rule application constraint that checks the shortest path between two given vertices.
Interactive mode for the wrapper script (option
-i
). It will use IPython as interpreter if it is available.The molecule model now includes radicals. The SMILES format has been extended to support radicals as well.
Plugin infrastructure to load additional Python modules when using the wrapper script.
Graph interface for rules: for a rule \(L \leftarrow K\rightarrow R\), the three graphs can be accessed. The rule it self acts as the graph that is the pushout of the rule span.
Graph loading: the ids used in GML and GraphDFS, as well as the class labels in SMILES can now be converted into vertices for the loaded graphs. If the class labels of a SMILES string are not unique, then none of them are available for querying.
Add
-v
as alias for--version
in the wrapper script.Add quite mode,
-q
, to the wrapper script.Add
graph::Printer::setRotation()
/GraphPrinter.rotation
. Internally computed coordinates will be rotated by the set amount of degrees.
12.6.3. Bugs Fixed¶
operator<<
for Derivation: only try to print the rule if there is one.Properly throw an exception when graph GML parsing fails.
Don’t throw an exception while throwing an exception when graphs are disconnected.
Fix bug in checking of certain
constrainAdj
during certain types of rule composition.Properly handle empty vertex/hyperedge ranges for DGs. Thanks to Robert Haas for reporting.
12.7. v0.5.0 (2016-03-07)¶
Initial public version.