/usr/include/trilinos/Teuchos_RCPStdSharedPtrConversionsDecl.hpp is in libtrilinos-teuchos-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
#define TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
#include "Teuchos_RCPDecl.hpp"
#include <memory>
namespace Teuchos {
/** \defgroup Teuchos_RCPStdSharedPtrConversions_grp Conversion utilities for going between Teuchos::RCP and std::shared_ptr.
The smart pointer classes <tt>Teuchos::RCP</tt> and <tt>std::shared_ptr</tt>
are easily compatible. The two templated conversion functions
<tt>Teuchos::rcp( const std::shared_ptr<T> & )</tt> and
<tt>Teuchos::get_shared_ptr( const RCP<T> & )</tt> have been created for
converting back and forth (see the related non-member functions <tt>rcp()</tt>
and <tt>get_shared_ptr()</tt> the <tt>RCP</tt> classes' documentation).
\ingroup teuchos_mem_mng_grp
*/
/** \brief <tt>Teuchos::RCP</tt> Deallocator class that wraps a
* <tt>std::shared_ptr</tt>
*
* \ingroup Teuchos_RCPStdSharedPtrConversions_grp
*/
template<class T>
class DeallocStdSharedPtr
{
public:
/** \brief. */
DeallocStdSharedPtr( const std::shared_ptr<T> &sptr ) : sptr_(sptr) {}
/** \brief. */
typedef T ptr_t;
/** \brief. */
void free( T* ptr_in ) const { sptr_.reset(); }
/** \brief. */
const std::shared_ptr<T>& ptr() const { return sptr_; }
private:
mutable std::shared_ptr<T> sptr_;
DeallocStdSharedPtr(); // Not defined and not to be called!
};
/** \brief <tt>std::shared_ptr</tt> deleter class that wraps a
* <tt>Teuchos::RCP</tt>.
*
* \ingroup Teuchos_RCPStdSharedPtrConversions_grp
*/
template<class T>
class StdSharedPtrRCPDeleter
{
public:
/** \brief. */
StdSharedPtrRCPDeleter( const RCP<T> &rcp ) : rcp_(rcp) {}
/** \brief. */
typedef void result_type;
/** \brief. */
typedef T * argument_type;
/** \brief. */
void operator()(T * x) const { rcp_ = null; }
/** \brief. */
const RCP<T>& ptr() const { return rcp_; }
private:
mutable RCP<T> rcp_;
StdSharedPtrRCPDeleter(); // Not defined and not to be called!
};
/** \brief Conversion function that takes in a <tt>std::shared_ptr</tt>
* object and spits out a <tt>Teuchos::RCP</tt> object.
*
* If the input <tt>std::shared_ptr</tt> already wraps a <tt>Teuchos::RCP</tt>
* object, then that <tt>Teuchos::RCP</tt> object will be copied and returned.
*
* This function is not complicated, just look at its defintion below.
*
* \relates RCP
*/
template<class T>
RCP<T> rcp( const std::shared_ptr<T> &sptr );
/** \brief Conversion function that takes in a <tt>Teuchos::RCP</tt>
* object and spits out a <tt>std::shared_ptr</tt> object.
*
* If the input <tt>Teuchos::RCP</tt> already wraps a
* <tt>std::shared_ptr</tt> object, then that <tt>std::shared_ptr</tt>
* object will be copied and returned.
*
* This function is not complicated, just look at its defintion below.
*
* \relates RCP
*/
template<class T>
std::shared_ptr<T> get_shared_ptr( const RCP<T> &rcp );
/** \brief Returns true if <tt>p.get()==NULL</tt>.
*
* \ingroup Teuchos_RCPStdSharedPtrConversions_grp
*/
template<class T> inline
bool is_null( const std::shared_ptr<T> &p )
{
return p.get() == 0;
}
/** \brief Returns true if <tt>p.get()!=NULL</tt>.
*
* \ingroup Teuchos_RCPStdSharedPtrConversions_grp
*/
template<class T> inline
bool nonnull( const std::shared_ptr<T> &p )
{
return p.get() != 0;
}
} // namespace Teuchos
#endif // TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
|