refPtr.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_REFPTR_H
#define GUM_REFPTR_H
 
#include <new>
 
#include <agrum/agrum.h>
 
namespace gum {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
  template < typename Val >
  class RefPtr;
 
  template < typename Val >
  class HashFunc;
#endif
 
  /* DOXYGEN does not like template functions...
   *
   * @brief Swap the contents of two RefPtr.
   * @tparam Val The type referenced by both gum::RefPtr.
   * @param ptr1 The smart pointer the content of which we swap with that of
   * ptr2.
   * @param ptr2 The smart pointer the content of which we replace with that of
   * ptr1.
   */
  template < typename Val >
  void swap(RefPtr< Val >& ptr1, RefPtr< Val >& ptr2);
 
  // ===========================================================================
  // ===                           SMART POINTERS                            ===
  // ===========================================================================
  template < typename Val >
  class RefPtr {
    public:
    friend void swap<>(RefPtr< Val >&, RefPtr< Val >&);
 
    // ============================================================================
    // ============================================================================

    explicit RefPtr(Val* val = 0);

    RefPtr(const RefPtr< Val >& from);

    template < typename DownVal >
    RefPtr(const RefPtr< DownVal >& from);

    ~RefPtr();

    // ============================================================================
    // ============================================================================

    operator bool() const;

    void clear();

    unsigned int refCount() const;

    // ============================================================================
    // ============================================================================

    RefPtr< Val >& operator=(const RefPtr< Val >& from);

 
    RefPtr< Val >& operator=(Val* from);

    template < typename DownVal >
    RefPtr< Val >& operator=(const RefPtr< DownVal >& from);

    bool operator==(const RefPtr< Val >& from) const;

    bool operator!=(const RefPtr< Val >& from) const;

    Val* operator->() const;

    Val& operator*();

    const Val& operator*() const;

    // ============================================================================
    // ============================================================================
 
    private:
    template < typename T >
    friend class RefPtr;

    template < typename T >
    friend class HashFunc;

    Val* _val_;

    unsigned int* _refcount_;

    void _destroy_(unsigned int*, Val*);

    unsigned int* _refCountPtr_() const;
  };
 
} /* namespace gum */
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< int >;
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< long >;
#    endif
#  endif
#endif
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< double >;
#    endif
#  endif
#endif
 
 
// always include the tpl_.h as it contains only templates
#include <agrum/base/core/refPtr_tpl.h>
 
#endif /* GUM_REFPTR_H */