smallObjectAllocator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_SMALL_OBJECT_ALLOCATOR_H
#define GUM_SMALL_OBJECT_ALLOCATOR_H
 
// ============================================================================
#include <agrum/agrum.h>
// ============================================================================
#include <agrum/base/core/hashTable.h>
#include <agrum/base/core/smallobjectallocator/fixedAllocator.h>
 
// ============================================================================
 
 
namespace gum {
  class GUM_SHARED_PUBLIC SmallObjectAllocator {
    public:
    static const size_t GUM_DEFAULT_CHUNK_SIZE;

    static const size_t GUM_DEFAULT_MAX_OBJECT_SIZE;
 
 
    // ############################################################################
    // ############################################################################
 
    private:
    // ============================================================================
    // ============================================================================
    SmallObjectAllocator();
 
    // ============================================================================
    // ============================================================================
    SmallObjectAllocator(const SmallObjectAllocator&) = delete;
 
    // ============================================================================
    // ============================================================================
    SmallObjectAllocator& operator=(const SmallObjectAllocator&);
 
    public:
    // ============================================================================
    // ============================================================================
    virtual ~SmallObjectAllocator();

 
    static SmallObjectAllocator& instance();
 
    // ############################################################################
    // ############################################################################
    // ============================================================================
    // ============================================================================
    void* allocate(const size_t& objectSize);
 
    // ============================================================================
    // ============================================================================
    void deallocate(void* pDeallocatedObject, const size_t& objectSize);

 
    // ============================================================================
    // ============================================================================
    void displayStats();
 
    Idx nbAlloc();
 
    Idx nbDealloc();
 
    private:
    // ============================================================================
    // ============================================================================
    using _Pool_ = HashTable< Size, FixedAllocator* >;
 
    _Pool_ _pool_;
 
    // ============================================================================
    // ============================================================================
    std::size_t _chunkSize_;
 
    // ============================================================================
    // ============================================================================
    std::size_t _maxObjectSize_;
 
    // protects the critical sections
    std::mutex _mutex_;
 
    Idx nbAllocation;
    Idx nbDeallocation;
  };
}   // namespace gum
 
// Macro used to shorten code in classes using SmallObjectAllocator
#define SOA_ALLOCATE(x)      SmallObjectAllocator::instance().allocate(x)
#define SOA_DEALLOCATE(x, y) SmallObjectAllocator::instance().deallocate(x, y)
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/core/smallobjectallocator/smallObjectAllocator_inl.h>
#endif
 
#endif   // GUM_SMALL_OBJECT_ALLOCATOR_H