Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsCollection.cxx
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * @(#)root/roofitcore:$Id$
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16
17/**
18\file RooAbsCollection.cxx
19\class RooAbsCollection
20\ingroup Roofitcore
21
22Abstract container object that can hold
23multiple RooAbsArg objects. Collections are ordered and can
24contain multiple objects of the same name, (but a derived
25implementation can enforce unique names). The storage of objects is
26implemented using the container denoted by RooAbsCollection::Storage_t.
27**/
28
29#include "RooAbsCollection.h"
30
31#include "TClass.h"
32#include "TRegexp.h"
33#include "RooStreamParser.h"
34#include "RooAbsRealLValue.h"
36#include "RooStringVar.h"
37#include "RooTrace.h"
38#include "RooArgList.h"
39#include "RooLinkedListIter.h"
40#include "RooCmdConfig.h"
41#include "RooRealVar.h"
42#include "RooGlobalFunc.h"
43#include "RooMsgService.h"
44#include "RooFitImplHelpers.h"
45
46#include <strlcpy.h>
47#include <algorithm>
48#include <iomanip>
49#include <iostream>
50#include <fstream>
51#include <memory>
52
54
55namespace RooFit {
56namespace Detail {
57
58/**
59 * Helper for hash-map-assisted finding of elements by name.
60 * Create this helper if finding of elements by name is needed.
61 * Upon creation, this object checks the global
62 * RooNameReg::renameCounter()
63 * and tracks elements of this collection by name. If an element
64 * gets renamed, this counter will be increased, and the name to
65 * object map becomes invalid. In this case, it has to be recreated.
66 */
68
69 /// Initialise empty hash map for fast finding by name.
70 template<typename It_t>
71 HashAssistedFind(It_t first, It_t last) :
72 currentRooNameRegCounter{ RooNameReg::instance().renameCounter() },
74 {
75 nameToItemMap.reserve(std::distance(first, last));
76 for (auto it = first; it != last; ++it) {
77 nameToItemMap.emplace((*it)->namePtr(), *it);
78 }
79 }
80
81 bool isValid() const {
83 }
84
85 RooAbsArg * find(const TNamed * nptr) const {
86 assert(isValid());
87
88 auto item = nameToItemMap.find(nptr);
89 return item != nameToItemMap.end() ? const_cast<RooAbsArg *>(item->second) : nullptr;
90 }
91
92 void replace(const RooAbsArg * out, const RooAbsArg * in) {
93 nameToItemMap.erase(out->namePtr());
94 nameToItemMap.emplace(in->namePtr(), in);
95 }
96
97 void insert(const RooAbsArg * elm) {
98 nameToItemMap.emplace(elm->namePtr(), elm);
99 }
100
101 void erase(const RooAbsArg * elm) {
102 nameToItemMap.erase(elm->namePtr());
103 }
104
105 std::unordered_map<const TNamed *, const RooAbsArg * const> nameToItemMap;
106 const std::size_t & currentRooNameRegCounter;
108};
109
110}
111}
112
113
114////////////////////////////////////////////////////////////////////////////////
115/// Default constructor
116
118{
119 _list.reserve(8);
120}
121
122
123
124////////////////////////////////////////////////////////////////////////////////
125/// Empty collection constructor
128 _name(name)
129{
130 _list.reserve(8);
132
133
134
135////////////////////////////////////////////////////////////////////////////////
136/// Copy constructor. Note that a copy of a collection is always non-owning,
137/// even the source collection is owning. To create an owning copy of
138/// a collection (owning or not), use the snapshot() method.
139
141 TObject(other),
142 RooPrintable(other),
143 _name(name),
144 _allRRV(other._allRRV)
145{
146 RooTrace::create(this) ;
147 if (!name) setName(other.GetName()) ;
148
149 _list.reserve(other._list.size());
150
151 for (auto item : other._list) {
152 insert(item);
153 }
154}
155
156
157////////////////////////////////////////////////////////////////////////////////
158/// Move constructor.
159
161 TObject(other),
162 RooPrintable(other),
163 _list(std::move(other._list)),
164 _ownCont(other._ownCont),
165 _name(std::move(other._name)),
166 _allRRV(other._allRRV),
167 _sizeThresholdForMapSearch(other._sizeThresholdForMapSearch)
168{
169}
170
171
172////////////////////////////////////////////////////////////////////////////////
173/// Destructor
174
176{
177 // Delete all variables in our list if we own them
178 if(_ownCont){
182
183
184////////////////////////////////////////////////////////////////////////////////
185/// Delete contents of the list.
186/// The RooAbsArg destructor ensures clients and servers can be deleted in any
187/// order.
188/// Also cleans the hash-map for fast lookups if present.
189
191{
192 _hashAssistedFind = nullptr;
193
194 // Built-in delete remaining elements
195 for (auto item : _list) {
196 delete item;
197 }
198 _list.clear();
199}
200
201
202
203////////////////////////////////////////////////////////////////////////////////
204/// Take a snap shot of current collection contents.
205/// An owning collection is returned containing clones of
206/// - Elements in this collection
207/// - External dependents of all elements and recursively any dependents of those dependents
208/// (if deepCopy flag is set)
209///
210/// This is useful to save the values of variables or parameters. It doesn't require
211/// deep copying if the parameters are direct members of the collection.
212///
213/// If deepCopy is specified, the client-server links between the cloned
214/// list elements and the cloned external dependents are reconnected to
215/// each other, making the snapshot a completely self-contained entity.
216///
217///
218
220{
221 // First create empty list
222 TString snapName ;
223 if (TString(GetName()).Length()>0) {
224 snapName.Append("Snapshot of ") ;
225 snapName.Append(GetName()) ;
226 }
227 auto* output = static_cast<RooAbsCollection*>(create(snapName.Data())) ;
228
229 if (snapshot(*output,deepCopy)) {
230 delete output ;
231 return nullptr ;
232 }
233
234 return output ;
235}
236
237
238
239////////////////////////////////////////////////////////////////////////////////
240/// Take a snap shot of current collection contents:
241/// A collection that owns its elements is returned containing clones of
242/// - Elements in this collection
243/// - External dependents of those elements
244/// and recursively any dependents of those dependents
245/// (if deepCopy flag is set)
246///
247/// If deepCopy is specified, the client-server links between the cloned
248/// list elements and the cloned external dependents are reconnected to
249/// each other, making the snapshot a completely self-contained entity.
250///
251///
252
254{
255 return RooHelpers::Detail::snapshotImpl(*this, output, deepCopy, nullptr);
256}
257
258
259////////////////////////////////////////////////////////////////////////////////
260/// Assign values from the elements in `other` to our elements.
261/// \warning This is not a conventional assignment operator. To avoid confusion, prefer using RooAbsCollection::assign().
262
264{
265 assign(other);
266 return *this;
267}
268
269
270////////////////////////////////////////////////////////////////////////////////
271/// Sets the value, cache and constant attribute of any argument in our set
272/// that also appears in the other set. Note that this function changes the
273/// values of the elements in this collection, but is still marked `const` as
274/// it does not change which elements this collection points to.
275
277{
278 if (&other==this) return ;
279
280 for (auto elem : _list) {
281 auto theirs = other.find(*elem);
282 if(!theirs) continue;
283 theirs->syncCache() ;
284 elem->copyCache(theirs) ;
285 elem->setAttribute("Constant",theirs->isConstant()) ;
286 }
287 return ;
288}
289
290
291////////////////////////////////////////////////////////////////////////////////
292/// Sets the value of any argument in our set that also appears in the other set.
293/// \param[in] other Collection holding the arguments to synchronize values with.
294/// \param[in] forceIfSizeOne If set to true and both our collection
295/// and the other collection have a size of one, the arguments are
296/// always synchronized without checking if they have the same name.
297
299{
300 if (&other==this) return *this;
301
302 // Short cut for 1 element assignment
303 if (size()==1 && size() == other.size() && forceIfSizeOne) {
304 other.first()->syncCache() ;
305 first()->copyCache(other.first(),true) ;
306 return *this;
307 }
308
309 for (auto elem : _list) {
310 auto theirs = other.find(*elem);
311 if(!theirs) continue;
312 theirs->syncCache() ;
313 elem->copyCache(theirs,true) ;
314 }
315 return *this;
316}
317
318
319
320////////////////////////////////////////////////////////////////////////////////
321/// Functional equivalent of assign() but assumes this and other collection
322/// have same layout. Also no attributes are copied
323
324void RooAbsCollection::assignFast(const RooAbsCollection& other, bool setValDirty) const
325{
326 if (&other==this) return ;
327 assert(hasSameLayout(other));
328
329 auto iter2 = other._list.begin();
330 for (auto iter1 = _list.begin();
331 iter1 != _list.end() && iter2 != other._list.end();
332 ++iter1, ++iter2) {
333 // Identical size of iterators is documented assumption of method
334
335 if (_allRRV) {
336 // All contents are known to be RooRealVars - fast version of assignment
337 auto ours = static_cast<RooRealVar*>(*iter1);
338 auto theirs = static_cast<RooRealVar*>(*iter2);
339 ours->copyCacheFast(*theirs,setValDirty);
340 } else {
341 (*iter2)->syncCache() ;
342 (*iter1)->copyCache(*iter2,true,setValDirty) ;
343 }
344 }
345
346}
347
348
349////////////////////////////////////////////////////////////////////////////////
350/// Add an argument and transfer the ownership to the collection. Returns `true`
351/// if successful, or `false` if the argument could not be added to the
352/// collection (e.g. in the RooArgSet case when an argument with the same name
353/// is already in the list). This method can only be called on a list that is
354/// flagged as owning all of its contents, or else on an empty list (which will
355/// force the list into that mode).
356///
357/// If the argument you want to add is owned by a `std::unique_ptr`, you should
358/// prefer RooAbsCollection::addOwned(std::unique_ptr<RooAbsArg>, bool).
359
361{
362 if(!canBeAdded(var, silent)) return false;
363
364 // check that we own our variables or else are empty
365 if(!_ownCont && !empty() && !silent) {
366 coutE(ObjectHandling) << ClassName() << "::" << GetName() << "::addOwned: can only add to an owned list" << std::endl;
367 return false;
368 }
369 _ownCont= true;
370
371 insert(&var);
372
373 return true;
374}
375
376
377////////////////////////////////////////////////////////////////////////////////
378/// Add an argument and transfer the ownership to the collection from a
379/// `std::unique_ptr`. Always returns `true`. If the argument can not be added
380/// to the collection (e.g. in the RooArgSet case when an argument with the
381/// same name is already in the list), a `std::runtime_exception` will be
382/// thrown, as nobody is owning the argument anymore. This method can only be
383/// called on a list that is flagged as owning all of its contents, or else on
384/// an empty list (which will force the list into that mode).
385///
386/// If you want to pass an argument that is not owned by a `std::unique_ptr`,
387/// you can use RooAbsCollection::addOwned(RooAbsArg&, bool).
388
389bool RooAbsCollection::addOwned(std::unique_ptr<RooAbsArg> var, bool silent) {
390 bool result = addOwned(*var.release(), silent);
391 if(!result) {
392 throw std::runtime_error(std::string("RooAbsCollection::addOwned could not add the argument to the")
393 + " collection! The ownership would not be well defined if we ignore this.");
394 }
395 return result;
396}
397
398
399
400////////////////////////////////////////////////////////////////////////////////
401/// Add a clone of the specified argument to list. Returns a pointer to
402/// the clone if successful, or else zero if a variable of the same name
403/// is already in the list or the list does *not* own its variables (in
404/// this case, try add() instead.) Calling addClone() on an empty list
405/// forces it to take ownership of all its subsequent variables.
406
408{
409 if(!canBeAdded(var, silent)) return nullptr;
410
411 // check that we own our variables or else are empty
412 if(!_ownCont && !empty() && !silent) {
413 coutE(ObjectHandling) << ClassName() << "::" << GetName() << "::addClone: can only add to an owned list" << std::endl;
414 return nullptr;
415 }
416 _ownCont= true;
417
418 // add a pointer to a clone of this variable to our list (we now own it!)
419 auto clone2 = static_cast<RooAbsArg*>(var.Clone());
420 assert(clone2);
421
422 insert(clone2);
423
424 return clone2;
425}
426
427
428
429////////////////////////////////////////////////////////////////////////////////
430/// Add the specified argument to list. Returns true if successful, or
431/// else false if a variable of the same name is already in the list
432/// or the list owns its variables (in this case, try addClone() or addOwned() instead).
433
434bool RooAbsCollection::add(const RooAbsArg& var, bool silent)
435{
436 if(!canBeAdded(var, silent)) return false;
437
438 // check that this isn't a copy of a list
439 if(_ownCont && !silent) {
440 coutE(ObjectHandling) << ClassName() << "::" << GetName() << "::add: cannot add to an owned list" << std::endl;
441 return false;
442 }
443
444 // add a pointer to this variable to our list (we don't own it!)
445 insert(const_cast<RooAbsArg*>(&var)); //FIXME const_cast
446
447 return true;
448}
449
450
451////////////////////////////////////////////////////////////////////////////////
452// Add a collection of arguments to this collection by calling addOwned()
453/// for each element in the source collection. The input list can't be an
454/// owning collection itself, otherwise the arguments would be owned by two
455/// collections.
456///
457/// If you want to transfer arguments from one owning collection to another,
458/// you have two options:
459/// 1. `std::move` the input collection and use
460/// RooAbsCollection::addOwned(RooAbsCollection&&, bool) (preferred)
461/// 2. release the ownership of the input collection first, using
462/// RooAbsCollection::releaseOwnership()
463
464bool RooAbsCollection::addOwned(const RooAbsCollection& list, bool silent)
465{
466 if(list.isOwning()) {
467 throw std::invalid_argument("Passing an owning RooAbsCollection by const& to"
468 " RooAbsCollection::addOwned is forbidden because the ownership"
469 " would be ambiguous! Please std::move() the RooAbsCollection in this case."
470 " Note that the passed RooAbsCollection is invalid afterwards.");
471
472 }
473
474 bool result(false) ;
475 _list.reserve(_list.size() + list._list.size());
476
477 for (auto item : list._list) {
478 result |= addOwned(*item, silent) ;
479 }
480
481 return result;
482}
483
484
485////////////////////////////////////////////////////////////////////////////////
486/// Add a collection of arguments to this collection by calling addOwned()
487/// for each element in the source collection. Unlike
488/// RooAbsCollection::addOwned(const RooAbsCollection&, bool), this function
489/// also accepts owning source collections because their content will be
490/// moved out.
491
493{
494 if(list.isOwning()) {
495 list.releaseOwnership();
496 }
497 if(list.empty()) return false;
498
499 bool result = addOwned(list, silent);
500
501 if(!result) {
502 throw std::runtime_error(std::string("RooAbsCollection::addOwned could not add the argument to the")
503 + " collection! The ownership would not be well defined if we ignore this.");
504 }
505
506 // So far, comps has only released the ownership, but it is still valid.
507 // However, we don't want users to keep using objects after moving them, so
508 // we make sure to keep our promise that the RooArgSet is really moved.
509 // Just like a `std::unique_ptr` is also reset when moved.
510 list.clear();
511
512 return result;
513}
514
515
516////////////////////////////////////////////////////////////////////////////////
517/// Add a collection of arguments to this collection by calling addOwned()
518/// for each element in the source collection
519
520void RooAbsCollection::addClone(const RooAbsCollection& list, bool silent)
521{
522 _list.reserve(_list.size() + list._list.size());
523
524 for (auto item : list._list) {
525 addClone(*item, silent);
526 }
527}
528
529
530
531////////////////////////////////////////////////////////////////////////////////
532/// Replace any args in our set with args of the same name from the other set
533/// and return true for success. Fails if this list is a copy of another.
534
536{
537 // check that this isn't a copy of a list
538 if(_ownCont) {
539 coutE(ObjectHandling) << "RooAbsCollection: cannot replace variables in a copied list" << std::endl;
540 return false;
541 }
542
543 // loop over elements in the other list
544 for (const auto * arg : other._list) {
545 // do we have an arg of the same name in our set?
546 auto found = find(*arg);
547 if (found) replace(*found,*arg);
548 }
549 return true;
550}
551
552
553
554////////////////////////////////////////////////////////////////////////////////
555/// Replace var1 with var2 and return true for success. Fails if
556/// this list is a copy of another, if var1 is not already in this set,
557/// or if var2 is already in this set. var1 and var2 do not need to have
558/// the same name.
559
560bool RooAbsCollection::replace(const RooAbsArg& var1, const RooAbsArg& var2)
561{
562 // check that this isn't a copy of a list
563 if(_ownCont) {
564 coutE(ObjectHandling) << "RooAbsCollection: cannot replace variables in a copied list" << std::endl;
565 return false;
566 }
567
568 // is var1 already in this list?
569 const char *name= var1.GetName();
570 auto var1It = std::find(_list.begin(), _list.end(), &var1);
571
572 if (var1It == _list.end()) {
573 coutE(ObjectHandling) << "RooAbsCollection: variable \"" << name << "\" is not in the list"
574 << " and cannot be replaced" << std::endl;
575 return false;
576 }
577
578
579 // is var2's name already in this list?
580 if (dynamic_cast<RooArgSet*>(this)) {
581 RooAbsArg *other = find(var2);
582 if(other != nullptr && other != &var1) {
583 coutE(ObjectHandling) << "RooAbsCollection: cannot replace \"" << name
584 << "\" with already existing \"" << var2.GetName() << "\"" << std::endl;
585 return false;
586 }
587 }
588
589 // replace var1 with var2
590 if (_hashAssistedFind) {
591 _hashAssistedFind->replace(*var1It, &var2);
592 }
593 *var1It = const_cast<RooAbsArg*>(&var2); //FIXME try to get rid of const_cast
594
595 if (_allRRV && dynamic_cast<const RooRealVar*>(&var2)==nullptr) {
596 _allRRV=false ;
597 }
598
599 return true;
600}
601
602
603
604////////////////////////////////////////////////////////////////////////////////
605/// Remove the specified argument from our list. Return false if
606/// the specified argument is not found in our list. An exact pointer
607/// match is required, not just a match by name.
608/// If `matchByNameOnly` is set, items will be looked up by name. In this case, if
609/// the collection also owns the item, it will delete it.
610bool RooAbsCollection::remove(const RooAbsArg& var, bool , bool matchByNameOnly)
611{
612 // is var already in this list?
613 const auto sizeBefore = _list.size();
614
615 if (matchByNameOnly) {
616 const std::string name(var.GetName());
617 auto nameMatch = [&name](const RooAbsArg* elm) {
618 return elm->GetName() == name;
619 };
620 std::set<RooAbsArg*> toBeDeleted;
621
622 if (_ownCont) {
623 std::for_each(_list.begin(), _list.end(), [&toBeDeleted, nameMatch](RooAbsArg* elm){
624 if (nameMatch(elm)) {
625 toBeDeleted.insert(elm);
626 }
627 });
628 }
629
630 _list.erase(std::remove_if(_list.begin(), _list.end(), nameMatch), _list.end());
631
632 for (auto arg : toBeDeleted)
633 delete arg;
634 } else {
635 _list.erase(std::remove(_list.begin(), _list.end(), &var), _list.end());
636 }
637
638 if (_hashAssistedFind && sizeBefore != _list.size()) {
639 _hashAssistedFind->erase(&var);
640 }
641
642 return sizeBefore != _list.size();
643}
644
645
646
647////////////////////////////////////////////////////////////////////////////////
648/// Remove each argument in the input list from our list.
649/// An exact pointer match is required, not just a match by name.
650/// If `matchByNameOnly` is set, items will be looked up by name. In this case, if
651/// the collection also owns the items, it will delete them.
652/// Return false in case of problems.
653
654bool RooAbsCollection::remove(const RooAbsCollection& list, bool /*silent*/, bool matchByNameOnly)
655{
656
657 auto oldSize = _list.size();
658 std::vector<const RooAbsArg*> markedItems;
659
660 if (matchByNameOnly) {
661
662 // Instead of doing two passes on the list as in remove(RooAbsArg&), we do
663 // everything in one pass, by using side effects of the predicate.
664 auto nameMatchAndMark = [&list, &markedItems](const RooAbsArg* elm) {
665 if( list.contains(*elm) ) {
666 markedItems.push_back(elm);
667 return true;
668 }
669 return false;
670 };
671
672 _list.erase(std::remove_if(_list.begin(), _list.end(), nameMatchAndMark), _list.end());
673
674 }
675 else {
676 auto argMatchAndMark = [&list, &markedItems](const RooAbsArg* elm) {
677 if( list.containsInstance(*elm) ) {
678 markedItems.push_back(elm);
679 return true;
680 }
681 return false;
682 };
683
684 _list.erase(std::remove_if(_list.begin(), _list.end(), argMatchAndMark), _list.end());
685 }
686
687 if (_hashAssistedFind && oldSize != _list.size()) {
688 for( auto& var : markedItems ) {
689 _hashAssistedFind->erase(var);
690 }
691 }
692
693 if (matchByNameOnly && _ownCont) {
694 std::set<const RooAbsArg*> toBeDeleted(markedItems.begin(), markedItems.end());
695 for (auto arg : toBeDeleted) {
696 delete arg;
697 }
698 }
699
700 return oldSize != _list.size();
701}
702
703
704
705////////////////////////////////////////////////////////////////////////////////
706/// Remove all arguments from our set, deleting them if we own them.
707/// This effectively restores our object to the state it would have
708/// just after calling the RooAbsCollection(const char*) constructor.
709
711{
712 _hashAssistedFind = nullptr;
713
714 if(_ownCont) {
715 deleteList() ;
716 _ownCont= false;
717 }
718 else {
719 _list.clear();
720 }
721}
722
723
724
725////////////////////////////////////////////////////////////////////////////////
726/// Set given attribute in each element of the collection by
727/// calling each elements setAttribute() function.
728
730{
731 for (auto arg : _list) {
732 arg->setAttribute(name, value);
733 }
734}
735
736
737
738
739////////////////////////////////////////////////////////////////////////////////
740/// Create a subset of the current collection, consisting only of those
741/// elements with the specified attribute set. The caller is responsible
742/// for deleting the returned collection
743
745{
746 TString selName(GetName()) ;
747 selName.Append("_selection") ;
748 RooAbsCollection *sel = static_cast<RooAbsCollection*>(create(selName.Data())) ;
749
750 // Scan set contents for matching attribute
751 for (auto arg : _list) {
752 if (arg->getAttribute(name)==value)
753 sel->add(*arg) ;
754 }
755
756 return sel ;
757}
758
759
760////////////////////////////////////////////////////////////////////////////////
761/// Create a subset of the current collection, consisting only of those
762/// elements that are contained as well in the given reference collection.
763/// Returns `true` only if something went wrong.
764/// The complement of this function is getParameters().
765/// \param[in] refColl The collection to check for common elements.
766/// \param[out] outColl Output collection.
767
769{
770 outColl.clear();
771 outColl.setName((std::string(GetName()) + "_selection").c_str());
772
773 // Scan set contents for matching attribute
774 for (auto arg : _list) {
775 if (refColl.find(*arg))
776 outColl.add(*arg) ;
777 }
778
779 return false;
780}
781
782
783////////////////////////////////////////////////////////////////////////////////
784/// Create a subset of the current collection, consisting only of those
785/// elements that are contained as well in the given reference collection.
786/// The caller is responsible for deleting the returned collection
787
789{
790 auto sel = static_cast<RooAbsCollection*>(create("")) ;
791 selectCommon(refColl, *sel);
792 return sel ;
793}
794
795
796////////////////////////////////////////////////////////////////////////////////
797/// Create a subset of the current collection, consisting only of those
798/// elements with names matching the wildcard expressions in nameList,
799/// supplied as a comma separated list
800
801RooAbsCollection* RooAbsCollection::selectByName(const char* nameList, bool verbose) const
802{
803 // Create output set
804 TString selName(GetName()) ;
805 selName.Append("_selection") ;
806 RooAbsCollection *sel = static_cast<RooAbsCollection*>(create(selName.Data())) ;
807
808 const size_t bufSize = strlen(nameList) + 1;
809 std::vector<char> buf(bufSize);
810 strlcpy(buf.data(),nameList,bufSize) ;
811 char* wcExpr = strtok(buf.data(),",") ;
812 while(wcExpr) {
813 TRegexp rexp(wcExpr,true) ;
814 if (verbose) {
815 cxcoutD(ObjectHandling) << "RooAbsCollection::selectByName(" << GetName() << ") processing expression '" << wcExpr << "'" << std::endl;
816 }
817
818 for (auto const* arg : *this) {
819 if (TString(arg->GetName()).Index(rexp)>=0) {
820 if (verbose) {
821 cxcoutD(ObjectHandling) << "RooAbsCollection::selectByName(" << GetName() << ") selected element " << arg->GetName() << std::endl;
822 }
823 sel->add(*arg) ;
824 }
825 }
826 wcExpr = strtok(nullptr,",") ;
827 }
828
829 return sel ;
830}
831
832
833
834
835////////////////////////////////////////////////////////////////////////////////
836/// Check if this and other collection have identically-named contents
837
838bool RooAbsCollection::equals(const RooAbsCollection& otherColl) const
839{
840 // First check equal length
841 if (size() != otherColl.size()) return false ;
842
843 // Then check that each element of our list also occurs in the other list
844 auto compareByNamePtr = [](const RooAbsArg * left, const RooAbsArg * right) {
845 return left->namePtr() == right->namePtr();
846 };
847
848 return std::is_permutation(_list.begin(), _list.end(),
849 otherColl._list.begin(),
850 compareByNamePtr);
851}
852
853
854namespace {
855////////////////////////////////////////////////////////////////////////////////
856/// Linear search through list of stored objects.
857template<class Collection_t>
858RooAbsArg* findUsingNamePointer(const Collection_t& coll, const TNamed* ptr) {
859 auto findByNamePtr = [ptr](const RooAbsArg* elm) {
860 return ptr == elm->namePtr();
861 };
862
863 auto item = std::find_if(coll.begin(), coll.end(), findByNamePtr);
864
865 return item != coll.end() ? *item : nullptr;
866}
867}
868
869
870////////////////////////////////////////////////////////////////////////////////
871/// Find object with given name in list. A null pointer
872/// is returned if no object with the given name is found.
874{
875 if (!name)
876 return nullptr;
877
878 // If an object with such a name exists, its name has been registered.
879 const TNamed* nptr = RooNameReg::known(name);
880 if (!nptr) return nullptr;
881
883 if (!_hashAssistedFind || !_hashAssistedFind->isValid()) {
884 _hashAssistedFind = std::make_unique<HashAssistedFind>(_list.begin(), _list.end());
885 }
886
887 return _hashAssistedFind->find(nptr);
888 }
889
890 return findUsingNamePointer(_list, nptr);
891}
892
893
894
895////////////////////////////////////////////////////////////////////////////////
896/// Find object with given name in list. A null pointer
897/// is returned if no object with the given name is found.
899{
900 const auto nptr = arg.namePtr();
901
903 if (!_hashAssistedFind || !_hashAssistedFind->isValid()) {
904 _hashAssistedFind = std::make_unique<HashAssistedFind>(_list.begin(), _list.end());
905 }
906
907 return _hashAssistedFind->find(nptr);
908 }
909
910 return findUsingNamePointer(_list, nptr);
911}
912
913
914////////////////////////////////////////////////////////////////////////////////
915/// Return index of item with given name, or -1 in case it's not in the collection.
917 const std::string theName(name);
918 auto item = std::find_if(_list.begin(), _list.end(), [&theName](const RooAbsArg * elm){
919 return elm->GetName() == theName;
920 });
921 return item != _list.end() ? item - _list.begin() : -1;
922}
923
924
925////////////////////////////////////////////////////////////////////////////////
926/// Get value of a RooAbsReal stored in set with given name. If none is found, value of defVal is returned.
927/// No error messages are printed unless the verbose flag is set
928
929double RooAbsCollection::getRealValue(const char* name, double defVal, bool verbose) const
930{
931 RooAbsArg* raa = find(name) ;
932 if (!raa) {
933 if (verbose) coutE(InputArguments) << "RooAbsCollection::getRealValue(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
934 return defVal ;
935 }
936 RooAbsReal* rar = dynamic_cast<RooAbsReal*>(raa) ;
937 if (!rar) {
938 if (verbose) coutE(InputArguments) << "RooAbsCollection::getRealValue(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsReal" << std::endl;
939 return defVal ;
940 }
941 return rar->getVal() ;
942}
943
944
945
946////////////////////////////////////////////////////////////////////////////////
947/// Set value of a RooAbsRealLValue stored in set with given name to newVal
948/// No error messages are printed unless the verbose flag is set
949
950bool RooAbsCollection::setRealValue(const char* name, double newVal, bool verbose)
951{
952 RooAbsArg* raa = find(name) ;
953 if (!raa) {
954 if (verbose) coutE(InputArguments) << "RooAbsCollection::setRealValue(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
955 return true ;
956 }
957 auto* rar = dynamic_cast<RooAbsRealLValue*>(raa) ;
958 if (!rar) {
959 if (verbose) coutE(InputArguments) << "RooAbsCollection::setRealValue(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsRealLValue" << std::endl;
960 return true;
961 }
962 rar->setVal(newVal) ;
963 return false ;
964}
965
966
967
968////////////////////////////////////////////////////////////////////////////////
969/// Get state name of a RooAbsCategory stored in set with given name. If none is found, value of defVal is returned.
970/// No error messages are printed unless the verbose flag is set
971
972const char* RooAbsCollection::getCatLabel(const char* name, const char* defVal, bool verbose) const
973{
974 RooAbsArg* raa = find(name) ;
975 if (!raa) {
976 if (verbose) coutE(InputArguments) << "RooAbsCollection::getCatLabel(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
977 return defVal ;
978 }
979 auto* rac = dynamic_cast<RooAbsCategory*>(raa) ;
980 if (!rac) {
981 if (verbose) coutE(InputArguments) << "RooAbsCollection::getCatLabel(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsCategory" << std::endl;
982 return defVal ;
983 }
984 return rac->getCurrentLabel() ;
985}
986
987
988
989////////////////////////////////////////////////////////////////////////////////
990/// Set state name of a RooAbsCategoryLValue stored in set with given name to newVal.
991/// No error messages are printed unless the verbose flag is set
992
993bool RooAbsCollection::setCatLabel(const char* name, const char* newVal, bool verbose)
994{
995 RooAbsArg* raa = find(name) ;
996 if (!raa) {
997 if (verbose) coutE(InputArguments) << "RooAbsCollection::setCatLabel(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
998 return true ;
999 }
1000 auto* rac = dynamic_cast<RooAbsCategoryLValue*>(raa) ;
1001 if (!rac) {
1002 if (verbose) coutE(InputArguments) << "RooAbsCollection::setCatLabel(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsCategory" << std::endl;
1003 return true ;
1004 }
1005 rac->setLabel(newVal) ;
1006 return false ;
1007}
1008
1009
1010
1011////////////////////////////////////////////////////////////////////////////////
1012/// Get index value of a RooAbsCategory stored in set with given name. If none is found, value of defVal is returned.
1013/// No error messages are printed unless the verbose flag is set
1014
1015Int_t RooAbsCollection::getCatIndex(const char* name, Int_t defVal, bool verbose) const
1016{
1017 RooAbsArg* raa = find(name) ;
1018 if (!raa) {
1019 if (verbose) coutE(InputArguments) << "RooAbsCollection::getCatLabel(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
1020 return defVal ;
1021 }
1022 auto* rac = dynamic_cast<RooAbsCategory*>(raa) ;
1023 if (!rac) {
1024 if (verbose) coutE(InputArguments) << "RooAbsCollection::getCatLabel(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsCategory" << std::endl;
1025 return defVal ;
1026 }
1027 return rac->getCurrentIndex() ;
1028}
1029
1030
1031
1032////////////////////////////////////////////////////////////////////////////////
1033/// Set index value of a RooAbsCategoryLValue stored in set with given name to newVal.
1034/// No error messages are printed unless the verbose flag is set
1035
1036bool RooAbsCollection::setCatIndex(const char* name, Int_t newVal, bool verbose)
1037{
1038 RooAbsArg* raa = find(name) ;
1039 if (!raa) {
1040 if (verbose) coutE(InputArguments) << "RooAbsCollection::setCatLabel(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
1041 return true ;
1042 }
1043 auto* rac = dynamic_cast<RooAbsCategoryLValue*>(raa) ;
1044 if (!rac) {
1045 if (verbose) coutE(InputArguments) << "RooAbsCollection::setCatLabel(" << GetName() << ") ERROR object '" << name << "' is not of type RooAbsCategory" << std::endl;
1046 return true ;
1047 }
1048 rac->setIndex(newVal) ;
1049 return false ;
1050}
1051
1052
1053
1054////////////////////////////////////////////////////////////////////////////////
1055/// Get string value of a RooStringVar stored in set with given name. If none is found, value of defVal is returned.
1056/// No error messages are printed unless the verbose flag is set
1057
1058const char* RooAbsCollection::getStringValue(const char* name, const char* defVal, bool verbose) const
1059{
1060 RooAbsArg* raa = find(name) ;
1061 if (!raa) {
1062 if (verbose) coutE(InputArguments) << "RooAbsCollection::getStringValue(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
1063 return defVal ;
1064 }
1065 auto ras = dynamic_cast<const RooStringVar*>(raa) ;
1066 if (!ras) {
1067 if (verbose) coutE(InputArguments) << "RooAbsCollection::getStringValue(" << GetName() << ") ERROR object '" << name << "' is not of type RooStringVar" << std::endl;
1068 return defVal ;
1069 }
1070
1071 return ras->getVal() ;
1072}
1073
1074
1075
1076////////////////////////////////////////////////////////////////////////////////
1077/// Set string value of a RooStringVar stored in set with given name to newVal.
1078/// No error messages are printed unless the verbose flag is set
1079
1080bool RooAbsCollection::setStringValue(const char* name, const char* newVal, bool verbose)
1081{
1082 RooAbsArg* raa = find(name) ;
1083 if (!raa) {
1084 if (verbose) coutE(InputArguments) << "RooAbsCollection::setStringValue(" << GetName() << ") ERROR no object with name '" << name << "' found" << std::endl;
1085 return true ;
1086 }
1087 auto ras = dynamic_cast<RooStringVar*>(raa);
1088 if (!ras) {
1089 if (verbose) coutE(InputArguments) << "RooAbsCollection::setStringValue(" << GetName() << ") ERROR object '" << name << "' is not of type RooStringVar" << std::endl;
1090 return true ;
1091 }
1092 ras->setVal(newVal);
1093
1094 return false;
1095}
1096
1097////////////////////////////////////////////////////////////////////////////////
1098/// Return comma separated list of contained object names as STL string
1100{
1101 std::string retVal ;
1102 for (auto arg : _list) {
1103 retVal += arg->GetName();
1104 retVal += ",";
1105 }
1106
1107 retVal.erase(retVal.end()-1);
1108
1109 return retVal;
1110}
1111
1112
1113
1114////////////////////////////////////////////////////////////////////////////////
1115/// Return collection name
1116
1117void RooAbsCollection::printName(std::ostream& os) const
1118{
1119 os << GetName() ;
1120}
1121
1122
1123
1124////////////////////////////////////////////////////////////////////////////////
1125/// Return collection title
1126
1127void RooAbsCollection::printTitle(std::ostream& os) const
1128{
1129 os << GetTitle() ;
1130}
1131
1132
1133
1134////////////////////////////////////////////////////////////////////////////////
1135/// Return collection class name
1136
1137void RooAbsCollection::printClassName(std::ostream& os) const
1138{
1139 os << ClassName() ;
1140}
1141
1142
1143
1144////////////////////////////////////////////////////////////////////////////////
1145/// Define default RooPrinable print options for given Print() flag string
1146/// For inline printing only show value of objects, for default print show
1147/// name,class name value and extras of each object. In verbose mode
1148/// also add object address, argument and title
1149
1151{
1152 if (opt && TString(opt)=="I") {
1153 return kValue ;
1154 }
1155 if (opt && TString(opt).Contains("v")) {
1157 }
1158 return kName|kClassName|kValue ;
1159}
1160
1161
1162
1163
1164
1165////////////////////////////////////////////////////////////////////////////////
1166/// Print value of collection, i.e. a comma separated list of contained
1167/// object names
1168
1169void RooAbsCollection::printValue(std::ostream& os) const
1170{
1171 bool first2(true) ;
1172 os << "(" ;
1173 for (auto arg : _list) {
1174 if (!first2) {
1175 os << "," ;
1176 } else {
1177 first2 = false ;
1178 }
1179 if (arg->IsA()->InheritsFrom(RooStringVar::Class())) {
1180 os << '\'' << (static_cast<RooStringVar *>(arg))->getVal() << '\'';
1181 } else {
1182 os << arg->GetName();
1183 }
1184 }
1185 os << ")" ;
1186}
1187
1188
1189
1190////////////////////////////////////////////////////////////////////////////////
1191/// Implement multiline printing of collection, one line for each contained object showing
1192/// the requested content
1193
1194void RooAbsCollection::printMultiline(std::ostream&os, Int_t contents, bool /*verbose*/, TString indent) const
1195{
1196 if (TString(GetName()).Length()>0 && (contents&kCollectionHeader)) {
1197 os << indent << ClassName() << "::" << GetName() << ":" << (_ownCont?" (Owning contents)":"") << std::endl;
1198 }
1199
1200 TString deeper(indent);
1201 deeper.Append(" ");
1202
1203 // Adjust the width of the name field to fit the largest name, if requested
1204 Int_t maxNameLen(1) ;
1205 Int_t nameFieldLengthSaved = RooPrintable::_nameLength ;
1206 if (nameFieldLengthSaved==0) {
1207 for (auto next : _list) {
1208 Int_t len = strlen(next->GetName()) ;
1209 if (len>maxNameLen) maxNameLen = len ;
1210 }
1211 RooPrintable::nameFieldLength(maxNameLen+1) ;
1212 }
1213
1214 unsigned int idx = 0;
1215 for (auto next : _list) {
1216 os << indent << std::setw(3) << ++idx << ") ";
1217 next->printStream(os,contents,kSingleLine,"");
1218 }
1219
1220 // Reset name field length, if modified
1221 RooPrintable::nameFieldLength(nameFieldLengthSaved) ;
1222}
1223
1224
1225
1226////////////////////////////////////////////////////////////////////////////////
1227/// Base contents dumper for debugging purposes
1228
1230{
1231 for (auto arg : _list) {
1232 std::cout << arg << " " << arg->ClassName() << "::" << arg->GetName() << " (" << arg->GetTitle() << ")" << std::endl ;
1233 }
1234}
1235
1236
1237
1238////////////////////////////////////////////////////////////////////////////////
1239/// Output content of collection as LaTex table. By default a table with two columns is created: the left
1240/// column contains the name of each variable, the right column the value.
1241///
1242/// The following optional named arguments can be used to modify the default behavior
1243/// <table>
1244/// <tr><th> Argument <th> Effect
1245/// <tr><td> `Columns(Int_t ncol)` <td> Fold table into multiple columns, i.e. ncol=3 will result in 3 x 2 = 6 total columns
1246/// <tr><td> `Sibling(const RooAbsCollection& other)` <td> Define sibling list.
1247/// The sibling list is assumed to have objects with the same
1248/// name in the same order. If this is not the case warnings will be printed. If a single
1249/// sibling list is specified, 3 columns will be output: the (common) name, the value of this
1250/// list and the value in the sibling list. Multiple sibling lists can be specified by
1251/// repeating the Sibling() command.
1252/// <tr><td> `Format(const char* str)` <td> Classic format string, provided for backward compatibility
1253/// <tr><td> `Format()` <td> Formatting arguments.
1254/// <table>
1255/// <tr><td> const char* what <td> Controls what is shown. "N" adds name, "E" adds error,
1256/// "A" shows asymmetric error, "U" shows unit, "H" hides the value
1257/// <tr><td> `FixedPrecision(int n)` <td> Controls precision, set fixed number of digits
1258/// <tr><td> `AutoPrecision(int n)` <td> Controls precision. Number of shown digits is calculated from error
1259/// and n specified additional digits (1 is sensible default)
1260/// <tr><td> `VerbatimName(bool flag)` <td> Put variable name in a \\verb+ + clause.
1261/// </table>
1262/// <tr><td> `OutputFile(const char* fname)` <td> Send output to file with given name rather than standard output
1263///
1264/// </table>
1265///
1266/// Example use:
1267/// ```
1268/// list.printLatex(Columns(2), Format("NEU",AutoPrecision(1),VerbatimName()) );
1269/// ```
1270
1272 const RooCmdArg& arg3, const RooCmdArg& arg4,
1273 const RooCmdArg& arg5, const RooCmdArg& arg6,
1274 const RooCmdArg& arg7, const RooCmdArg& arg8) const
1275{
1276
1277
1278 // Define configuration for this method
1279 RooCmdConfig pc("RooAbsCollection::printLatex()") ;
1280 pc.defineInt("ncol","Columns",0,1) ;
1281 pc.defineString("outputFile","OutputFile",0,"") ;
1282 pc.defineString("format","Format",0,"NEYVU") ;
1283 pc.defineInt("sigDigit","Format",0,1) ;
1284 pc.defineObject("siblings","Sibling",0,nullptr,true) ;
1285 pc.defineInt("dummy","FormatArgs",0,0) ;
1286 pc.defineMutex("Format","FormatArgs") ;
1287
1288 // Stuff all arguments in a list
1289 RooLinkedList cmdList;
1290 cmdList.Add(const_cast<RooCmdArg*>(&arg1)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg2)) ;
1291 cmdList.Add(const_cast<RooCmdArg*>(&arg3)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg4)) ;
1292 cmdList.Add(const_cast<RooCmdArg*>(&arg5)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg6)) ;
1293 cmdList.Add(const_cast<RooCmdArg*>(&arg7)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg8)) ;
1294
1295 // Process & check varargs
1296 pc.process(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8) ;
1297 if (!pc.ok(true)) {
1298 return ;
1299 }
1300
1301 const char* outFile = pc.getString("outputFile") ;
1302 if (outFile && strlen(outFile)) {
1303 std::ofstream ofs(outFile) ;
1304 if (pc.hasProcessed("FormatArgs")) {
1305 auto* formatCmd = static_cast<RooCmdArg*>(cmdList.FindObject("FormatArgs")) ;
1306 formatCmd->addArg(RooFit::LatexTableStyle()) ;
1307 printLatex(ofs,pc.getInt("ncol"),nullptr,0,pc.getObjectList("siblings"),formatCmd) ;
1308 } else {
1309 printLatex(ofs,pc.getInt("ncol"),pc.getString("format"),pc.getInt("sigDigit"),pc.getObjectList("siblings")) ;
1310 }
1311 } else {
1312 if (pc.hasProcessed("FormatArgs")) {
1313 auto* formatCmd = static_cast<RooCmdArg*>(cmdList.FindObject("FormatArgs")) ;
1314 formatCmd->addArg(RooFit::LatexTableStyle()) ;
1315 printLatex(std::cout,pc.getInt("ncol"),nullptr,0,pc.getObjectList("siblings"),formatCmd) ;
1316 } else {
1317 printLatex(std::cout,pc.getInt("ncol"),pc.getString("format"),pc.getInt("sigDigit"),pc.getObjectList("siblings")) ;
1318 }
1319 }
1320}
1321
1322
1323
1324
1325////////////////////////////////////////////////////////////////////////////////
1326/// Internal implementation function of printLatex
1327
1328void RooAbsCollection::printLatex(std::ostream& ofs, Int_t ncol, const char* option, Int_t sigDigit, const RooLinkedList& siblingList, const RooCmdArg* formatCmd) const
1329{
1330 // Count number of rows to print
1331 Int_t nrow = (Int_t) (size() / ncol + 0.99) ;
1332 Int_t i;
1333 Int_t j;
1334 Int_t k;
1335
1336 // Sibling list do not need to print their name as it is supposed to be the same
1337 TString sibOption ;
1338 RooCmdArg sibFormatCmd ;
1339 if (option) {
1340 sibOption = option ;
1341 sibOption.ReplaceAll("N","") ;
1342 sibOption.ReplaceAll("n","") ;
1343 } else {
1344 sibFormatCmd = *formatCmd ;
1345 TString tmp = formatCmd->getString(0) ;
1346 tmp.ReplaceAll("N","") ;
1347 tmp.ReplaceAll("n","") ;
1348 static char buf[100] ;
1349 strlcpy(buf,tmp.Data(),100) ;
1350 sibFormatCmd.setString(0, buf);
1351 }
1352
1353
1354 // Make list of lists ;
1355 RooLinkedList listList ;
1356 listList.Add(const_cast<RooAbsCollection *>(this));
1357 for(auto * col : static_range_cast<RooAbsCollection*>(siblingList)) {
1358 listList.Add(col) ;
1359 }
1360
1361 RooLinkedList listListRRV ;
1362
1363 // Make list of RRV-only components
1364 RooArgList* prevList = nullptr ;
1365 for(auto * col : static_range_cast<RooAbsCollection*>(listList)) {
1366 RooArgList* list = new RooArgList ;
1367 for (auto* arg : *col) {
1368 auto* rrv = dynamic_cast<RooRealVar*>(arg) ;
1369 if (rrv) {
1370 list->add(*rrv) ;
1371 } else {
1372 coutW(InputArguments) << "RooAbsCollection::printLatex: can only print RooRealVar in LateX, skipping non-RooRealVar object named "
1373 << arg->GetName() << std::endl;
1374 }
1375 if (prevList && TString(rrv->GetName()).CompareTo(prevList->at(list->size()-1)->GetName())) {
1376 coutW(InputArguments) << "RooAbsCollection::printLatex: WARNING: naming and/or ordering of sibling list is different" << std::endl;
1377 }
1378 }
1379 listListRRV.Add(list) ;
1380 if (prevList && list->size() != prevList->size()) {
1381 coutW(InputArguments) << "RooAbsCollection::printLatex: ERROR: sibling list(s) must have same length as self" << std::endl;
1382 delete list ;
1383 listListRRV.Delete() ;
1384 return ;
1385 }
1386 prevList = list ;
1387 }
1388
1389 // Construct table header
1390 Int_t nlist = listListRRV.GetSize() ;
1391 TString subheader = "l" ;
1392 for (k=0 ; k<nlist ; k++) subheader += "c" ;
1393
1394 TString header = "\\begin{tabular}{" ;
1395 for (j=0 ; j<ncol ; j++) {
1396 if (j>0) header += "|" ;
1397 header += subheader ;
1398 }
1399 header += "}" ;
1400 ofs << header << std::endl;
1401
1402
1403 // Print contents, delegating actual printing to RooRealVar::format()
1404 for (i=0 ; i<nrow ; i++) {
1405 for (j=0 ; j<ncol ; j++) {
1406 for (k=0 ; k<nlist ; k++) {
1407 RooRealVar* par = static_cast<RooRealVar*>((static_cast<RooArgList*>(listListRRV.At(k)))->at(i+j*nrow)) ;
1408 if (par) {
1409 if (option) {
1410 ofs << *std::unique_ptr<TString>{par->format(sigDigit,(k==0)?option:sibOption.Data())};
1411 } else {
1412 ofs << *std::unique_ptr<TString>{par->format((k==0)?*formatCmd:sibFormatCmd)};
1413 }
1414 }
1415 if (!(j==ncol-1 && k==nlist-1)) {
1416 ofs << " & " ;
1417 }
1418 }
1419 }
1420 ofs << "\\\\" << std::endl;
1421 }
1422
1423 ofs << "\\end{tabular}" << std::endl;
1424 listListRRV.Delete() ;
1425}
1426
1427
1428
1429
1430////////////////////////////////////////////////////////////////////////////////
1431/// Return true if all contained object report to have their
1432/// value inside the specified range
1433
1434bool RooAbsCollection::allInRange(const char* rangeSpec) const
1435{
1436 if (!rangeSpec) return true ;
1437
1438 // Parse rangeSpec specification
1439 std::vector<std::string> cutVec ;
1440 if (rangeSpec && strlen(rangeSpec)>0) {
1441 if (strchr(rangeSpec,',')==nullptr) {
1442 cutVec.push_back(rangeSpec) ;
1443 } else {
1444 const size_t bufSize = strlen(rangeSpec)+1;
1445 std::vector<char> buf(bufSize);
1446 strlcpy(buf.data(),rangeSpec,bufSize) ;
1447 const char* oneRange = strtok(buf.data(),",") ;
1448 while(oneRange) {
1449 cutVec.push_back(oneRange) ;
1450 oneRange = strtok(nullptr,",") ;
1451 }
1452 }
1453 }
1454
1455 // Apply range based selection criteria
1456 bool selectByRange = true ;
1457 for (auto arg : _list) {
1458 bool selectThisArg = false ;
1459 UInt_t icut ;
1460 for (icut=0 ; icut<cutVec.size() ; icut++) {
1461 if (arg->inRange(cutVec[icut].c_str())) {
1462 selectThisArg = true ;
1463 break ;
1464 }
1465 }
1466 if (!selectThisArg) {
1467 selectByRange = false ;
1468 break ;
1469 }
1470 }
1471
1472 return selectByRange ;
1473}
1474
1475////////////////////////////////////////////////////////////////////////////////
1476/// If one of the TObject we have a referenced to is deleted, remove the
1477/// reference.
1478
1480{
1481 if (obj && obj->InheritsFrom(RooAbsArg::Class())) remove(*static_cast<RooAbsArg*>(obj),false,false);
1482}
1483
1484////////////////////////////////////////////////////////////////////////////////
1485/// Sort collection using std::sort and name comparison
1486
1487void RooAbsCollection::sort(bool reverse) {
1488 //Windows seems to need an implementation where two different std::sorts are written
1489 //down in two different blocks. Switching between the two comparators using a ternary
1490 //operator does not compile on windows, although the signature is identical.
1491 if (reverse) {
1492 const auto cmpReverse = [](const RooAbsArg * l, const RooAbsArg * r) {
1493 return strcmp(l->GetName(), r->GetName()) > 0;
1494 };
1495
1496 std::sort(_list.begin(), _list.end(), cmpReverse);
1497 }
1498 else {
1499 const auto cmp = [](const RooAbsArg * l, const RooAbsArg * r) {
1500 return strcmp(l->GetName(), r->GetName()) < 0;
1501 };
1502
1503 std::sort(_list.begin(), _list.end(), cmp);
1504 }
1505}
1506
1507////////////////////////////////////////////////////////////////////////////////
1508/// Sort collection topologically: the servers of any RooAbsArg will be before
1509/// that RooAbsArg in the collection.
1510
1512 std::unordered_set<TNamed const *> seenArgs;
1513 for (std::size_t iArg = 0; iArg < _list.size(); ++iArg) {
1514 RooAbsArg *arg = _list[iArg];
1515 bool movedArg = false;
1516 for (RooAbsArg *server : arg->servers()) {
1517 if (seenArgs.find(server->namePtr()) == seenArgs.end()) {
1518 auto found = std::find_if(_list.begin(), _list.end(),
1519 [server](RooAbsArg *elem) { return elem->namePtr() == server->namePtr(); });
1520 if (found != _list.end()) {
1521 _list.erase(found);
1522 _list.insert(_list.begin() + iArg, server);
1523 movedArg = true;
1524 break;
1525 }
1526 }
1527 }
1528 if (movedArg) {
1529 --iArg;
1530 continue;
1531 }
1532 seenArgs.insert(arg->namePtr());
1533 }
1534}
1535
1536////////////////////////////////////////////////////////////////////////////////
1537/// Factory for legacy iterators.
1538
1539std::unique_ptr<RooAbsCollection::LegacyIterator_t> RooAbsCollection::makeLegacyIterator (bool forward) const {
1540 if (!forward) {
1541 ccoutE(DataHandling) << "The legacy RooFit collection iterators don't support reverse iterations, any more. "
1542 << "Use begin() and end()" << std::endl;
1543 }
1544 return std::make_unique<LegacyIterator_t>(_list);
1545}
1546
1547
1548////////////////////////////////////////////////////////////////////////////////
1549/// Insert an element into the owned collections.
1551 _list.push_back(item);
1552
1553 if (_allRRV && dynamic_cast<const RooRealVar*>(item)==nullptr) {
1554 _allRRV= false;
1555 }
1556
1557 if (_hashAssistedFind) {
1558 _hashAssistedFind->insert(item);
1559 }
1560}
1561
1562
1563////////////////////////////////////////////////////////////////////////////////
1564/// \param[in] flag Switch hash map on or off.
1566 if (flag && !_hashAssistedFind) _hashAssistedFind = std::make_unique<HashAssistedFind>(_list.begin(), _list.end());
1567 if (!flag) _hashAssistedFind = nullptr;
1568}
1569
1570
1571////////////////////////////////////////////////////////////////////////////////
1572/// Check that all entries where the collections overlap have the same name.
1574 for (unsigned int i=0; i < std::min(_list.size(), other.size()); ++i) {
1575 if (_list[i]->namePtr() != other._list[i]->namePtr())
1576 return false;
1577 }
1578
1579 return true;
1580}
1581
1583{
1584 std::string typeName = klass->GetName();
1585 std::stringstream msg;
1586 msg << "RooAbsCollection::addTyped<" << typeName << ">() ERROR: component " << arg->GetName() << " is not of type "
1587 << typeName;
1588 oocoutE(nullptr, InputArguments) << msg.str() << std::endl;
1589 throw std::invalid_argument(msg.str());
1590}
static Roo_reg_AGKInteg1D instance
#define ccoutE(a)
#define cxcoutD(a)
#define coutW(a)
#define oocoutE(o, a)
#define coutE(a)
int Int_t
Definition RtypesCore.h:45
char Text_t
Definition RtypesCore.h:62
const char Option_t
Definition RtypesCore.h:66
#define ClassImp(name)
Definition Rtypes.h:377
static void indent(ostringstream &buf, int indent_level)
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t sel
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t r
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t result
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t UChar_t len
char name[80]
Definition TGX11.cxx:110
Common abstract base class for objects that represent a value and a "shape" in RooFit.
Definition RooAbsArg.h:77
TIterator Use servers() and begin()
virtual void copyCache(const RooAbsArg *source, bool valueOnly=false, bool setValDirty=true)=0
const TNamed * namePtr() const
De-duplicated pointer to this object's name.
Definition RooAbsArg.h:561
virtual void syncCache(const RooArgSet *nset=nullptr)=0
TObject * Clone(const char *newname=nullptr) const override
Make a clone of an object using the Streamer facility.
Definition RooAbsArg.h:89
Abstract base class for objects that represent a discrete value that can be set from the outside,...
virtual bool setIndex(value_type index, bool printError=true)=0
Change category state by specifying the index code of the desired state.
virtual bool setLabel(const char *label, bool printError=true)=0
Change category state by specifying a state name.
A space to attach TBranches.
virtual const char * getCurrentLabel() const
Return label string of current state.
Abstract container object that can hold multiple RooAbsArg objects.
RooAbsCollection * selectByAttrib(const char *name, bool value) const
Create a subset of the current collection, consisting only of those elements with the specified attri...
bool equals(const RooAbsCollection &otherColl) const
Check if this and other collection have identically-named contents.
std::unique_ptr< HashAssistedFind > _hashAssistedFind
!
double getRealValue(const char *name, double defVal=0.0, bool verbose=false) const
Get value of a RooAbsReal stored in set with given name.
virtual void removeAll()
Remove all arguments from our set, deleting them if we own them.
void deleteList()
Delete contents of the list.
Int_t getCatIndex(const char *name, Int_t defVal=0, bool verbose=false) const
Get index value of a RooAbsCategory stored in set with given name.
virtual bool remove(const RooAbsArg &var, bool silent=false, bool matchByNameOnly=false)
Remove the specified argument from our list.
RooAbsCollection & assignValueOnly(const RooAbsCollection &other, bool forceIfSizeOne=false)
Sets the value of any argument in our set that also appears in the other set.
virtual TObject * create(const char *newname) const =0
Int_t defaultPrintContents(Option_t *opt) const override
Define default RooPrinable print options for given Print() flag string For inline printing only show ...
bool allInRange(const char *rangeSpec) const
Return true if all contained object report to have their value inside the specified range.
void assignFast(const RooAbsCollection &other, bool setValDirty=true) const
Functional equivalent of assign() but assumes this and other collection have same layout.
void sortTopologically()
Sort collection topologically: the servers of any RooAbsArg will be before that RooAbsArg in the coll...
const char * getStringValue(const char *name, const char *defVal="", bool verbose=false) const
Get string value of a RooStringVar stored in set with given name.
bool contains(const RooAbsArg &var) const
Check if collection contains an argument with the same name as var.
virtual bool canBeAdded(const RooAbsArg &arg, bool silent) const =0
Determine whether it's possible to add a given RooAbsArg to the collection or not.
RooAbsCollection * snapshot(bool deepCopy=true) const
Take a snap shot of current collection contents.
RooAbsCollection()
Default constructor.
void printValue(std::ostream &os) const override
Print value of collection, i.e.
void printLatex(const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}) const
Output content of collection as LaTex table.
~RooAbsCollection() override
Destructor.
bool setStringValue(const char *name, const char *newVal="", bool verbose=false)
Set string value of a RooStringVar stored in set with given name to newVal.
const char * GetName() const override
Returns name of object.
virtual bool add(const RooAbsArg &var, bool silent=false)
Add the specified argument to list.
void setAttribAll(const Text_t *name, bool value=true)
Set given attribute in each element of the collection by calling each elements setAttribute() functio...
void printTitle(std::ostream &os) const override
Return collection title.
Int_t index(const RooAbsArg *arg) const
Returns index of given arg, or -1 if arg is not in the collection.
bool _allRRV
All contents are RRV.
bool hasSameLayout(const RooAbsCollection &other) const
Check that all entries where the collections overlap have the same name.
void RecursiveRemove(TObject *obj) override
If one of the TObject we have a referenced to is deleted, remove the reference.
void assign(const RooAbsCollection &other) const
Sets the value, cache and constant attribute of any argument in our set that also appears in the othe...
Storage_t::size_type size() const
RooAbsArg * first() const
virtual bool replace(const RooAbsArg &var1, const RooAbsArg &var2)
Replace var1 with var2 and return true for success.
bool setCatIndex(const char *name, Int_t newVal=0, bool verbose=false)
Set index value of a RooAbsCategoryLValue stored in set with given name to newVal.
void clear()
Clear contents. If the collection is owning, it will also delete the contents.
void printMultiline(std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Implement multiline printing of collection, one line for each contained object showing the requested ...
static void throwAddTypedException(TClass *klass, RooAbsArg *arg)
bool setCatLabel(const char *name, const char *newVal="", bool verbose=false)
Set state name of a RooAbsCategoryLValue stored in set with given name to newVal.
virtual bool addOwned(RooAbsArg &var, bool silent=false)
Add an argument and transfer the ownership to the collection.
Storage_t _list
Actual object storage.
RooAbsCollection * selectByName(const char *nameList, bool verbose=false) const
Create a subset of the current collection, consisting only of those elements with names matching the ...
bool setRealValue(const char *name, double newVal=0.0, bool verbose=false)
Set value of a RooAbsRealLValue stored in set with given name to newVal No error messages are printed...
bool _ownCont
Flag to identify a list that owns its contents.
virtual RooAbsArg * addClone(const RooAbsArg &var, bool silent=false)
Add a clone of the specified argument to list.
void printName(std::ostream &os) const override
Return collection name.
void sort(bool reverse=false)
Sort collection using std::sort and name comparison.
std::size_t _sizeThresholdForMapSearch
!
void dump() const
Base contents dumper for debugging purposes.
bool selectCommon(const RooAbsCollection &refColl, RooAbsCollection &outColl) const
Create a subset of the current collection, consisting only of those elements that are contained as we...
const char * getCatLabel(const char *name, const char *defVal="", bool verbose=false) const
Get state name of a RooAbsCategory stored in set with given name.
virtual bool containsInstance(const RooAbsArg &var) const
Check if this exact instance is in this collection.
void useHashMapForFind(bool flag) const
bool isOwning() const
std::string contentsString() const
Return comma separated list of contained object names as STL string.
void printClassName(std::ostream &os) const override
Return collection class name.
void setName(const char *name)
RooAbsCollection & operator=(const RooAbsCollection &other)
Assign values from the elements in other to our elements.
void insert(RooAbsArg *)
Insert an element into the owned collections.
RooAbsArg * find(const char *name) const
Find object with given name in list.
Abstract base class for objects that represent a real value that may appear on the left hand side of ...
virtual void setVal(double value)=0
Set the current value of the object. Needs to be overridden by implementations.
Abstract base class for objects that represent a real value and implements functionality common to al...
Definition RooAbsReal.h:59
double getVal(const RooArgSet *normalisationSet=nullptr) const
Evaluate object.
Definition RooAbsReal.h:103
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition RooArgList.h:22
RooAbsArg * at(Int_t idx) const
Return object at given index, or nullptr if index is out of range.
Definition RooArgList.h:110
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition RooArgSet.h:55
Named container for two doubles, two integers two object points and three string pointers that can be...
Definition RooCmdArg.h:26
void addArg(const RooCmdArg &arg)
Utility function to add nested RooCmdArg to payload of this RooCmdArg.
const char * getString(Int_t idx) const
Return string stored in slot idx.
Definition RooCmdArg.h:95
void setString(Int_t idx, const char *value)
Definition RooCmdArg.h:78
Configurable parser for RooCmdArg named arguments.
void defineMutex(const char *head, Args_t &&... tail)
Define arguments where any pair is mutually exclusive.
bool process(const RooCmdArg &arg)
Process given RooCmdArg.
bool hasProcessed(const char *cmdName) const
Return true if RooCmdArg with name 'cmdName' has been processed.
bool ok(bool verbose) const
Return true of parsing was successful.
bool defineObject(const char *name, const char *argName, int setNum, const TObject *obj=nullptr, bool isArray=false)
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName ...
const char * getString(const char *name, const char *defaultValue="", bool convEmptyToNull=false) const
Return string property registered with name 'name'.
bool defineString(const char *name, const char *argName, int stringNum, const char *defValue="", bool appendMode=false)
Define double property name 'name' mapped to double in slot 'stringNum' in RooCmdArg with name argNam...
const RooLinkedList & getObjectList(const char *name) const
Return list of objects registered with name 'name'.
bool defineInt(const char *name, const char *argName, int intNum, int defValue=0)
Define integer property name 'name' mapped to integer in slot 'intNum' in RooCmdArg with name argName...
int getInt(const char *name, int defaultValue=0) const
Return integer property registered with name 'name'.
Collection class for internal use, storing a collection of RooAbsArg pointers in a doubly linked list...
Int_t GetSize() const
TObject * At(int index) const
Return object stored in sequential position given by index.
void Delete(Option_t *o=nullptr) override
Remove all elements in collection and delete all elements NB: Collection does not own elements,...
virtual void Add(TObject *arg)
TObject * FindObject(const char *name) const override
Return pointer to object with given name.
Registry for const char* names.
Definition RooNameReg.h:26
static const TNamed * known(const char *stringPtr)
If the name is already known, return its TNamed pointer. Otherwise return 0 (don't register the name)...
A 'mix-in' base class that define the standard RooFit plotting and printing methods.
static Int_t _nameLength
static void nameFieldLength(Int_t newLen)
Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to gi...
Variable that can be changed from the outside.
Definition RooRealVar.h:37
TString * format(const RooCmdArg &formatArg) const
Format contents of RooRealVar for pretty printing on RooPlot parameter boxes.
void copyCacheFast(const RooRealVar &other, bool setValDirty=true)
Definition RooRealVar.h:131
A RooAbsArg implementing string values.
void setVal(const char *newVal)
const char * getVal() const
static TClass * Class()
static void create(const TObject *obj)
Register creation of object 'obj'.
Definition RooTrace.cxx:123
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition TClass.h:81
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
const char * GetName() const override
Returns name of object.
Definition TNamed.h:47
static TClass * Class()
Mother of all ROOT objects.
Definition TObject.h:41
virtual const char * GetName() const
Returns name of object.
Definition TObject.cxx:439
virtual const char * ClassName() const
Returns name of class to which the object belongs.
Definition TObject.cxx:207
virtual Bool_t InheritsFrom(const char *classname) const
Returns kTRUE if object inherits from class "classname".
Definition TObject.cxx:525
virtual const char * GetTitle() const
Returns title of object.
Definition TObject.cxx:483
Regular expression class.
Definition TRegexp.h:31
Basic string class.
Definition TString.h:139
int CompareTo(const char *cs, ECaseCompare cmp=kExact) const
Compare a string to char *cs2.
Definition TString.cxx:457
const char * Data() const
Definition TString.h:376
TString & ReplaceAll(const TString &s1, const TString &s2)
Definition TString.h:704
TString & Append(const char *cs)
Definition TString.h:572
Ssiz_t Index(const char *pat, Ssiz_t i=0, ECaseCompare cmp=kExact) const
Definition TString.h:651
RooCmdArg LatexTableStyle(bool flag=true)
The namespace RooFit contains mostly switches that change the behaviour of functions of PDFs (or othe...
Definition JSONIO.h:26
bool snapshotImpl(RooAbsCollection const &input, RooAbsCollection &output, bool deepCopy, RooArgSet const *observables)
Helper for hash-map-assisted finding of elements by name.
RooAbsArg * find(const TNamed *nptr) const
std::unordered_map< const TNamed *, const RooAbsArg *const > nameToItemMap
const std::size_t & currentRooNameRegCounter
void erase(const RooAbsArg *elm)
void replace(const RooAbsArg *out, const RooAbsArg *in)
void insert(const RooAbsArg *elm)
HashAssistedFind(It_t first, It_t last)
Initialise empty hash map for fast finding by name.
TLine l
Definition textangle.C:4
static void output()