Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_RCPStdSharedPtrConversionsDecl.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
43#define TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
44
45#include "Teuchos_RCPDecl.hpp"
46#include <memory>
47
48
49namespace Teuchos {
50
51
71template<class T>
73{
74public:
76 DeallocStdSharedPtr( const std::shared_ptr<T> &sptr ) : sptr_(sptr) {}
78 typedef T ptr_t;
80 void free( T* ptr_in ) const { sptr_.reset(); }
82 const std::shared_ptr<T>& ptr() const { return sptr_; }
83private:
84 mutable std::shared_ptr<T> sptr_;
85 DeallocStdSharedPtr(); // Not defined and not to be called!
86};
87
88
94template<class T>
96{
97public:
99 StdSharedPtrRCPDeleter( const RCP<T> &rcp ) : rcp_(rcp) {}
101 typedef void result_type;
103 typedef T * argument_type;
105 void operator()(T * x) const { rcp_ = null; }
107 const RCP<T>& ptr() const { return rcp_; }
108private:
109 mutable RCP<T> rcp_;
110 StdSharedPtrRCPDeleter(); // Not defined and not to be called!
111};
112
113
124template<class T>
125RCP<T> rcp( const std::shared_ptr<T> &sptr );
126
127
139template<class T>
140std::shared_ptr<T> get_shared_ptr( const RCP<T> &rcp );
141
142
147template<class T> inline
148bool is_null( const std::shared_ptr<T> &p )
149{
150 return p.get() == 0;
151}
152
153
158template<class T> inline
159bool nonnull( const std::shared_ptr<T> &p )
160{
161 return p.get() != 0;
162}
163
164
165} // namespace Teuchos
166
167
168
169#endif // TEUCHOS_RCP_STD_SHAREDPTR_CONVERSIONS_DECL_HPP
Reference-counted pointer class and non-member templated function implementations.
Teuchos::RCP Deallocator class that wraps a std::shared_ptr
const std::shared_ptr< T > & ptr() const
DeallocStdSharedPtr(const std::shared_ptr< T > &sptr)
Smart reference counting pointer class for automatic garbage collection.
RCP< T > rcp(const std::shared_ptr< T > &sptr)
Conversion function that takes in a std::shared_ptr object and spits out a Teuchos::RCP object.
std::shared_ptr< T > get_shared_ptr(const RCP< T > &rcp)
Conversion function that takes in a Teuchos::RCP object and spits out a std::shared_ptr object.
std::shared_ptr deleter class that wraps a Teuchos::RCP.
bool is_null(const std::shared_ptr< T > &p)
Returns true if p.get()==NULL.
bool nonnull(const std::shared_ptr< T > &p)
Returns true if p.get()!=NULL.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.