Page MenuHomeHEPForge
Files F11222067

No OneTemporary
Actions

View Options

diff --git a/ChangeLog b/ChangeLog
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,1852 +1,1860 @@
+2018-08-23 Andy Buckley <andy.buckley@cern.ch>
+
+ * Release 1.7.2
+
2018-08-22 Andy Buckley <andy.buckley@cern.ch>
* Avoid const-overloading clash for binAt functions.
+2018-08-14 Chris Gutschow <chris.g@cern.ch>
+
+ * Merge Graeme Watt's modifications to yodadiff.
+
2018-08-14 Andy Buckley <andy.buckley@cern.ch>
* Release 1.7.1
2018-08-08 Andy Buckley <andy.buckley@cern.ch>
* yodadiff now supports quiet (-q) and list (-l) modes.
2018-06-01 Louie Corpe <lcorpe@cern.ch>
* Point1,2,3D now support multiple error sources for the highest dimension.
* Scatter1,2,3D now read in/out with additional columns for the extra error
sources, with a variations() method to check with sources are available
2018-05-02 Andy Buckley <andy.buckley@cern.ch>
* StringUtils.h: Replace std::ptr_fun (removed in C++17) with a lambda function. Thanks to Stefan Richter.
2018-04-30 Andy Buckley <andy.buckley@cern.ch>
* Add "-" = stdin/stdout recognition to C++ IO functions.
* Convert remaining Python read/write methods to use the C++ IO functions.
* Convert Python read/write methods with filename arguments to use the gzip-aware IO functions.
2018-04-27 Andy Buckley <andy.buckley@cern.ch>
* Fix missing lock=false flag initialisation in Histo2D constructor from a Bins vector.
* Improve axis locking error messages.
2017-12-21 Andy Buckley <andy.buckley@cern.ch>
* Version 1.7.0 release
2017-12-11 Andy Buckley <andy.buckley@cern.ch>
* Add Nentries printout to yodals -v
2017-09-18 Andy Buckley <andy.buckley@cern.ch>
* Patches for ROOT conversion from Robert Hatcher -- thanks!
2017-09-16 Andy Buckley <andy.buckley@cern.ch>
* Add YODA format version annotation, at version 2, and update
YODA reader to use version info and multiline YAML EOF marker.
* Write YODA annotations in YAML with a --- YAML break-line.
2017-09-14 Andy Buckley <andy.buckley@cern.ch>
* Enable compressed writing from Python.
2017-09-13 Andy Buckley <andy.buckley@cern.ch>
* Remove UNUSED macro in favour of anonymous args.
* Enable zipped writing... but only works from C++ so far.
2017-09-11 Andy Buckley <andy.buckley@cern.ch>
* Add HistoBin2D::area(), and provide a default normto=1.0
argument on the Python Histo2D.normalize() method.
2017-09-04 Andy Buckley <andy.buckley@cern.ch>
* Change license explicitly to GPLv3, cf. MCnet3 agreement.
* Parse YODA format AO headers as YAML (restriction to single-line dict entries for now).
2017-08-24 Andy Buckley <andy.buckley@cern.ch>
* Use a slightly enhanced fast numeric parser in ReaderYODA (taken
from LHAPDF, originally inspired by Gavin Salam).
* Add an UNSCALE spec option to yodascale, to undo ScaledBy effects.
2017-08-19 Andy Buckley <andy.buckley@cern.ch>
* Add optional zlib support via zstr -- massive thanks to Dmitry
Kalinkin for the lovely patch!
2017-08-16 Andy Buckley <andy.buckley@cern.ch>
* Fix setVal(i, x) numbered-axis methods on Point2D and Point3D:
switch break statements were missing.
* Explicitly load all ROOT objects as a list rather than
generator. Patch from Dmitry Kalinkin.
2017-07-24 Andy Buckley <andy.buckley@cern.ch>
* Improvements to yodaplot, including two operating modes: the
default CMP mode is suitable for plotting histos by path, from raw
.yoda files.
* Update yoda.plotting functions to treat plot-keys as args and AO
annotations via case-insensitive keys.
* Add annotationsDict to the Python AO interface.
* Add AO as an alias for AnalysisObject.
2017-07-23 Andy Buckley <andy.buckley@cern.ch>
* Add parallel/compatibility yoda1 package to aid eventual transition to YODA v2.
2017-07-22 Andy Buckley <andy.buckley@cern.ch>
* Add x,y,zMins and Maxs to all 1D data types and scatters (and
x,yMin/Max to the scatters) -- Python interface only.
* Rework some of the yoda.plotting tools, making it a bit more
compatible with user-scripted matplotlib.
2017-07-18 Andy Buckley <andy.buckley@cern.ch>
* Add convenience aliases H1D, H2D, P1D, P2D, and S1D, S2D, S3D
for the HistoXD, ProfileXD, and ScatterXD classes respectively.
2017-07-08 Andy Buckley <andy.buckley@cern.ch>
* Add xyVals/Errs and other 'bin array property' accessors to the
Python Histo1D and Profile1D types: important for connection to
matplotlib.
2017-06-28 Andy Buckley <andy.buckley@cern.ch>
* Use Python natsort library to sort yodals output if available.
2017-06-18 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.7 release.
2017-05-12 Andy Buckley <andy.buckley@cern.ch>
* pyext/yoda/rootcompat.pyx: Fix ordering of TH1 vs. TProfile
conversion -- TProfile *is* a TH1, so we have to test for the more
specific type-match first. Thanks to Dmitry Kalinkin for the
patch.
2017-05-02 Andy Buckley <andy.buckley@cern.ch>
* Add static Reader methods to match the Writer ones.
2017-02-23 Andy Buckley <andy.buckley@cern.ch>
* Fix Histo2D and Profile2D total distribution reading from YODA format.
2017-02-19 Holger Schulz <holger.schulz@durham.ac.uk>
* Convert TH1F to TH1D in root2flat. Much simpler than duplicating
the TH1D stuff in pyext.
2016-12-13 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.6 release.
2016-12-12 Holger Schulz <holger.schulz@durham.ac.uk>
* Bugfixes in Cython bins accessors for Histo2D.
2016-11-17 Leif Lonnblad <leif.lonnblad@thep.lu.se>
* Fixed warning messages about the obsoleteness of AIDA so that the scripts actually still work.
2016-09-28 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.5 release, for the benefit of ROOT fans.
* Fix handling of --enable/disable-root configure options.
2016-09-26 David Grellscheid <david.grellscheid@durham.ac.uk>
* Improvements to Cython version testing.
2016-09-25 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.4 release.
2016-09-20 David Grellscheid <david.grellscheid@durham.ac.uk>
* Remove aliases for @property functions. They were scheduled for
removal anyway, and don't work with Cython >= 24.
2016-09-06 Andy Buckley <andy.buckley@cern.ch>
* Update configure scripts to use newer (Py3-safe) Python testing
macros.
2016-08-09 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.3 release!
2016-07-22 Andy Buckley <andy.buckley@cern.ch>
* Add 'add' modes for scatter combination to yodamerge.
* Fix yodamerge scatter averaging to use the first AO.
2016-07-21 Andy Buckley <andy.buckley@cern.ch>
* Add --type-mismatch-mode flag and fallback logic to yodamerge.
* Fix yodamerge logic to handle cases where an AO only appears once.
2016-07-19 Andy Buckley <andy.buckley@cern.ch>
* Deprecate flat2yoda script and add warning output to it and the AIDA conversion scripts.
* Add a convenience yoda2yoda script.
2016-07-14 Andy Buckley <andy.buckley@cern.ch>
* Try to build PyROOT interface by default, if root-config is found.
2016-07-11 Andy Buckley <andy.buckley@cern.ch>
* Remove accidentally remaining reference to Boost flags in yoda-config.
2016-07-06 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.2 release!
2016-07-05 Andy Buckley <andy.buckley@cern.ch>
* Pass the toNewScatter3D() scalebyarea flag to the called toScatter3D() functions.
2016-06-06 Andy Buckley <andy.buckley@cern.ch>
* Re-enable the disabled-for-some-reason Scatter1D combineWith Python mappings.
2016-04-28 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.1 release!
* Add a unit test for annotation handling correctness.
* Fix numerical precision of string storage of floating-point attributes.
* Fix a bug in use of the replacement for lexical_cast.
2016-04-20 Andy Buckley <andy.buckley@cern.ch>
* Version 1.6.0 release!
2016-04-16 Andy Buckley <andy.buckley@cern.ch>
* Extend SFINAE craziness to allow writing of any object
(e.g. smart pointer) that can be dereferenced to something that
has AnalysisObject as its base class... and also to any container
of them! Amazing what you can do with C++11!
2016-04-14 Andy Buckley <andy.buckley@cern.ch>
* Add a few consts to the arguments in Scatter error setting via pairs.
* Fix double-writing of minus errors in WriterYODA for Scatter1D
and Scatter3D. Thanks to Graeme Watt for the report and fix.
2016-04-12 Andy Buckley <andy.buckley@cern.ch>
* Remove Boost dependency and require C++11 compilation.
2016-04-08 Andy Buckley <andy.buckley@cern.ch>
* Add a --guess-prefix flag to yoda-config, cf. fastjet-config.
2015-12-20 Andy Buckley <andy.buckley@cern.ch>
* Change AO uncomputable division and mkScatter operations to
return/set NaN rather than 0 -- behaviour change requires new
major version series 1.6.
2016-03-09 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.9! (oh no, we're out of convenient version number space!!)
2016-03-08 Andy Buckley <andy.buckley@cern.ch>
* Add abs function to eq calculation in yodadiff.
2016-02-29 Andy Buckley <andy.buckley@cern.ch>
* Remove blocking of builds against ROOT6 -- it works fine.
2016-02-16 Andy Buckley <andy.buckley@cern.ch>
* Add a --add option to yodamerge, for simple histo
stacking. Thanks to Chris Gutschow for the patch, although my
spidey sense is tingling...
2015-12-21 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.8!
* Add a rebinning unit test, pytest-rebin.
* Add optional range arguments to rebinBy methods, allowing block
rebinnings to be applied only within a range of (original) bin
indices.
* Add missing root.py submodule file. Oops!
2015-12-20 Andy Buckley <andy.buckley@cern.ch>
* Convert linspace to use multiplication rather than repeated
addition to construct edge values, reducing precision errors.
Thanks to Holger Schulz for the suggestion.
2015-12-15 Andy Buckley <andy.buckley@cern.ch>
* Add xEdges() methods to Axis1D and the Histo1D and Profile1D
that use it. The returned edge lists are finite only, i.e. they do
not contain the +-inf values on the ends of the internal
BinSearcher edges.
2015-12-13 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.7!
* Extend batch-adding in ReaderYODA to include Scatter types.
* Add a match_aos function to Python, for filtering AO lists/dicts
on path patterns and anti-patterns.
2015-12-12 Andy Buckley <andy.buckley@cern.ch>
* Add a flag to yoda2root to change whether the conversion is to
'proper' types or to (more robustly) TGraphAsymmErrors objects.
* Fix accidental use of S2D_MODE flag where S1D_MODE should have
been used, in yodamerge. Thanks again to Radek Podskubka.
* Allow new rebinTo() merging to restrict to a subset of the bin
range, merging the outside bins into the overflow distributions.
2015-12-11 Andy Buckley <andy.buckley@cern.ch>
* Add a rebinTo() method on Axis1D, allowing rebinning to a new
given set of bin edges. Add an explicitly named rebinBy(), and
overloaded rebin() aliases for both, and pass through to Histo1D
and Profile1D APIs. Plus other internal tweaks to binning
functionality... anticipating/fuelling the fundamental rewrite.
2015-12-10 Andy Buckley <andy.buckley@cern.ch>
* Improve ReaderYODA to use temporary bin containers, to minimise
calling sort when adding bins to histos. A quick test suggests
this has sped up big file reading by a factor of 30 or so!!!
* Add missing addBins() operators (only in C++ so far) to Histo
and Profile classes.
* Fix Counter::numEntries to return an unsigned long rather than double.
Thanks to Radek Podskubka for the bug discovery and detective work.
* Improve sortedvector to insert new elements into the sorted
position, rather than resorting the whole vector. This should be a
bit more efficient, but I think the asymptotic complexity is the
same. Might help a bit with reading big data files.
2015-12-04 Andy Buckley <andy.buckley@cern.ch>
* Add yoda.HAS_ROOT_SUPPORT flag, for API user convenience.
2015-11-22 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.6!
* Make AO path setting and retrieval prepend a leading slash if it
is missing (unless the path is completely empty).
2015-11-21 Andy Buckley <andy.buckley@cern.ch>
* Add root2yoda conversion script.
* Deprecating yoda.to_root() in favour of yoda.root module, which
contains to_root and to_yoda functions, as well as a ROOT file
walking function.
2015-11-17 Andy Buckley <andy.buckley@cern.ch>
* Map ROOT-to-YODA (as scatter) functions to Python. Phew.
* Map new to-ROOT functions, including TGraph ones, to Python.
2015-11-16 Andy Buckley <andy.buckley@cern.ch>
* ROOTCnv.h: Add toScatter3D ROOT->YODA, and toNew* YODA->ROOT
conversion routines.
* ROOTCnv.h: Fix bug in toTH2D(const Histo2D& h) as used with
ROOT6. Thanks to Tim Martin.
2015-11-05 Andy Buckley <andy.buckley@cern.ch>
* Fix double-dealloc in new Point class hierarchy Python mapping.
2015-10-23 Andy Buckley <andy.buckley@cern.ch>
* Make the version() function inline, and the numerical constants static.
* Change the default plotting backend to MPL rather than the much slower PGF.
2015-10-09 Andy Buckley <andy.buckley@cern.ch>
* Reinstate __getitem__ special methods for Scatters in Python.
* Provide dim() methods/attributes for the Point and Bin base classes.
* Rename set*Err to set*Errs for the asymmetric variants. Plural
aliases are also provided for the symm case.
2015-10-08 Andy Buckley <andy.buckley@cern.ch>
* Pass std::pairs by reference in Point*D error setting functions.
* Add Point base class with generic accessors to Point*D
properties via an integer axis ID argument.
2015-10-07 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.5 release.
* Counter.pyx: Typo fix in sumW mapping.
* yodamerge: Re-add checking for non-emptiness before merging, in
case the empty ones are missing a ScaledBy attribute. Won't
normally apply to Profiles, since they don't usually get
normalised, but we might as well include them in the vetoing since
empty histos don't contribute to the merging. Added a command-line
option to disable this heuristic since in very strange situations
a null sumW does not mean no fills.
2015-10-06 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.4 release.
* ReaderYODA: Typo fixes in Counter filling of sumW and Scatter3D reader state flag.
* yodamerge: add merging heuristics for Scatter1D and Scatter3D (needs unification)
2015-10-05 Andy Buckley <andy.buckley@cern.ch>
* yodamerge: add a fix for empty-in-all-runs histo merging; thanks
to Daniel Rauch.
2015-10-04 Andy Buckley <andy.buckley@cern.ch>
* Adding dim() function and corresponding Python attribute to AnalysisObject.
* Map Counter arithmetic operations into Python.
* Map Counter mkScatter() into Python (as bound method).
* Add a YODA::version() function, mapped into Python and used to
set the yoda.__version__ variable.
2015-10-01 Andy Buckley <andy.buckley@cern.ch>
* Expose the yoda.plot() Python function in a way that doesn't
automatically induce a dependence on matplotlib.
2015-09-30 Andy Buckley <andy.buckley@cern.ch>
* Fix yodals to work with Counters.
2015-09-23 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.3 release.
* Update Boost version requirement to 1.48, due to use of
type_traits/has_dereference, and add a check for that feature's
header.
2015-09-19 Andy Buckley <andy.buckley@cern.ch>
* Further improvements to handling leading _multiple_ # marks on
YODA format BEGIN lines.
2015-09-11 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.2 release.
* Tolerate leading # symbols without separating whitespace on
BEGIN lines in YODA format parsing.
* Further improvements to handling LowStatsErrors in YODA format writing.
* Fix shadowed variables that made ReaderYODA unhappy.
2015-09-03 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.1 release.
* Fix bugs in Python wrapper for Point3D.
2015-08-28 Peter Richardson <Peter.Richardson@durham.ac.uk>
* Catch LowStatsError when writing multiple histograms so only the
histogram with the problem is not written
2015-08-28 Andy Buckley <andy.buckley@cern.ch>
* Version 1.5.0 release.
2015-08-24 Andy Buckley <andy.buckley@cern.ch>
* Improve protection of efficiency calculation against the weird
world of general weighted events.
2015-08-17 Andy Buckley <andy.buckley@cern.ch>
* Add some protection against calling matplotlib's legend() method
if there are no valid labels to display, to suppress an MPL
warning message when using yoda.plot().
2015-08-12 Andy Buckley <andy.buckley@cern.ch>
* Fix cut & paste typo, and add LowStatsError catching in Profile division.
2015-08-11 Andy Buckley <andy.buckley@cern.ch>
* Replace old Spirit-based ReaderYODA with the new hand-rolled one.
* Adding filling of Histo1D, Profile1D, Histo2D and Profile2D in
new ReaderYODA. More hacking of Axis and Histo/Profile
interfaces... needs clean-up, and infinite binning implementation.
2015-08-07 Andy Buckley <andy.buckley@cern.ch>
* Convert the ReaderFLAT parser to also use a simple hand-written parser rather than Spirit.
2015-08-04 Andy Buckley <andy.buckley@cern.ch>
* Add methods for Counter, Axis and Histo1D internal state
access/setting, mainly for new persistency. NEEDS PRE-RELEASE TESTING!!!
2015-07-30 Andy Buckley <andy.buckley@cern.ch>
* Remove # markers from YODA format BEGIN/END output. The parser
will continue to accept them.
2015-07-29 Andy Buckley <andy.buckley@cern.ch>
* Add SFINAE trait magic to restrict write(RANGE) functions to
accepting iterables. Also generalising to allow either
container-of-objects or container-of-pointers args by providing a
writeBody(AO*) function to complement writeBody(AO&). Based on a
patch from Lukas Heinrich.
* Add configuration of output streams to throw exceptions on
bad/fail state (based on patch from Lukas Heinrich).
2015-07-01 Andy Buckley <andy.buckley@cern.ch>
* 1.4.0 release.
2015-06-30 Andy Buckley <andy.buckley@cern.ch>
* More tweaks to yodamerge: adding control of S2D merging
strategy, and now performing weighted normalized histo merges
without reference to an absolute normalization.
* Change yodamerge norm-detection heuristic to just look for a
ScaledBy attribute rather than fuzzily compare norms.
2015-06-26 Andy Buckley <andy.buckley@cern.ch>
* Removing add, subtract, and divide functions and operators on
Scatter types, and re-implementing Histo and Profile divide
functions explicitly rather than via mkScatter. Also removed from
the Python interface. The combine() methods remain.
2015-06-24 Andy Buckley <andy.buckley@cern.ch>
* Adding workaround versions of binAt to all the Python histo
types (for some reason the direct mapping that works for bin(i)
produces a compile error for binAt(x) :-/
2015-06-23 Andy Buckley <andy.buckley@cern.ch>
* Renaming, tidying, completing, etc. the Python-mapped methods on Bin1D and Bin2D.
* Rename Python Histo2D mean, variance, etc. pair-returning
methods to xyMean, xyVariance, etc., to distinguish from Profile2D
mean, variance, etc.
* Add Python mappings of all the methods below.
* Add full set of {x,y}{Mean,Variance,StdDev,StdErr,RMS} to 1D and
2D binned distributions.
* Add optional includeoverflows=True argument to all binned AO
numEntries and effNumEntries.
* Fix type of numEntries to always be unsigned long.
2015-06-18 Andy Buckley <andy.buckley@cern.ch>
* Fix typos in Point3D Python mapping (accidentally trying to get
the ptr via _Point2D rather than _Point3D).
2015-06-13 Andy Buckley <andy.buckley@cern.ch>
* Adding an AnalysisObject::name() method, to return the last part
of the path. Mapped into a Python property.
* Adding an optional usestddev argument to mkScatter for profile
types, so the error bars can represent distribution width rather
than uncertainty on the mean. Mapped to Python.
2015-06-08 Andy Buckley <andy.buckley@cern.ch>
* Adding unpatterns arguments to Python read functions, and
auto-conversion from single strings and re.compile()d strs.
2015-06-04 Andy Buckley <andy.buckley@cern.ch>
* Add binAt(x,y) and binIndexAt(iglobal) Python methods for 2D
histos. Still want a way to get and pass a pair of bin indices, I
think.
* Adding includeoverflows optional args for Histo1D (eff)numEntries.
* Adding Rename Histo1D integral() methods as integral(),
integralRange(), and integralTo(), and mapping to Python.
2015-06-02 Andy Buckley <andy.buckley@cern.ch>
* Adding missing binAt and binIndexAt methods to Histo1D and
Profile1D, plus other minor Python mapping tweaks.
* Add a regex pattern match optional argument to the IO.read()
Python functions, for pre-emptive filtering.
2015-03-27 Andy Buckley <andy.buckley@cern.ch>
* Fix a harmless possibility to raise an FPE exception in the
BinSearcher. Thanks to Leif Lonnblad for the discovery, debug and
patch!
2015-03-19 Andy Buckley <andy.buckley@cern.ch>
* Bump version for 1.3.1 release.
2015-03-06 Andy Buckley <andy.buckley@cern.ch>
* Adding usefocus optional argument to some mkScatter functions, plus the Python bindings.
* Cleaning up some Python mappings of 2D histogram bin classes.
* Removing mappings of bin-level fill and scale operations in Python.
* Fix formatting and error handling in Python Bin and Dbn __repr__ methods.
* Add a -i/--in-place option pair on yodascale.
2015-02-05 Andy Buckley <andy.buckley@cern.ch>
* Convert script matching options to use re search rather than match.
* Adding matching options and verbose option to yodals.
2015-01-27 Andy Buckley <andy.buckley@cern.ch>
* Improvements and additions to ROOTCnv.h routines, particularly
to TProfile creation: thanks to Roman Lysak for advice.
2015-01-16 Andy Buckley <andy.buckley@cern.ch>
* Add convenience YODA/YODA.h header.
2015-01-15 Andy Buckley <andy.buckley@cern.ch>
* yodascale now uses PointMatcher and can normalize or multiply to
abs values or ref histos/bin ranges.
2015-01-05 Andy Buckley <andy.buckley@cern.ch>
* Adding yoda.matcher Python sub-package with PointMatcher
functionality. To be used in Professor 2.0 and in yodascale.
* Adding 'scat2' type to yodahist.
* Add match/unmatch args to all conversion scripts, via a new Python yoda.script_helpers function.
* Script updates, improved docstrings, and improved tab completion.
2014-12-10 Andy Buckley <andy.buckley@cern.ch>
* Add a yoda.plotting sub-module, based on matplotlib.
2014-12-03 Andy Buckley <andy.buckley@cern.ch>
* Small build improvements: cleaning test1.root from the yoda2root
test, and adding a make target & flag file for mktemplates in
pyext/yoda to make sure that it only gets run once.
2014-11-25 Andy Buckley <andy.buckley@cern.ch>
* Handle overflow filling in binned types without invoking an exception.
* Change inRange to have non-fuzzy comparison behaviour.
2014-11-11 Andy Buckley <andy.buckley@cern.ch>
* Improving/adding __div__ functions in Python for all binned types.
* Add std:: prefix to isinf() calls in BinSearcher.h.
2014-09-30 Andy Buckley <andy.buckley@cern.ch>
* 1.3.0 release!
* Use numEntries() rather than effNumEntries() when checking
consistency of inputs to efficiency() calculations -- the
effNumEntries of a set can be smaller than that of a strict
subset, surprisingly!
2014-09-17 Andy Buckley <andy.buckley@cern.ch>
* Small improvements to yodahist and yodaplot behaviours/UIs.
* Adding setX/Y/Z(val, err) methods to Point3D.
* Add an efficiency method for 2D histos.
* Hide fill and fillBin methods from Python mappings of bin types.
2014-09-01 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.2.1 release!
2014-08-29 Andy Buckley <andy.buckley@cern.ch>
* Hide non-const access to bin objects from histogram users:
avoids potential for inconsistency between total dbns and in-range
bins.
* Bug in BinSearcher fixed by Peter Richardson: constructor
arguments were passed in the wrong order when constructing a
LinEstimator in cases where log binning wouldn't be allowed.
2014-08-26 Andy Buckley <andy.buckley@cern.ch>
* Add protection against / characters in histo names in yoda2root
(thanks to Will Bell for the report and suggested patch).
2014-08-17 Andy Buckley <andy.buckley@cern.ch>
* Add +=, -=, *-, /=, ++ and -- operators to Counter, along with
an (implicit) constructor from a double -- all for user
convenience so Counter can be used in lieu of a simple number.
2014-08-15 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.2.0 release!
* Permit +-inf values to be filled into histograms; NaN fills will
still explicitly throw an exception.
* Add unit tests for Counter, Scatter1D, and Scatter2D, including
persistency.
* Adding YODA and FLAT format I/O for Scatter1D and Counter (as
far as currently possible -- FLAT Counter can't be read due to a
#item ambiguity, just like the one between the YODA format Point3D
and ProfileBin1D). To be continued...
2014-08-14 Andy Buckley <andy.buckley@cern.ch>
* Python mappings for Dbn0D and Counter, and other improvements.
* Adding val() and err() methods to Counter, and errW() and
relErrW() to all DbnXD types.
* Adding Scatter1D and Point1D types, with conversion from Counter
supported. Both Counter and Scatter1D still need to be supported
by YODA persistency.
2014-08-11 Andy Buckley <andy.buckley@cern.ch>
* Add ROOT version checking to configure. Thanks to Michael Grosse
for the report/request.
2014-08-05 Andy Buckley <andy.buckley@cern.ch>
* Remove all methods not specific about the axis to which they
refer, e.g. Histo1D::mean -> xMean. Also remove all related
aliases (a nightmare to maintain) and low/highEdge and midpoint
functions: use the proper xMin/Max/Mid from now on. This is a
significant compatibility breaking API change (and the decision
was not taken lightly) so will require a 2nd digit version change.
* Lots of adding xMin/Max etc. functions to C++ and Python bin/histo classes.
* Compiler pickiness fixes in BinSearcher.
* Improvement to linspace, avoiding fuzzyEquals and again making
sure that the end value is exact.
2014-07-23 Andy Buckley <andy.buckley@cern.ch>
* Fix to logspace: make sure that start and end values are exact,
not the result of exp(log(x)).
* Clean-up, minor improvements, and adding a test for BinSearcher and friends.
2014-07-19 Andy Buckley <andy.buckley@cern.ch>
* Various consistency improvements and minor bugfixes to Python
mapping utils and Dbn and Bin objects.
* Fix Axis2D::reset, which was resetting the total dbn and
outflows, but not the bins!!! Thanks to Ewen Gillies for the
report.
2014-07-18 Andy Buckley <andy.buckley@cern.ch>
* Add scaleX,Y,Z and scaleXYZ to Point and Scatter classes, and
deprecate less explicit/consistent Scatter2D/3D.scale method.
2014-07-17 Andy Buckley <andy.buckley@cern.ch>
* yodascale now writes out rescaled histograms and profiles rather than scatters.
* A few more improvements on Point2D/3D, adding x,y,zMin/Max function mappings.
* Add first version of a yodascale script, based on code from Simone Amoroso.
2014-07-16 Andy Buckley <andy.buckley@cern.ch>
* More Scatter and 2D histo interface improvement.
* Remove 'return *this' from Scatter2D/3D add and combine methods.
* Add unit test checks for 1D and 2D mkScatter functions.
* Improve Scatter2D/3D C++ and Python interfaces.
* Add Scatter3D Python mapping.
2014-07-15 Andy Buckley <andy.buckley@cern.ch>
* Add auto-parsing of yes/no/on/off/true/false as bools in the
Python ao.annotation() function.
* Add parsing of yodaplot styles from command line args and
analysis object annotations.
2014-07-12 Andy Buckley <andy.buckley@cern.ch>
* Fix infinite recursions in Python wrappers for Point2D and
Point3D, and make the Python Point3D interface more standard.
* Add yodaplot script for basic plotting, using pgfplots as a backend.
2014-07-10 Andy Buckley <andy.buckley@cern.ch>
* Add mkScatter(Scatter2D) and mkScatter(Scatter3D) functions and
Python mappings: this allows all AOs to be used as args to
mkScatter(...) without needing to check if they already are
scatters.
2014-07-02 Andy Buckley <andy.buckley@cern.ch>
* Set y value and/or error to 0 in mkScatter(Histo1D) if an
exception is thrown when calculating the appropriate values. Need
an optional param to control this error handling behaviour between
set-zero and skip-bin?
2014-07-01 Andy Buckley <andy.buckley@cern.ch>
* Add exception translation to the mkScatter functions.
* Add -m/-M match/unmatch options to yodacnv -- useful for
filtering histogram file contents in a YODA->YODA conversion.
2014-06-24 Andy Buckley <andy.buckley@cern.ch>
* Don't complain about merge assumptions if there is only one
object with that path name to be 'merged'
2014-06-17 Andy Buckley <andy.buckley@cern.ch>
* Adding explicit int cast in Python wrapping of numEntries functions.
2014-06-13 Andy Buckley <andy.buckley@cern.ch>
* Adding yodals script to list data file contents.
2014-06-11 David Grellscheid <David.Grellscheid@durham.ac.uk>
* pyext/yoda/Makefile.am: 'make distcheck' and out-of-source
builds should work now.
2014-06-10 Andy Buckley <andy.buckley@cern.ch>
* Fix use of the install command for bash completion installation on Macs.
2014-06-06 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.1.0 release. Middle version number change to reflect API changes w.r.t 1.0.6.
* Adding unit tests against ref data for yodamerge in make check.
2014-06-04 Andy Buckley <andy.buckley@cern.ch>
* Fix silly typos in yodamerge which somehow made it past "make check" testing :-(
2014-06-02 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.0.7 release. DO NOT USE: prefer 1.1.0, above.
2014-05-30 Andy Buckley <andy.buckley@cern.ch>
* Removing 'foreach' macro definition and using raw BOOST_FOREACH instead until C++11 is allowed.
* Adding pytest-p1d and pytest-p2d tests, and FLAT writing/reading in pytests.
* Tweaking WriterFLAT and adding ReaderFLAT functionality for 2D histos and profiles.
2014-05-30 Holger Schulz <hschulz@physik.hu-berlin.de>
* Some basic (FLAT) write-out capability for 2D histos
2014-05-29 Andy Buckley <andy.buckley@cern.ch>
* Improvements to the yodahist script, including support for 2D
histograms and input files.
* Adding bin edges constructors for all 1D and 2D histos in Python.
2014-05-22 Andy Buckley <andy.buckley@cern.ch>
* Improvements to Profile2D and Point2D interfaces in Python.
* Add a single-file at a time yodacnv multi-format converter
script (thanks to Andrii Verbytskyi for the suggestion).
2014-05-19 Andy Buckley <andy.buckley@cern.ch>
* Typo fixes in Profile2D YODA-format parsing: 2D histo tests now pass!
* Adding Python tests for Histo2D and Profile2D.
* Adding a YODA/Predicates.h header and using it in Axis2D bin edge construction.
* Enabling Profile2D writing in various Writers, and a bit of IO code tidying.
2014-05-17 Andy Buckley <andy.buckley@cern.ch>
* Disable writing out of Histo2D and Profile2D outflows for now,
while they are redesigned, and get 2D I/O working for the in-range
part.
2014-05-14 Andy Buckley <andy.buckley@cern.ch>
* Mapping the divide and efficiency functions into the Python
interface as class methods, including the __div__ special
function.
2014-05-13 Andy Buckley <andy.buckley@cern.ch>
* Add the AnalysisObject::type() method back in Python (even
though type(ao) is more Pythonic, this may be useful)
2014-05-06 Andy Buckley <andy.buckley@cern.ch>
* Add Profile2D YODA format writing, note need for Scatter format
change, add sumXY storage to both 2D histo types.
2014-05-03 Andy Buckley <andy.buckley@cern.ch>
* Adding YODA reader functionality for Histo2D and Profile2D, but
without outflows support yet.
2014-04-25 Andy Buckley <andy.buckley@cern.ch>
* Adding simple command line yodahist script for quick 1D
histogramming from plain text files, with weight support. More
development to come!
* Mapping linspace, logspace and a few stat functions into Python.
2014-04-24 Andy Buckley <andy.buckley@cern.ch>
* Fixes, script installation, and detailed numerical comparisons
in yodadiff.
2014-04-17 Andy Buckley <andy.buckley@cern.ch>
* Change AnalysisObject::annotations to return the list of
annotation keys rather than the map, since the previous behaviour
mapped very badly into Python.
2014-04-16 Andy Buckley <andy.buckley@cern.ch>
* Add special case handling for 2-arg use of x2y scripts where the
second arg is -, for stdin. This will be treated as writing out to
stdout, not converting two files one of which is stdin.
2014-04-15 Andy Buckley <andy.buckley@cern.ch>
* Adding a more portable version of getline to be used in the YODA
file parsing to avoid falling over on DOS-produced input files.
2014-04-14 Andy Buckley <andy.buckley@cern.ch>
* Adding the namespace protection workaround for Boost described
at http://www.boost.org/doc/libs/1_55_0/doc/html/foreach.html
2014-04-13 Andy Buckley <andy.buckley@cern.ch>
* Adding an assumed-equal-run-size, ratio-like merging heuristic
for Scatter2Ds to yodamerge, and renaming the --normalize-all flag
to --assume-normalized.
* Adding and installing a pkg-config data file for YODA.
* Rationalising (and fixing?) the yodamerge logic re. user &
normalization scalings, and making way for a Scatter2D merging
heuristic.
2014-03-10 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.0.6 release.
2014-03-06 Andy Buckley <andy.buckley@cern.ch>
* Improvements to AnalysisObject annotation handling in Python.
* Adding rescaling arguments to yodamerge (and scale function to Python Scatter2D).
* Better documentation and consistency of Histo and Profile Python
wrappers, and removing some inappropriate attributes.
* Adding clone() and newclone() functions to all analysis object classes.
2014-02-28 Andy Buckley <andy.buckley@cern.ch>
* Cython mapping improvements, esp. adding numPoints/numBins
functions and better Scatter2D __repr__.
* Adding mapping of the mkScatter functions into Python (as
methods on Histo1D and Profile1D rather than the original free
functions, at least for now: some Python type-identifying
boilerplate is needed to make a single mkScatter function work in
Python)
2014-02-27 Leif Lönnblad <Leif.Lonnblad@thep.lu.se>
* Minor modifications to BinSearcher to avoid NaN's. The NaN's
were treated correctly before, but better to avoid them all
together.
2014-02-27 Andy Buckley <andy.buckley@cern.ch>
* Adding the generated pyext/yoda/rootcompat.cpp to the tarball
and sorting out the ROOT/Cython interface conditionals a bit more
sanely. Thanks to Oldrich Kepka for the bug report.
* Protecting yodamerge against input histograms with zero
integrals (thanks to Christian Bierlich for the bug report).
2014-02-14 Frank Siegert <frank.siegert@cern.ch>
* Fix race condition with mktemplates.
2014-02-12 David Grellscheid <david.grellscheid@dur.ac.uk>
* Fix bug in mktemplates code (thanks to Christian Johnson for the bug report).
2014-02-09 Andy Buckley <andy.buckley@cern.ch>
* Adding explicit include/generated dir creation to Python
extension build (thanks to Christian Johnson for the bug report).
2014-02-06 Andy Buckley <andy.buckley@cern.ch>
* 1.0.5 release!
2014-02-05 Andy Buckley <andy.buckley@cern.ch>
* Adding patches to ReaderFLAT and ReaderYODA use of Boost Spirit
which reduce the Boost version requirement from 1.47 ->
1.41. Thanks to Andrii Verbytskyi for the patch.
* Protect against invalid prefix value if the --prefix configure option is unused.
2014-02-04 Andy Buckley <andy.buckley@cern.ch>
* Adding copy assignment operators where missing, based on an
implementation in AnalysisObject which only copies rvalue paths
and titles if they are non-null.
2014-02-03 Andy Buckley <andy.buckley@cern.ch>
* Improving (i.e. increasing) bin edge overlap tolerance: 1e-10 relative was too tight.
2014-01-31 Andy Buckley <andy.buckley@cern.ch>
* Adding x/yMid etc. methods on Bin1D and 2D, and more related Python API improvements.
2014-01-28 Andy Buckley <andy.buckley@cern.ch>
* Adding missing fillBin methods to 1D and 2D Histo/Profile Python classes.
* Fixed yodamerge default output file name treatment.
* Avoid computing an unrecoverable error in Histo1D.__repr__
* Clean-ups and API improvements in Python IO functions.
* Adding more sumW,W2 and (eff)NumEntries attrs to Python objects.
2013-12-17 Andy Buckley <andy.buckley@cern.ch>
* Improved argument handling for x2y scripts.
2013-11-16 Andy Buckley <andy.buckley@cern.ch>
* Fix to build the Cython rootcompt extension .cpp on request.
2013-11-14 Andy Buckley <andy.buckley@cern.ch>
* Adding flags for the C++11 or C++0x standard if supported, cf. Rivet.
2013-10-24 Andy Buckley <andy.buckley@cern.ch>
* YODA 1.0.4 release.
* Supporting zsh completion via bash completion compatibility.
2013-10-21 Andy Buckley <andy.buckley@cern.ch>
* Removing unused internal iterator typedefs from Writer functions.
2013-10-18 Andy Buckley <andy.buckley@cern.ch>
* Adding a yodaenv.sh sourceable script to help with environment setup.
* Remove Scatters from being handled by yodamerge by blocking the
__add__ method fallback.
2013-10-09 Andy Buckley <andy.buckley@cern.ch>
* Improvements to yoda-config and command-line completion, for the
Rivet 2.0.0 release.
2013-10-09 Andy Buckley <andy.buckley@cern.ch>
* Version 1.0.3 release.
2013-10-04 Andy Buckley <andy.buckley@cern.ch>
* Cython mapping improvements.
* Adding some improved heuristics and a --normalize-all option to
yodamerge. Frank S is now happy again ;-)
2013-10-01 Andy Buckley <andy.buckley@cern.ch>
* Adding operator +, -, +=, -= Python mappings wherever possible
for Histo1/2D, Profile1/2D, and Scatter2D.
2013-09-26 Andy Buckley <andy.buckley@cern.ch>
* Cython is no longer needed by tarball users.
2013-09-25 Andy Buckley <andy.buckley@cern.ch>
* Unset path of returned histogram if those of the args to add()
and subtract() are difference.
2013-09-24 Andy Buckley <andy.buckley@cern.ch>
* Python mapping improvements.
2013-09-23 Andy Buckley <andy.buckley@cern.ch>
* Add the -avoid-version flag to libtool.
* Adding more add and subtract special methods in Python.
2013-09-22 Andy Buckley <andy.buckley@cern.ch>
* mkScatter schanged to use histo midpoints rather than focuses by
default for the point x value.
2013-08-14 Andy Buckley <andy.buckley@cern.ch>
* Version 1.0.2.
* Some exception message improvements and improving the protection
of cosmetic mean calculations in WriterYODA.
2013-07-12 Andy Buckley <andy.buckley@cern.ch>
* Adding ROOT detection in configure and otherwise updating Dave's
rootcompat module so that it'll compile. There might be an
inconvenient ROOT version dependency in the signature of one of
the PyROOT API functions that is used as a shim :-(
2013-06-17 Andy Buckley <andy.buckley@cern.ch>
* Adding yoda.m4 from James Robinson.
2013-06-06 Hendrik Hoeth <hendrik.hoeth@cern.ch>
* Improve "==" operator in Axis1D and Axis2D
2013-06-06 Andy Buckley <andy.buckley@cern.ch>
* Adding fillBin() methods to all 1D and 2D histos, and noting
that Bin types need a back-link to their axis to maintain
consistency.
* Release of version 1.0.1
2013-06-05 Andy Buckley <andy.buckley@cern.ch>
* Change the divide(Scatter, Scatter) behaviours to use the
midpoint of the num/denom bins rather than mean of foci for the
output point position (and hence errors, too).
* Adding a toIntegralEfficiencyHisto function.
* Adding another Histo1D::integral() function, this time from 0 ->
i, maybe including the underflow.
2013-06-04 Andy Buckley <andy.buckley@cern.ch>
* Updating the Cython version requirement to 0.18
2013-06-03 Andy Buckley <andy.buckley@cern.ch>
* Adding relErr functions to 1D and 2D histo and profile bins, and
being careful about div by zero.
* Improvements in error treatment in division (better handling of zeros).
* Renaming merge-histos to yodamerge and installing it (and
improving the usage string a bit).
2013-05-31 Andy Buckley <andy.buckley@cern.ch>
* Adding the Counter type, and ability to output it from the YODA writer.
* Adding numEntries and effNumEntries methods to 1D and 2D Histo
and Profile classes.
* Adding Dbn0D and using it to implement Dbn1D.
2013-05-30 Andy Buckley <andy.buckley@cern.ch>
* Fixing several nasty errors in argument ordering for
Point{1,2,3}D construction in Scatter addPoint functions.
* Adding abs(...) to the returned Dbn1D::variance(), to avoid
problems when negative weights produce negative variance. No, we
don't like this either: is there a more correct way?
* Fixing the efficiency(Histo1D, Histo1D) implementation,
cf. http://root.cern.ch/phpBB3/viewtopic.php?t=3753
* Adding mkScatter(Profile2D)
2013-05-29 Hendrik Hoeth <hendrik.hoeth@cern.ch>
* Adding a reader for FLAT files and a flat2yoda converter
2013-05-27 Andy Buckley <andy.buckley@cern.ch>
* Adding a yoda-completion file for bash.
2013-05-17 Andy Buckley <andy.buckley@cern.ch>
* Mapping HistoBin1D.relErr in Python.
* Adding a non-const points() accessor to Scatter2D.
2013-05-13 Andy Buckley <andy.buckley@cern.ch>
* Adding combined value+error setX/Y functions on Point2D.
* Adding HistoBin1D::relErr()
2013-04-23 Andy Buckley <andy.buckley@cern.ch>
* Adding Python output handling for single AOs and to be able to
use a "-" filename to mean stdout.
2013-04-12 Andy Buckley <andy.buckley@cern.ch>
* Releasing version 1.0.0 -- it seems stable enough.
2013-04-10 Andy Buckley <andy.buckley@cern.ch>
* Being more careful about adding -Wno-* flags to the C++ compiler
used to built the Cython extension lib.
2013-03-22 Andy Buckley <andy.buckley@cern.ch>
* Removing the use of svn:external to pull in Boost macros and
using a minimal local set instead.
* Using the nice Boost-finding macros from
https://github.com/tsuna/boost.m4 and tidying up configure.ac
2013-03-15 Andy Buckley <andy.buckley@cern.ch>
* Re-organising the C++ side of the auto-format I/O functions,
into a new IO header and separated from the Reader.h and
Writer.h. I'm tempted to say that users shouldn't really NEED to
ever directly touch the Reader and Writer objects...
* Adding auto-format read and write functions. I will probably
change the API. Python mappings have been provided, but the string
workarounds were too much of a pain with Cython 0.16 so I have
updated the Cython version requirement to 0.17 where it is
automatic and hence much cleaner.
2013-03-08 Andy Buckley <andy.buckley@cern.ch>
* Making the x2y converter scripts write a copy into the *current*
directory if only the input is specified.
2013-03-05 Andy Buckley <andy.buckley@cern.ch>
* Removing Plot entirely from YODA: it was an anomaly only added
to make plot file generation easy, but this is now done better via
StringIO (in new compare-histos/rivet-cmphistos).
* Removing the Plot from Cython... and soon from YODA itself:
we'll do this stuff manually and less hackily.
* Make Cython automatically add a copy of the original call
signature to each function's docstring.
2013-03-04 Andy Buckley <andy.buckley@cern.ch>
* Adding Plot mapping to Cython and improving the AO annotations handling in Python.
* Adding PLOT section writing to WriterFLAT (and WriterYODA,
although that might be a bad idea...)
* Adding aida2yoda and aida2flat converter scripts.
2013-02-02 David Mallows <dave.mallows@gmail.com>
* Adding support for Python >= 2.4 (was Python >= 2.6)
* Fixing miscellaneous warnings on GCC 4.1
2013-01-30 Andy Buckley <andy.buckley@cern.ch>
* Adding a points() method to the Python Scatter2D wrapper.
* Adding a virtual destructor to Bin.
2012-12-30 Andy Buckley <andy.buckley@cern.ch>
* Adding support for Boost.Range arguments and file format autodetection in Writer.
2012-11-24 Andy Buckley <andy.buckley@cern.ch>
* Bump version to 0.6beta0
* Adding more ROOT converters. Who knows how to make TProfiles
from scratch, but Histo1D and Scatter2D are covered, which should
be enough to get started with, at least.
2012-11-16 Andy Buckley <andy.buckley@cern.ch>
* Adding yoda-config
2012-11-16 Hendrik Hoeth <hendrik.hoeth@cern.ch>
* Adding WriterFLAT and yoda2flat
2012-11-16 Andy Buckley <andy.buckley@cern.ch>
* Adding YODA/ROOTCnv.h. for data object converter functions. Two
(untested) functions added for TH1 -> YODA.
* Adding toIntegralHisto(Histo1D&) function.
2012-11-15 Dave Mallows <dave.mallows@gmail.com>
* Commited numerous changes to Axis2D. Axis2D now uses BinSearcher as
with Axis1D.
2012-11-15 Andy Buckley <andy.buckley@cern.ch>
* Improving division and efficiency treatments, and allowing
arbitrary f(x), f(y), and flip transformations on Scatter2D.
2012-11-14 Andy Buckley <andy.buckley@cern.ch>
* Converting linspace, logspace, and their usage to place the nbins argument first.
2012-08-07 Andy Buckley <andy.buckley@cern.ch>
* Removing unused (beyond 2nd order) sumWXYZ counter from Dbn3D.
2012-08-07 Dave Mallows <dave.mallows@gmail.com>
* Converted Axis1D to use new Utils/BinSearcher.
2012-08-02 Dave Mallows <dave.mallows@gmail.com>
* Heavily refactored Cython bindings
* HistoBin1D, ProfileBin1D etc. now inherit from Bin1D[DBN]
* Temporarily removed Histo2D, Profile2D and Scatter3D mappings.
2012-07-23 Andy Buckley <andy.buckley@cern.ch>
* Installing scripts from bin dir, and making the yoda2aida interface nicer.
* Adding Cython mappings for Dbn3D and Profile2D, and other fixes/improvements.
2012-07-22 Andy Buckley <andy.buckley@cern.ch>
* Adding Cython mappings for Scatter3D and ProfileBin2D.
* Fixing more crap code legacy from old 2D plot implementation, this time in Scatter3D.
2012-07-19 Andy Buckley <andy.buckley@cern.ch>
* Adding stdErr for Histo2D + Python mapping, and more Cython improvements.
* Adding path/title-only AO constructors and making nice Python constructor for Histo2D.
* Cython mapping improvements & additions for Point3D + Scatter3D.
* Removing mixed symm/asymm constructors on Point*D & Scatter*D classes.
2012-07-12 Andy Buckley <andy.buckley@cern.ch>
* Reintroducing Profile2D and Scatter3D.
* Adding axis locking to Axis2D.
* Supporting Histo2D in WriterYODA.
2012-07-02 Andy Buckley <andy.buckley@cern.ch>
* More incremental progress toward a working 2D bin hash mechanism.
2012-05-03 Andy Buckley <andy.buckley@cern.ch>
* Adding nice constructor behaviours to the Histo1D and Profile2D
Python interfaces, and adding the mkScatter operation for
Profile1D.
* Adding more default constructors for analysis objects, to allow
member variable and STL container use without pointers.
2012-05-02 Andy Buckley <andy.buckley@cern.ch>
* A much simplified and more robust rewrite of the Axis1D class,
just using STL map in place of the hand-written bin edge caching.
* Improvements (I hope) to the binary search in Axis1D, and
providing an experimental default constructor for Histo1D.
2011-12-08 Hendrik Hoeth <hendrik.hoeth@cern.ch>
* ReaderYODA can now parse Histo1D and Profile1D flat files
2011-12-08 Andy Buckley <andy.buckley@cern.ch>
* Adding a Utils::ndarray object and using it to implement a
general Scatter<N> system, with generalised Point<N> and Error<N>
to boot.
2011-12-07 Hendrik Hoeth <hendrik.hoeth@cern.ch>
* Lots of cleanup
2011-12-07 Andy Buckley <andy.buckley@cern.ch>
* Mapping the Dbn1D and Dbn2D classes into Python.
* Adding an outflows() accessor to Histo2D.
* Writing out total dbn lines for Histo1D and Profile1D in the
YODA format, and now writing out the 'cross-terms' for Profile1D,
too.
* Properly adding Dbn1D accessors for Histo1D.
* Updating the Cython mappings to provide the totalDbn() methods
and add a placeholder mapping for Dbn2D. Completed mappings are
needed for Dbn{1,2,3}D and the Profile types.
* Adding totalDbn() accessors to data types.
2011-12-06 Andy Buckley <andy.buckley@cern.ch>
* Making Histo1D/2D::scaleW() write a ScaledBy annotation.
* Adding annotation-fetching methods with a default return value
argument to AnalysisObject.
* Adding normalize() methods to Histo1D/2D.
* Adding weighted RMS calculating methods to Dbn1D, Dbn2D and
Bin1D/2D.
2011-09-03 Dave Mallows <dave.mallows@gmail.com>
* Fixed ReaderAIDA: x-value and low y-error interchanged when filling
Scatter2D.
* Changed to Cython for Python bindings: Swig bindings were in need of
serious amounts of work. Cython should provide a means to provide more
Pythonic bindings to YODA. A minimal subset of ReaderAIDA, Scatter2D
and Point2D have been wrapped.
* Modified configure.ac, Makefile.am and pyext/Makefile.am to reflect
change to Cython. Added cython.m4 from python-efl (Part of the
enlightenment project; LGPL)
2011-08-31 Dave Mallows <dave.mallows@gmail.com>
* Fixed python tests by installing python extension to pyext/build
2011-08-23 Andy Buckley <andy@insectnation.org>
* Adding rebinning interface to Histo1D and Profile1D, and adding
a test (and a new test feature for output message formatting)
* Adding first implementation of 1D bin merging to Axis1D.
2011-08-22 Andy Buckley <andy@insectnation.org>
* Adding copy constructors and assignment operators to Histo1D,
Profile1D, and Scatter2D, and their respective bins/points.
* Remove use of sign(weight) in filling sum(w2) -- I think this
was an historical attempt based on a scaling axiom which turned
out to be inappropriate.
* Reworking the Bin1D inheritance and composition design so that
all bin types store a single distribution object -- a Dbn1D for
histo bins and a Dbn2D for profile bins.
2011-08-18 Andy Buckley <andy@insectnation.org>
* Removing the Profile1D -> ProfileBin1D friendship. This is very
heartening -- the fewer friend declarations we need, the more
indication that the class structure is not pathological! (Or that
we've just made everything public... but we haven't)
2011-08-15 Andy Buckley <andy@insectnation.org>
* Inlining all functions in HistoBin1D, ProfileBin1D, and
HistoBin2D.
* Converting Dbn2D to be composed of two Dbn1Ds and a
cross-term. Also tidying the interfaces of the 2D classes and the
scaleX/Y methods throughout, and adding Doxygen comments.
2011-08-12 Andy Buckley <andy@insectnation.org>
* Adding proper Doxygen structures and full descriptive comments
to Dbn2D.
* Adding the persistency state-setting constructors for Profile1D
and Dbn2D.
* Inlining lots of methods on Dbn1D. Same should be done for
Dbn2D, but first it needs to be reimplemented in terms of two
Dbn1Ds + the cross-term.
2011-08-11 Andy Buckley <andy@insectnation.org>
* Various typo fixes and comments relating to persistency
constructors, Histo2D slicing, etc.
* Changing the HistoBin1D state-setting constructors (aargh, these
should *not* have already existed) to take Dbn1D as an argument
rather than a long list of doubles.
2011-08-01 Andy Buckley <andy@insectnation.org>
* Adding tests to check that implicit construction of Weights
objects from literal doubles and ints works.
2011-07-28 Andy Buckley <andy@insectnation.org>
* Bumping version number to 0.4.0beta0 -- there have been
substantial changes recently and YODA is now in a state where it
should be interesting for outsiders to start playing with it.
* Templating the Axis1D on the distribution type to be used for
total and under/overflow statistics: Profile1D now has Dbn2D
objects handling its total and overflow statistics.
2011-07-26 Andy Buckley <andy@insectnation.org>
* Added a Histo1D::integral(index1, index2) method. Not sure how
or if to extend this to Profile1D.
* Implementing incomplete Scatter2D operator+ and operator-
functions.
2011-07-25 Andy Buckley <andy@insectnation.org>
* Adding a Weights class, designed to seamlessly replace
double-type weights and weighted moments with a named and
vectorised form.
2011-07-19 Andy Buckley <andy@insectnation.org>
* Add Profile1D and Scatter2D division operators.
* Add xMin/xMax synonyms to the Axis1D, cf. the bins.
2011-07-18 Andy Buckley <andy@insectnation.org>
* Add a first stab at a Histo1D/Histo1D division operator.
2011-07-10 Andy Buckley <andy@insectnation.org>
* Add construction of Histo1Ds from Profile1D and Histo1D, and
construction of Profile1Ds from those and Scatter2D.
2011-07-07 Andy Buckley <andy@insectnation.org>
* Add construction of a Histo1D from Scatter2D.
2011-06-15 Andy Buckley <andy@insectnation.org>
* Making the AIDA reader work, including reading of annotations
and a few tweaks to the simple type persistency system. Test histo
1b updated.
2011-06-12 Andy Buckley <andy@insectnation.org>
* Removing Histo1D::area
* Filling and using under/overflow and total db on Histo1D, and
adding boolean arg to integral, sumW, etc.
* Fixing for C++ change in behaviour of std::make_pair
* Adding addAnnotation, and mapping annotations to Python.
2011-02-22 Andy Buckley <andy@insectnation.org>
* Use distutils rather than setuptools for the Python interface
build.
* Renaming Bin, HistoBin and ProfileBin to be Bin1D, HistoBin1D,
ProfileBin1D. Bin is now a top-level abstract class with minimal
functionality to be shared between 1D and 2D bins.
2011-01-12 Andy Buckley <andy@insectnation.org>
* Type annotations in mkScatter
* Added many vector constructors and addPoint functions to
Scatter2D.
2011-01-11 Andy Buckley <andy@insectnation.org>
* Add lexical_cast support to annotation get and set functions.
* Write out annotations in AIDA format, and copy annotations in
mkScatter -- using a new AnalysisObject::setAnnotations method.
* Convert DPS output to use interim Scatter construction
* Make (unused) yoda.plot subpackage.
* Write out annotations in YODA format.
* Make Scatter2D representations of Histo1D and Profile1D.
* Write out Scatter2D objects in AIDA and YODA formats.
* Make Scatter2D and Point2D work. Add a few extra
methods... evolution and tweaking required.
2011-01-10 Andy Buckley <andy@insectnation.org>
* Add Boost checks and header includes. Not used yet.
* Hide Utils:: content from Doxygen and nvector -> Utils::nvector.
* Removing unused YAML stuff: we aren't going that way for
persistency anymore.
* Renaming Axis -> Axis1D
* Removing dead-end templated Scatter stuff.
* Move (generated) config files into the Config subdir.
* Move sortedvector and indexedset into the Utils dir.
* Move the "utils" directory and namespace to "Utils"
* Put the Doxyfile under configure control by moving it to
Doxyfile.in and using the @PACKAGE_VERSION@ token.
* Make Doxygen find the .icc file and hide functions with name _*
and in the YAML namespace.
* Removing the Binning argument and enum in favour of explicit bin
edge vectors, possibly produced explicitly via the MathUtils
linspace and logspace functions, or the new Axis::mkBinEdgesLin/Log
alias functions.
* Fixed Axis, Histo1D and Profile1D constructors, by adding a path
argument, passing the path and title args to the AnalysisObject
base constructor properly.
* Removed several old and unused files such as Tree.h
2011-01-09 Andy Buckley <andy@insectnation.org>
* Updating copyright comments to be valid into 2011.
* Persistency fixes, and changing the interface to use the annotated path.
* Using annotations for path and title.
* Adding tests of collection and iterator range AO writing.
* Adding static write functions on Writer*.h implementations to
avoid needing to make an explicit Writer object via the create()
functions.
* Rename Exception.h -> Exceptions.h
* Added AnnotationError.
* Re-enable persistency of collections with begin/end iterators.
2011-01-08 Andy Buckley <andy@insectnation.org>
* Enabling quiet compilation.
* More annotation functionality.
2011-01-07 Andy Buckley <andy@insectnation.org>
* Sorting out autoheaders to be more useful.
* Rewriting AIDA writer to use DPS representation (no reloading)
for Histo1D and Profile1D objects.
* Adding persistency system hooks, since RTTI just sucks too much.
* Renaming test files to have more meaningful names.
2010-12-10 Andy Buckley <andy@insectnation.org>
* Some tweaks to Axis, Bin, etc. to use the sortedvector. Seems to
be working! (I must be checking it wrongly...)
* Adding another candidate object for the axis bin container: a
sorted extension to STL std::vector with an insert method. This
will do as a development placeholder: a proper sorted & indexed
container may be substituted later.
* Fix test code: titles are no longer given as histogram
constructor arguments.
2010-11-21 Andy Buckley <andy@insectnation.org>
* Adding indexed set for holding bins on axes. Still not sure it's
what we want, as (I just realised) STL sets are iterator-immutable
because they are self-keyed and changes to elements would also
change their sorting.
2010-09-19 Andy Buckley <andy@insectnation.org>
* Restarting ChangeLog contributions! Many changes in the huge
time since last update... activity on YODA has renewed and we have
a better picture of the distinctive features we require. New idea:
named weight vector filling, allowing "parallel" histograms for
various event weight variations. I/O remains an awkward issue,
especially since the classes are now much richer than they used to
be, and don't know about paths. Output can be easily put on top:
not an issue... and we can probably do something with
pickling. But reading in from C++?
2008-09-16 Andy Buckley <andy@insectnation.org>
* Moved duplicate Histo1D/Profile1D code on to Axis, making Axis a
templated class at the same time.
2008-09-12 Andy Buckley <andy@insectnation.org>
* Started work on a little plotting tool, initially for Herwig++
parton pT cut testing, but incrementally enhancing it to be a
command-line quick plotter seems like a good idea.
* Added some more test programs... working towards a proper test
suite.
* Added "no path & title" constructors - you don't always want to
write out the histo, since sometimes it's just a good way to
gather statistics.
* Fixed YODA mapping to allow use of vectors of bins as Python
lists.
* Added Profile1D functionality.
* Fixed Dbn1D to use sign(weight) as part of the "w**2" measure,
so that negative weights behave themselves.
2008-05-23 Andy Buckley <andy@insectnation.org>
* Added Dbn1D class to centralise the calculation of statistics
from unbounded, unbinned, weighted distributions.
2008-05-15 Andy Buckley <andy@insectnation.org>
* Added Profile1D class.
* Fixed NaN errors from zero weights.
2008-04-14 Andy Buckley <andy@insectnation.org>
* Python SWIG interface now compiles and can be used: the subtlety
that was breaking it was that SWIG has to be prodded in pretty
non-obvious ways to make std::vectors of classes without
default (no-arg) constructors. See
http://osdir.com/ml/programming.swig/2004-04/msg00011.html for
about the only reference to this to be found anywhere!
* Basic AIDA writer now available - it doesn't yet output all the
necessary information though, especially not for merging parallel
runs.
diff --git a/Doxyfile.in b/Doxyfile.in
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -1,2312 +1,2312 @@
# Doxyfile 1.8.6
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "YODA - Yet more Objects for Data Analysis"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = @PACKAGE_VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = doxy
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
# new page for each member. If set to NO, the documentation of a member will be
# part of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 8
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C.
#
# Note For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by by putting a % sign in front of the word
# or globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO these classes will be included in the various overviews. This option has
# no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
# todo list. This list is created by putting \todo commands in the
# documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
# test list. This list is created by putting \test commands in the
# documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES the list
# will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. Do not use file names with spaces, bibtex cannot handle them. See
# also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
# documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT = main.dox \
include \
src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank the
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.h \
*.cc \
*.icc
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = src/tinyxml \
src/ReaderYODA.cc \
src/ReaderFLAT.cc
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS = _* \
YAML \
YODA::Utils
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH = tests
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER ) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = YES
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
# defined cascading style sheet that is included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefor more robust against future updates.
# Doxygen will copy the style sheet file to the output directory. For an example
# see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the stylesheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler ( hhc.exe). If non-empty
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated (
# YES) or that it should be included in the master .chm file ( NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated (
# YES) or a normal table of contents ( NO) in the .chm file.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = NO
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavours of web server based searching depending on the
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
# searching and an index file used by the script. When EXTERNAL_SEARCH is
# enabled the indexing and searching needs to be provided by external tools. See
# the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
# replace them by respectively the title of the page, the current date and time,
# only the current date, the version number of doxygen, the project name (see
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = NO
# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = NO
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.
-XML_SCHEMA =
+#XML_SCHEMA =
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.
-XML_DTD =
+#XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
# Definitions (see http://autogen.sf.net) file that captures the structure of
# the code including all documentation. Note that this feature is still
# experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
# in the source code. If set to NO only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH = include \
include/YODA
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all refrences to function-like macros that are alone on a line, have an
# all uppercase name, and do not end with a semicolon. Such function macros are
# typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have an unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
# class index. If set to NO only the inherited external classes will be listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
# the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES, the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font n the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME =
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot.
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
diff --git a/configure.ac b/configure.ac
--- a/configure.ac
+++ b/configure.ac
@@ -1,204 +1,204 @@
## Process this file with autoconf to produce a configure script.
AC_PREREQ(2.59)
-AC_INIT([YODA],[1.7.1],[yoda@projects.hepforge.org],[YODA])
+AC_INIT([YODA],[1.7.2],[yoda@projects.hepforge.org],[YODA])
## Check and block installation into the src/build dir
if test "$prefix" = "$PWD"; then
AC_MSG_ERROR([Installation into the build directory is not supported: use a different --prefix argument])
fi
## Force default prefix to have a path value rather than NONE
if test "$prefix" = "NONE"; then
prefix=/usr/local
fi
AC_CONFIG_SRCDIR([src/Counter.cc])
AM_INIT_AUTOMAKE([subdir-objects -Wall dist-bzip2 1.10])
m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
m4_ifdef([AM_PROG_AR], [AM_PROG_AR])
AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_HEADERS([include/YODA/Config/DummyConfig.h include/YODA/Config/YodaConfig.h include/YODA/Config/BuildConfig.h])
AC_DEFINE_UNQUOTED(YODA_VERSION, "$PACKAGE_VERSION", "YODA version string")
AC_DEFINE_UNQUOTED(YODA_NAME, "$PACKAGE_NAME", "YODA name string")
AC_DEFINE_UNQUOTED(YODA_STRING, "$PACKAGE_STRING", "YODA name and version string")
AC_DEFINE_UNQUOTED(YODA_TARNAME, "$PACKAGE_TARNAME", "YODA short name string")
AC_DEFINE_UNQUOTED(YODA_BUGREPORT, "$PACKAGE_BUGREPORT", "YODA contact email address")
## OS X
AC_CEDAR_OSX
## Set default compiler flags
if test "x$CXXFLAGS" = "x"; then CXXFLAGS="-O3"; fi
## Compiler setup
AC_LANG(C++)
AC_PROG_CXX
AX_CXX_COMPILE_STDCXX([11], [noext], [mandatory])
AC_PROG_INSTALL
AC_PROG_LN_S
AC_DISABLE_STATIC
AC_LIBTOOL_DLOPEN
AC_PROG_LIBTOOL
## Work out library suffix for the build
LIB_SUFFIX=\\\"$shrext_cmds\\\"
AC_SUBST([LIB_SUFFIX])
## Set default build flags
AC_CEDAR_CHECKCXXFLAG([-pedantic], [AM_CXXFLAGS="$AM_CXXFLAGS -pedantic"])
AC_CEDAR_CHECKCXXFLAG([-Wall], [AM_CXXFLAGS="$AM_CXXFLAGS -Wall -Wno-format"])
dnl AC_CEDAR_CHECKCXXFLAG([-std=c++98], [AM_CXXFLAGS="$AM_CXXFLAGS -std=c++98"])
dnl AC_CEDAR_CHECKCXXFLAG([-Wno-unused-variable], [AM_CXXFLAGS="$AM_CXXFLAGS -Wno-unused-variable"])
## Debug flag (default=none)
AC_ARG_ENABLE([debug], [AC_HELP_STRING(--enable-debug, [build with debugging symbols @<:@default=no@:>@])], [], [enable_debug=no])
if test x$enable_debug = xyes; then
[AM_CXXFLAGS="$AM_CXXFLAGS -g"]
fi
## Optional zlib support for gzip-compressed data streams/files
AX_CHECK_ZLIB
## Optional ROOT compatibility
AC_ARG_ENABLE([root], [AC_HELP_STRING(--disable-root,
[don't try to build YODA interface to PyROOT (needs root-config) @<:@default=yes@:>@])], [], [enable_root=yes])
if test "x$enable_root" = "xyes"; then
AC_PATH_PROG(ROOTCONFIG, [root-config])
if test "x$ROOTCONFIG" = "x"; then
AC_MSG_WARN([root-config not found -- not building extra ROOT compatibility tools])
enable_root=no;
else
AC_MSG_CHECKING([ROOT version])
ROOT_VERSION=`$ROOTCONFIG --version`
ROOT_MAJOR_VERSION=`echo $ROOT_VERSION | cut -d. -f1`
ROOT_MINOR_VERSION=`echo $ROOT_VERSION | cut -d. -f2 | cut -d/ -f1`
ROOT_MICRO_VERSION=`echo $ROOT_VERSION | cut -d. -f2 | cut -d/ -f2`
AC_MSG_RESULT([$ROOT_VERSION ($ROOT_MAJOR_VERSION,$ROOT_MINOR_VERSION,$ROOT_MICRO_VERSION)])
if test "$ROOT_MAJOR_VERSION" -lt 5; then
enable_root=no;
AC_MSG_WARN([ROOT major version is < 5 -- not building extra ROOT compatibility tools])
elif test "$ROOT_MAJOR_VERSION" -eq 5; then
if test "$ROOT_MINOR_VERSION" -lt 33; then
enable_root=no;
AC_MSG_WARN([ROOT version is less than 5.33 -- not building extra ROOT compatibility tools])
elif test "$ROOT_MINOR_VERSION" -eq 33 && test "$ROOT_MICRO_VERSION" -lt 2; then
enable_root=no;
AC_MSG_WARN([ROOT version is less than 5.33/02 -- not building extra ROOT compatibility tools])
fi
fi
# TODO: Test for existence of TPython, instance_from_void API, etc.
#AM_CXXFLAGS="$AM_CXXFLAGS -Wno-long-long"
ROOT_CXXFLAGS=`$ROOTCONFIG --cflags`
ROOT_LDFLAGS=`$ROOTCONFIG --ldflags`
ROOT_LIBS=`$ROOTCONFIG --libs`
AC_SUBST(ROOT_CXXFLAGS)
AC_SUBST(ROOT_LDFLAGS)
AC_SUBST(ROOT_LIBS)
fi
fi
AM_CONDITIONAL(ENABLE_ROOT, [test x$enable_root = xyes])
if test x$enable_root = xyes; then
AC_MSG_NOTICE([Building extra ROOT compatibility tools])
else
AC_MSG_NOTICE([Not building extra ROOT compatibility tools])
fi
## Python extension
AC_ARG_ENABLE(pyext, [AC_HELP_STRING(--disable-pyext,
[don't build Python module (default=build)])],
[], [enable_pyext=yes])
## Basic Python checks
if test x$enable_pyext = xyes; then
AX_PYTHON_DEVEL([>= '2.7.3'])
AC_SUBST(PYTHON_VERSION)
YODA_PYTHONPATH=`$PYTHON -c "from __future__ import print_function; import distutils.sysconfig; print(distutils.sysconfig.get_python_lib(prefix='$prefix', plat_specific=True));"`
AC_SUBST(YODA_PYTHONPATH)
if test -z "$PYTHON"; then
AC_MSG_ERROR([Can't build Python extension since python can't be found])
enable_pyext=no
fi
if test -z "$PYTHON_CPPFLAGS"; then
AC_MSG_ERROR([Can't build Python extension since Python.h header file cannot be found])
enable_pyext=no
fi
fi
AM_CONDITIONAL(ENABLE_PYEXT, [test x$enable_pyext == xyes])
## Cython checks
if test x$enable_pyext == xyes; then
AM_CHECK_CYTHON([0.23.5], [:], [:])
if test x$CYTHON_FOUND = xyes; then
AC_MSG_NOTICE([Cython >= 0.23.5 found: Python extension source can be rebuilt (for developers)])
fi
AC_CHECK_FILE([pyext/yoda/core.cpp],
[],
[if test "x$CYTHON_FOUND" != "xyes"; then
AC_MSG_ERROR([Cython is required for --enable-pyext, no pre-built core.cpp was found.])
fi])
## Set extra Python extension build flags (to cope with Cython output code oddities)
PYEXT_CXXFLAGS=$CXXFLAGS
AC_CEDAR_CHECKCXXFLAG([-Wno-unused-but-set-variable], [PYEXT_CXXFLAGS="$PYEXT_CXXFLAGS -Wno-unused-but-set-variable"])
AC_CEDAR_CHECKCXXFLAG([-Wno-sign-compare], [PYEXT_CXXFLAGS="$PYEXT_CXXFLAGS -Wno-sign-compare"])
AC_CEDAR_CHECKCXXFLAG([-Wno-strict-prototypes], [PYEXT_CXXFLAGS="$PYEXT_CXXFLAGS -Wno-strict-prototypes"])
AC_SUBST(PYEXT_CXXFLAGS)
AC_MSG_NOTICE([All Python build checks successful: 'yoda' Python extension will be built])
fi
AM_CONDITIONAL(WITH_CYTHON, [test x$CYTHON_FOUND = xyes])
## Extend and substitute the default build flags after lib testing
AM_CPPFLAGS="-I\$(top_srcdir)/include -I\$(top_builddir)/include"
AC_SUBST(AM_CPPFLAGS)
AC_SUBST(AM_CXXFLAGS)
dnl
dnl setup.py puts its build artifacts into a labelled path
dnl this helps the test scripts to find them locally instead of
dnl having to install first
dnl
YODA_SETUP_PY_PATH=$(${PYTHON} -c 'from __future__ import print_function; import distutils.util as u, sys; vi=sys.version_info; print("lib.%s-%s.%s" % (u.get_platform(),vi.major, vi.minor))')
AC_SUBST(YODA_SETUP_PY_PATH)
## Build Doxygen if possible
AC_PATH_PROG(DOXYGEN, doxygen)
AM_CONDITIONAL(WITH_DOXYGEN, test "$DOXYGEN")
## Build file output
AC_EMPTY_SUBST
AC_CONFIG_FILES([Makefile Doxyfile])
AC_CONFIG_FILES([include/Makefile include/YODA/Makefile])
AC_CONFIG_FILES([src/Makefile
src/tinyxml/Makefile
src/yamlcpp/Makefile
])
AC_CONFIG_FILES([tests/Makefile])
AC_CONFIG_FILES([pyext/Makefile
pyext/setup.py
pyext/yoda/Makefile
])
AC_CONFIG_FILES([bin/Makefile bin/yoda-config])
AC_CONFIG_FILES([yodaenv.sh yoda.pc])
AC_OUTPUT
if test x$enable_pyext == xyes; then
cat <<EOF
************************************************************
YODA CONFIGURED!
Now build and install (to the $prefix tree) with e.g.
make -j2 && make -j2 install
************************************************************
EOF
fi

File Metadata

Mime Type
text/x-diff
Expires
Wed, May 14, 11:21 AM (14 h, 32 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
5111404
Default Alt Text
(168 KB)

Event Timeline