RooLinkedList.h

Go to the documentation of this file.

/*****************************************************************************
 * Project: RooFit                                                           *
 * Package: RooFitCore                                                       *
 *    File: $Id: RooLinkedList.h,v 1.15 2007/05/11 09:11:30 verkerke Exp $
 * Authors:                                                                  *
 *   WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu       *
 *   DK, David Kirkby,    UC Irvine,         dkirkby@uci.edu                 *
 *                                                                           *
 * Copyright (c) 2000-2005, Regents of the University of California          *
 *                          and Stanford University. All rights reserved.    *
 *                                                                           *
 * Redistribution and use in source and binary forms,                        *
 * with or without modification, are permitted according to the terms        *
 * listed in LICENSE (http://roofit.sourceforge.net/license.txt)             *
 *****************************************************************************/
#ifndef ROO_LINKED_LIST
#define ROO_LINKED_LIST
 
#include "TObject.h"
#include "RooLinkedListElem.h"
#include "TString.h"
 
#include <vector>
#include <memory>
#include <unordered_map>
 
class RooLinkedListIter ;
class RooLinkedListIterImpl ;
class RooFIter;
class TIterator ;
class RooAbsArg ;
 
/// \cond ROOFIT_INTERNAL
 
template<class T>
class RooSTLRefCountList;
 
namespace RooLinkedListImplDetails {
    class Chunk;
    class Pool;
}
 
/// \endcond
 
class RooLinkedList : public TObject {
public:
  // Constructor
  RooLinkedList(Int_t htsize=0) ;
 
  // Copy constructor
  RooLinkedList(const RooLinkedList& other) ;
 
  TObject* Clone(const char* =nullptr) const override {
    return new RooLinkedList(*this) ;
  }
 
  // Assignment operator
  RooLinkedList& operator=(const RooLinkedList& other) ;
 
  Int_t getHashTableSize() const {
    // Return size of hash table
    return _htableName ? _htableName->size() : 0 ;
  }
 
  void setHashTableSize(Int_t size) ;
 
  // Destructor
  ~RooLinkedList() override ;
 
  Int_t GetSize() const { return _size ; }
  std::size_t size() const { return _size ; }
  bool empty() const { return _size == 0 ; }
 
  virtual void Add(TObject* arg) { Add(arg,1) ; }
  virtual bool Remove(TObject* arg) ;
  TObject* At(int index) const ;
  bool Replace(const TObject* oldArg, const TObject* newArg) ;
  TIterator* MakeIterator(bool forward = true) const ;
  RooLinkedListIter iterator(bool forward = true) const ;
  RooFIter fwdIterator() const ;
  RooLinkedListIterImpl begin() const;
  RooLinkedListIterImpl end() const;
  RooLinkedListIterImpl rbegin() const;
  RooLinkedListIterImpl rend() const;
 
  void Clear(Option_t *o=nullptr) override ;
  void Delete(Option_t *o=nullptr) override ;
  TObject* find(const char* name) const ;
  RooAbsArg* findArg(const RooAbsArg*) const ;
  TObject* FindObject(const char* name) const override ;
  TObject* FindObject(const TObject* obj) const override ;
  Int_t IndexOf(const char* name) const ;
  Int_t IndexOf(const TObject* arg) const ;
  TObject* First() const {
    return _first ? _first->_arg : nullptr ;
  }
 
  // For checking if the list contains an element with a given name from Python.
  bool contains(const char* name) const { return find(name); }
 
  void RecursiveRemove(TObject *obj) override;
 
  void Print(const char* opt) const override ;
  void Sort(bool ascend=true) ;
 
  // const char* GetName() const { return "" ; /*_name.Data() ; */ }
  // void SetName(const char* /*name*/) { /*_name = name ; */ }
  const char* GetName() const override { return _name.Data() ;  }
  void SetName(const char* name) { _name = name ;  }
 
   void useNptr(bool flag) { _useNptr = flag ; }
   // needed for using it in THashList/THashTable
 
   ULong_t  Hash() const override { return _name.Hash(); }
 
protected:
 
  RooLinkedListElem* createElement(TObject* obj, RooLinkedListElem* elem=nullptr) ;
  void deleteElement(RooLinkedListElem*) ;
 
  /// \cond ROOFIT_INTERNAL
  template<class T> friend class RooSTLRefCountList;
  /// \endcond
  friend class RooLinkedListIterImpl ;
  friend class RooFIterForLinkedList ;
 
  virtual void Add(TObject* arg, Int_t refCount) ;
 
  RooLinkedListElem* findLink(const TObject* arg) const ;
 
  Int_t _hashThresh ;          ///<  Size threshold for hashing
  Int_t _size ;                ///<  Current size of list
  RooLinkedListElem*  _first ; ///<! Link to first element of list
  RooLinkedListElem*  _last ;  ///<! Link to last element of list
 
  using HashTableByName = std::unordered_map<std::string,TObject const*>;
  using HashTableByLink = std::unordered_map<TObject const*,TObject const*>;
  std::unique_ptr<HashTableByName> _htableName; ///<! Hash table by name
  std::unique_ptr<HashTableByLink> _htableLink; ///<! Hash table by link pointer
 
  TString             _name ;
  bool              _useNptr ; ///<!
 
private:
  template <bool ascending>
  static RooLinkedListElem* mergesort_impl(RooLinkedListElem* l1,
     const unsigned sz, RooLinkedListElem** tail = nullptr);
  /// memory pool for quick allocation of RooLinkedListElems
  typedef RooLinkedListImplDetails::Pool Pool;
  /// shared memory pool for allocation of RooLinkedListElems
  static Pool* _pool; //!
 
  std::vector<RooLinkedListElem *> _at; ///<! index list for quick index through ::At
 
  ClassDefOverride(RooLinkedList,3) // Doubly linked list for storage of RooAbsArg objects
};
 
#endif