[root] Log of /trunk/roofit/roofitcore/src/RooCachedPdf.cxx

Revision 24119 - (view) (download) (as text) (annotate) - [select for diffs]
Modified Tue Jun 3 18:42:54 2008 UTC (6 years, 7 months ago) by wouter
File length: 2881 byte(s)
Diff to previous 23134

   o RooAbsSelfCachedPdf

     - Follow changes in RooAbsCachedPdf 


   o RooCachedPdf

     - Add option to override default choice of cache observables
       (the normalization observables) with a specific set of variables
       to make it possible to also cache p.d.f values for all values
       of given parameters as well.

     - Forward analytical integration capabilities to actual cache p.d.f

     - Forward calls on preferred observable order to cached p.d.f


   o RooDataHist
       
     - Add option to bin dataset in alternate binning configuration, as 
       specified by binning name in constructor.

     - Add feature to weight() function to enforce special boundaries
       when interpolating a histogram representing a cumulative distribution function. 
       If so, lower-side bounds are forced to zero and upper-side bounds are
       forced to 1.0 instead of the default mirroring strategy


   o RooMsgService

     - Add new topic NumericIntegration

     - Show PROGRESS level messages by default


   o RooAbsSelfCachedReal

     - New base class for self-caching RooAbsReal objects analoguous
       to RooAbsSelfCachedPdf


   o RooCachedReal

     - New class to cache arbitrary RooAbsReal function objects,
       analogous to RooAbsCachedPdf


   o RooRealBinding

     - Add feature to save and restore values of input variables,
       used by RooRealIntegral to restore observable values after numeric
       integration to original values.


   o RooLinearMorph

     - New operator p.d.f class implementing using the algorithm described
       by Alex Read in NUM A 425 (1999) 357-369 'Linear interpolation of histograms'.
       This class implements a generalization for continuous p.d.f 


   o RooAbsRealLValue

     - Following changes in RooAbsLValue

 
   o RooHistFunc

     - Real-valued function modeled by external RooDataHist object, analoguous to RooHistPdf,
       but without normalization support and allowing negative histogram values


   o RooAbsCachedReal

     - New abstract base class for caching functions, analoguous to RooAbsCachedPdf.
       

   o RooFracRemainder

     - New dedicated helper class to calculate the remainder fraction of a RooAddPdf, i.e. 1-sum(i)x_i
       for a given RooArgSet x


   o RooCustomizer

     - Fix memory management issue for sterile use


   o RooAbsCategoryLValue

     - Follow changes in RooAbsLValue


   o RooNumCdf

     - Specialization of RooNumRunningInt to calculate running integrals of p.d.f.s:
       the running integral is by construction normalized to one exactly, taking out
       any possible imprecisions in the regular integral calculation and by imposing
       special constraints on the RooHistFunc that models the output so that the boundaries
       are constrained to exactly 0 and 1 when interpolation is used.


   o RooFFTConv

     - Fix bug in cache naming algorithm

     - Follow changes in RooAbsCachedPdf


   o RooChangeTracker

     - New special purpose object that tracks changes in a given set of variables, used
       to determine if cached p.d.fs in RooAbsCachedPdf and RooAbsCachedReal need to
       be recalculated due to parameter changes. In addition to valueDirty tracking,
       an explicit comparison can be made to stored reference values of variables,
       to avoid recalculation of expensive quantities in case a valueDirty is propagated
       even if the value did not change (this can e.g. happen when you step though
       a RooDataHist where usually only one of the observables changes value, but
       all observables propagate a valueDirty every time)


   o RooHist

     - Bug fix in makeResidual()


   o RooAbsReal

     - Fix small memory leak in createIntegral

     - Expand functionality of fillDataHist: optional correction for binVolume
       when filling, and optional progress indication.

     - Modify logEvalError() so that when cumulative logging for Minuit is disabled
       that messages are printed through the standard message logging service.

     - Modify error logging so that name of objects are stored in addition to 
       pointers so that delayed logging of errors of (cache) objects that no
       longer exists can be performed correctly.

     - Add virtual function preferredObservableScanOrder() to indicate preferred
       order in which multi-dimensional functions should be scanned into a 
       RooHistPdf, which may matter greatly for the performance of certain
       p.d.f.s like RooFFTConvPdf and RooLinearMorph

     - Add new function createRunningIntegral() which constructs for a given F(x,y) 
       a Int[xlo,x] F(x',y) dx. The default strategy is to construct the underlying
       integral with createIntegral() and adapt it with a RooCustomizer and a RooParamBinning
       to a running integral. In case it concerns a one-dimensional numeric running
       integral, the running integral is represented by a dedicated class RooNumRunningInt
       which scans the integrand and numerically integrates the scanned histogram


   o RooAbsCollection

     - Bug fix in nameFieldLength handling of print routine


   o RooAbsCachedPdf

     - Introduce explicitly the strategy that the cache contains the _normalized_ p.d.f. values,
       so that no postior normalization integral is required. This has the added advantages that
       the cache p.d.f can be instructed to consider itself normalized skipping an explicit
       normalization step in the RooHistPdf.

     - Add utility function getCachePdf() and getCacheHist() to retrieve cache p.d.f and histogram
       for a given choice of normalization set

     - Clean up structure of CacheElem nested class by making guts private and providing accessor
       function for derived CacheElem classes. Virtualize cache creation with a new member function 
       createCache that will allow derived classes to create a derived CacheElem.

     - Forward integration handling to cache pdf actually being used


   o RooDataHistSliceIter

     - Follow changes in RooDataHist for alternate binning 


   o RooRealMPFE

     - Follow changes in eval error logging in RooAbsReal


   o RooAbsPdf

     - Add createCdf() function to create cumulative distribution functions from p.d.f.s. This is 
       quite similar to RooAbsReal::createRunningIntegral() but with some c.d.f specific features
       related to constraints on normalization


   o RooAbsArg 

     - Fix bug in optimizeCacheMode()


   o RooBrentRootFinder

     - Improve error messaging through RooMsgService interface.


   o RooCmdArg

     - Expand payload from 2 to 3 strings


   o RooSimWSTool

     - Complete rewrite of RooSimPdfBuilder integrated with RooWorkspace for object storage.


   o RooNumRunningInt

     - New dedicated class to calculate running integral of any function that does not have
       an analytical integral implementation. This class scans such a function in a histogram
       and then numerically integrates the histogram. The filling of the histogram is performed
       adaptively using a recursion division strategy with a precision cutoff to save time
       of the filling of smooth functions in finely binned histograms


   o RooMultiCategory, RooSuperCategory

     - Minor tweak in name of proxies


   o RooAbsIntegrator

     - Deploy save and restore functionality of RooAbsFunc/RooRealBinding to restore observable
       values to prior values after an intergration step. 


   o RooMinuit

     - Fix gcc 4.3 compiler warning


   o RooWorkspace

     - Add bulk import() function taking a const RooArgSet instead of a RooAbsArg
 
     - Add RecycleConflictNodes() option to ignore conflicts and simply recycle internal
       nodes when a different external node is encountered.

     - Add new accessors catfunc() for category functions, arg() for generic RooAbsArgs,
       and funcArg() for fundamental arguments of any type.

     - Add separate section for category functions in Print()


   o RooHistPdf

     - Add option to declare contents unit normalized. When activated, the analytical
       integral is hardwired to 1. 

     - Add option to propagate cdfBoundaries mode to the underlying RooDataHist.


   o RooAbsOptTestStatistic

     - Optimize handling of empty rangeName specification (from Alfio)


   o RooSimultaneous

     - Tune proxy names

     - Make p.d.f return zero, in case index category is in state where no p.d.f is assigned,
       rather that assert(0)


   o LinkDef3.h, Module.mk

     - Add new class definitions

Revision 20161 - (view) (download) (as text) (annotate) - [select for diffs]
Added Mon Oct 1 16:28:25 2007 UTC (7 years, 3 months ago) by wouter
Original Path: trunk/roofitcore/src/RooCachedPdf.cxx
File length: 2097 byte(s)

   o RooAbsCache

    - New abstract base class for cache objects associated with RooAbsArgs.
      Caches register themselves with the owning RooAbsArg and propagate
      all necessary state changes and meta information to objects in the cache


   o RooCacheManager

    - Concrete template implementation of RooAbsCache with an interface
      and functionality styled after RooNormListManager. The template class
      provide no special handling for cache contents that includes RooAbsArg
      objects and does not forward hook calls. It is thus mostly intended
      to cache basic types indexed on a normalization/integration configuration


   o RooObjCacheManager

    - Class derived from RooCacheManager<RooAbsCacheElement> that implements
      all proper call forwarding and handling of state and other meta information
      to RooAbsArg objects embedded in the cache elements. To facilitate this
      functionality the RooAbsCacheElement defines a pure virtual method
      containedArgs() that must be implemented to expose its contents to
      the cache manager. The default behavior on a serverRedirect hook is
      to sterilize the cache. OperMode changes are not forwarded by default
      to the cache contents as cached objects do not necessarily have the
      same operation mode (e.g. if the cache contains an integral of its owner).
      Any calls to optimizeCacheMode(), printCompactTreeHook(), and findConstantNodes()
      are forwarded. Moreover, optimizeCacheMode() calls are remembered and
      any objects inserted in the cache after such a call was received will be
      optimized upon insertion in the cache

   o RooAbsCacheElement

    - Abstract base class for objects to be managed by RooObjCacheManager. Each
      object must in addition to its payload implement the containedArgs()
      member function that exposes the RooAbsArg object content to the manager
      for processing. The argument passed to containedArgs() indicates the use
      case for the returned list of objects, allowing the cache payload to
      return different lists depending upon use. This is for most applications
      not required.


   o RooAbsCachedPdf

    - Abstract base class derived from RooAbsPdf for p.d.f.s that implement 
      value caching in a grid over the entire domain of the observables. 
      The base class implements the overall caching logistics and manages
      the RooDataHists and RooHistPdfs that respresent the cached contents.
      Derived classes must inputBaseName() defined a unique name prefix for
      all cache objects, actualObservales() and actualParameters() to
      determined the actual observables and parameters given a set of 
      available observables and fillCacheObject() which should fill the
      RooDataHist cache for a given obs/params configuration with the
      p.d.fs values.


   o RooAbsSelfCachedPdf

    - Abstract base class derived from RooAbsCachedPdf that implements
      all of the required logistics in RooCachedPdf and only require
      derived classes from RooAbsSelfCachedPdf to implement evaluate().
      Any class derived from RooAbsPdf can thus be trivially switched
      to derived from RooAbsSelfCachedPdf and gain the caching functionality.
      

   o RooCachedPdf

    - Concrete class derived from RooAbsCachedPdf that implements
      the caching of an externally provided p.d.f in the constructor.


   o RooFFTConvPdf

    - Concrete class derived from RooAbsCachedPdf that implement generic
      numeric convolution of two input p.d.f.s using FFT technique
      and convolution theorem. Actual FFTs are calculated by FFTW
      through TVirtualFFT interface in ROOT. Present implementation only supports 
      convolution in one dimension, but this will be extended later
      as there are no fundamental limitations in RooAbsCachedPdf nor FFTW.
 

   o RooHistPdf

    - Moved from RooFit to RooFitCore because it is used by caching classes


   o RooProdPdf

     - Use new RooObjCacheManager to store partial objects

     - Fix memory leak (already patched in 15.0.14h)


   o RooDataHist

     - Use new RooCacheManager template to cache partial bin volumes

     - Add new set(),setAllWeights() method to update current weight and all weights
       respectively, for use in cached p.d.f.s

     - Add sliceIterator() that iterates over all bins in a lower dimensional 
       slice of the dataset


   o RooDataHistSliceIter

    - Class derived from TIterator that implements the iteration
      over a slice in a reduced number of dimensions in a RooDataHist


   o RooMsgService

     - Speed up processing of debug streams in cases where no debug streams are active

     - add macros series oocoutX and oocxcoutX that allow to associate message with
       a different object than *this

   o RooRealBinding

     - Interface new setValue method that allows value to be set outside default
       domain, but inside given alternate named range. For use in numeric integrator
       bindings


   o RooAbsRealLValue

     - Add new inRange() method with range name specifier to check against chosen
       range instead of default range


   o RooCmdConfig

     - Fix dangling return pointer problem in decodeStringOnTheFly() method


   o RooNameSet

     - Fix bug in refoll()


   o RooChi2Var, RooNLLVar

     - Add processing of AddCoefRange() named argument


   o RooConvCoefVar

     - Hold p.d.f in proxy without value/shape state propagation to obtain
       correct dependency of RooConvCoefVar through separate set proxy
       with parameters that do have state propagation

     - In getAnalyticalIntegral() ask for integration coefficient specific
       to coefficient (following interface change in RooAbsAnaConv)


   o RooEfficiency

     - Follow interface change in RooCategoryProxy


   o RooAbsAnaConvPdf

    - Use new RooObjCacheManager to hold normalization and coefficient representations

    - Extend getCoefAnalyticalIntegral() interface so that each coefficient
      can have a separate integration configuration

    - Modify makeCoefVars() such that it constructs the RooConvCoefVars with
      actual dependents for each coefficients, rather than inserting dependencies
      of any of the coefficients in each coefficient. This logic requires support
      from the implementation class that is interface through a new member function
      coefVars()


   o RooAbsReal 

    - Add Boolean data member treeVar that indicates is value buffer is also
      branch buffer of a tree. This information is already present in the RooAbsReal
      but is relatively expensive to retrieve and is always needed in the inner
      loop of data set operations. This extra member significantly speeds up operations

    - Remove superfluous _norm[] token in name returned by integralNameSuffix() if 
      no normalization set is supplied.

    - Add a fillDataHist() method that fills a given RooDataHist with a sampling
      of the given function. Added for support of caching p.d.f.s


    - Downgrading warning on non-dependent projection variables in plotOn() to
      a debug level message

    - Remove function optimizeDirty(),doConstOpt(),undoConstOpt(),findCacheableBranches()
      findUnusedDatasetVariables() and findRedundantCacheServers() as part of reorganization
      of optimization functionality.


   o RooAbsCollection

    - Use iterator semantics instead of vector semantics to process RooLinkedList
      contents in assignment operator

    - Add utility function contentsString() returning stl string with names
      of contents


   o RooAddPdf

    - Rewrite cache management using new RooObjCacheManager that holds projection
      integrals, range integrals and supplemental normalization lists


   o RooAbsOptGoodnessOfFit

    - Improve handling of normalization ranges and reference ranges for test statistics
      containing RooAddPdfs. New named argument in fitTo() and RooNllVar::ctor() pass
      reference range for fractions in RooAddPdf components that do not have an explicit
      fixed definition already. Name all normalization ranges explicitly after the
      subrange to which the're applied to avoid name clashes and conflicts if multiple
      normalization ranges are involved.

    - Rewrite informational messages through RooMsgService

    - Implement new constOptimizeTestStatistic() function that signals all test statistic
      components of a RooAbsArg expression tree to perform their constant term optimization

    - Implement new optimizeCaching() driver function that changes default lazy-evaluation-with-caching
      scheme to test statistic scheme where only parameters objects propagate state changes and
      where all components that depend directly or indirectly on observables have lazy evaluation
      disabled. Changes to p.d.f objects are delegated to RooAbsPdf::optimizeCacheMode(). Changes
      to dataset are delegated to RooAbsData::optimizeReadingWithCaching()

    - Implement new optimizeConstantTerms() function that is back end for constOptimizeTestStatistic
      implementation. 


  o RooAICRegistry, RooNormSetCache

    - Remove tracking of allocation cycles of RooArgSets as this scheme is superseded by
      memory pool mechanism for RooArgSet allocation


  o RooMappedCategory

    - Follow interface change in RooCategoryProxy.


  o RooRealMPFE

    - Follow reorganization of optimization functionality: implement new constOptimizeTestStatistic
      function for forwarding to slave processes.


  o RooRealVar

    - Add new setVal() function with range name to facilite setting of values that are outside
      default range, but inside specified alternate range. Needed for numeric integration and
      certain RooAddPdf coefficient projection.


  o RooAbsArg

    - Make state management functions public [is/set][Value/ShapeDirty](), setOperMode90
  
    - Add static _flipAClean boolean to support setACleanAdirty() static method.

    - Implement mechanism for registration of cache objects with base class RooAbsCache.
      Forward all calls to operModeHook(), redirectServersHook(), optimizeCacheMode()
      and printCompactTreeHook() to all caches for further processing
   
    - Define constOptimize() function and provide default implementation that forwards
      to all servers 

    - Implement optimizeCacheMode() function that puts expression tree in optimized
      caching for test-statistics operations (only cache/lazy evaluate nodes that
      do not (indirectly) depend on observables

    - Implement findConstantNodes() function that identifies all nodes that depend
      exclusively on constant observables and >0 observables that are eligible
      for precalculation and caching in test statistics operations by 
      RooAbsOptTestStatistic::optimizeConstantTerms()

    - Define constOptimizeTestStatistics that signal an expression tree that any
      embedded test statistic objects should perform their constant term optimization.
      Default implementation in RooAbsArg forwards call to all servers.


  o RooAbsPdf

    - Use new RooObjCacheManager to manage normalization integrals cache.

    - Process new SumCoefRange() option in fitTo() that sets the coeffient
      interpretation range for all embedded RooAddPdf objects of which
      the interpretation range was not explicitly set

    - Extend interface of fixAddCoefNormalizationSet(): add extra argument
      that controls if AddCoef normalization set are forcibly overruled
      for objects that already have an explicit range setting.

  
   o RooRealIntegral 

    - Add some informational messaging through RooMsgService, rewrite existing ones

    - Speed up numeric summations by precreating the involved RooSuperCategory
      in the ctor rather than in evaluate().

    - Fix bug in dependency insertion: explicitly require servers to be value
      server to avoid pulling in fake dependents.
    
    - Remove obsolete data members

    - Implement new setACleanADirty() function that atomically flips state of
      all AClean objects to ADirty for the duration of the integration step.
      Replaces the much more expensive prepareACleanFunc() that did this
      only for the objects involved.

    - Process factorizing terms in integral only if the list is not empty

    - Process Jacobian terms in integral only if the list is not empty


  o RooAddGenContext

   - Adapt to cache management chanches in RooAddPdf


  o RooNumIntFactory

   - Use STL classes for internal memory management


  o RooSetProxyy

   - Implement operator new() and operator() delete as required because
     RooArgSet implements them 


  o RooAbsGoodnessOfFit

   - Store and forward AddCoefRange information for embedded RooAddPdf objects

   - Implement constOptimizeTestStatistic() and forward to components


  o RooErrorVar

   - Follow inRange() interface change in RooAbsRealLValue


  o RooConvGenContext

    - Adapt code to make it work with both RooAbsAnaConv objects and
      the newly introduced RooFFTConvPdf


  o RooMinuit

    - Follow reorganization of optimization functionality


  o RooProjectedPdf

    - Store projection using new RooObjCacheManager


  o RooGlobalFunc

    - Add RooFit::SumCoefRange() named argument for RooAbsPdf::fitTo() 
      and RooNLLVar::ctor() and RooChi2Var::ctor()


  o RooClassFactory

    - Extend existing makePdf(),makeFunction and makeClass() functions
      to also accept RooAbsCategory arguments, to accept an optional string
      inserted as the return value expression inserted in the 
      evaluate() method of the class created, as well as as option string
      specifying one or more analytical integrations of the given function
      expression that will be advertised in the generated getAnalyticalIntegral()
      code and implemented in the generated analyticalIntegral() code

    - Add makeAndCompileFunction() and makeAndCompilePdf methods that
      generate the code and immediate compile it through ROOTs ACliC interface.
      These functions have a simpler interface because the list of arguments
      of the function to be created can be specified as a const RooArgSet&
      rather than a string with a list of names, thus making it easier
      for on-the-fly definition of compiled objects.

    - Add defineFunction() and definePdf() methods define and compile
      a function/pdf using the above functions and immediately instantiate
      an object of the given type passing the specified RooArgSet arguments
      to the constructor of the object. These functions make a compiled
      equivalent of RooFormulaVar based on the TFormula interpreter, i.e.

           RooAbsReal* f = new RooFormulaVar("f","D(1-2w)",RooArgSet(D,w)) ;

      becomes
       
           RooAbsReal* f = RooClassFactory::defineFunction("f","D(1-2w)",RooArgSet(D,w)) ;

   
  o RooAbsCategory

   - Add Boolean data member treeVar that indicates is value buffer is also
     branch buffer of a tree. This information is already present in the RooAbsReal
     but is relatively expensive to retrieve and is always needed in the inner
     loop of data set operations. This extra member significantly speeds up operations

   - Construct explit clean name for TBranch name if node is cached, equivalent
     to what is done in RooAbsReal. Needed because new constOptimizer can also
     cache RooAbsCategory objects


  o RooArgSet

   - Implement operator new() and operator delete() to implement memory pool scheme
     for RooArgSets. The goal of this implementation is to insure that two RooArgSet
     pointers are _never_ the same. This allows to RooNormSet cache manager to safely
     and quickly index integration and normalization configurations by evaluating
     the contents of a RooArgSet only the first time it sees it.


  o RooSimultaneous

   - Implement caching of partial integrals using new RooObjCacheManager

   - Following interface change in RooCategoryProxy ;


  o RooAbsData

   - Defined pure virtual methods optimizeReadingWithCache() and allClientsCached()


  o RooTreeData

   - Implement optimizeReadingWithCache() which determines given a p.d.f to be
     evaluated and a list of the nodes that are cached for it, which observables
     in the dataset are no longer required because they are either not an observable
     of the p.d.f, or they exclusively feed nodes that are cached. Reading of these
     observables is disabled through SetBranchStatus().
  
   - Move allClientsCached() utility function here from RooAbsReal.


  o RooCategoryProxy

   - Remove const char*() conversion operator in favor of a const char* label() method
     to remove possibly ambiguities in C++ math expressions involving category proxies.


  o LinkDef3.h

   - Add newly defined classes

This form allows you to request diffs between any two revisions of this file. For each of the two "sides" of the diff, enter a numeric revision.

Links to HEAD:	(view) (download) (as text) (annotate)
Sticky Revision: