carl::Pool< Element > Class Template Reference
#include <Pool.h>
Inheritance diagram for carl::Pool< Element >:
Collaboration diagram for carl::Pool< Element >:
Public Member Functions | |
| void | print () const |
| std::pair< typename FastPointerSet< Element >::iterator, bool > | insert (ElementPtr _element, bool _assertFreshness=false) |
| Inserts the given element into the pool, if it does not yet occur in there. More... | |
| ConstElementPtr | add (ElementPtr _element) |
| Adds the given element to the pool, if it does not yet occur in there. More... | |
Protected Member Functions | |
| Pool (unsigned _capacity=10000) | |
| Constructor of the pool. More... | |
| ~Pool () | |
| virtual void | assignId (ElementPtr, std::size_t) |
| Assigns a unique id to the generated element. More... | |
Private Types | |
| using | ElementPtr = Element * |
| using | ConstElementPtr = const Element * |
Private Attributes | |
| unsigned | mIdAllocator = 1 |
| id allocator More... | |
| FastPointerSet< Element > | mPool |
| The formula pool. More... | |
| std::mutex | mMutexPool |
| Mutex to avoid multiple access to the pool. More... | |
Detailed Description
Member Typedef Documentation
◆ ConstElementPtr
template<typename Element >
|
private |
◆ ElementPtr
template<typename Element >
|
private |
Constructor & Destructor Documentation
◆ Pool()
template<typename Element >
|
inlineexplicitprotected |
◆ ~Pool()
template<typename Element >
|
inlineprotected |
Member Function Documentation
◆ add()
template<typename Element >
|
inline |
Adds the given element to the pool, if it does not yet occur in there.
Note, that this method uses the allocator which is locked before calling.
- Parameters
-
_element The element to add to the pool.
- Returns
- The given element, if it did not yet occur in the pool; The equivalent element already occurring in the pool, otherwise.
Definition at line 113 of file Pool.h.
Here is the call graph for this function:
◆ assignId()
template<typename Element >
|
inlineprotectedvirtual |
Assigns a unique id to the generated element.
Note that this method serves as a callback for subclasses. The actual assignment of the id is done there.
- Parameters
-
_element The element for which to add the id. _id A unique id.
Reimplemented in carl::BVTermPool, and carl::BVConstraintPool.
Definition at line 67 of file Pool.h.
Here is the caller graph for this function:
◆ insert()
template<typename Element >
|
inline |
Inserts the given element into the pool, if it does not yet occur in there.
- Parameters
-
_element The element to add to the pool. _assertFreshness When true, an assertion fails if the element is not fresh (i.e., if it already occurs in the pool).
- Returns
- The position of the given element in the pool and true, if it did not yet occur in the pool; The position of the equivalent element in the pool and false, otherwise.
Definition at line 89 of file Pool.h.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ print()
template<typename Element >
|
inline |
Field Documentation
◆ mIdAllocator
template<typename Element >
|
private |
◆ mMutexPool
template<typename Element >
|
mutableprivate |
◆ mPool
template<typename Element >
|
private |
The documentation for this class was generated from the following file:
- carl-formula/bitvector/Pool.h
