Teuchos_ArrayRCPDecl.hpp

// @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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_ARRAY_RCP_DECL_HPP
#define TEUCHOS_ARRAY_RCP_DECL_HPP

#include "Teuchos_RCP.hpp"

namespace Teuchos {

template<class T>
class ArrayRCP {
public:



  typedef T element_type;
  typedef Teuchos_Index Ordinal;
#ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK

  typedef ArrayRCP<T> iterator;
#else
  typedef T* iterator;
#endif
#ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK

  typedef ArrayRCP<T> const_iterator;
#else
  typedef T* const_iterator;
#endif




  ArrayRCP( ENull null_arg = null );

  ArrayRCP(const ArrayRCP<T>& r_ptr);

  ~ArrayRCP();

  ArrayRCP<T>& operator=(const ArrayRCP<T>& r_ptr);




  T* operator->() const;

  T& operator*() const;

  T* get() const;

  T& operator[](Ordinal offset) const;




  ArrayRCP<T>& operator++();

  ArrayRCP<T> operator++(int);

  ArrayRCP<T>& operator--();

  ArrayRCP<T> operator--(int);

  ArrayRCP<T>& operator+=(Ordinal offset);

  ArrayRCP<T>& operator-=(Ordinal offset);

  ArrayRCP<T> operator+(Ordinal offset) const;

  ArrayRCP<T> operator-(Ordinal offset) const;




  ArrayRCP<const T> getConst() const;

  ArrayRCP<T> subview( Ordinal lowerOffset, Ordinal size ) const;




  int count() const;

  template<class T2>
  bool shares_resource(const ArrayRCP<T2>& r_ptr) const;

  Ordinal lowerOffset() const;

  Ordinal upperOffset() const;

  Ordinal size() const;




  const_iterator begin() const;

  const_iterator end() const;




  T* release();

  void set_has_ownership();

  bool has_ownership() const;




  const ArrayRCP<T>& assert_not_null() const;

  const ArrayRCP<T>& assert_in_range( Ordinal lowerOffset, Ordinal size ) const;


public: // Bad bad bad

  // //////////////////////////////////////
  // Private types

  typedef PrivateUtilityPack::RCP_node node_t;

private:

  // //////////////////////////////////////////////////////////////
  // Private data members

  T       *ptr_;  // NULL if this pointer is null
  node_t  *node_; // NULL if this pointer is null
  Ordinal lowerOffset_;
  Ordinal upperOffset_;

public:
#ifndef DOXYGEN_COMPILE
  // These constructors should be private but I have not had good luck making
  // this portable (i.e. using friendship etc.) in the past
  ArrayRCP( T* p, Ordinal lowerOffset, Ordinal upperOffset, bool has_ownership );
  template<class Dealloc_T>
  ArrayRCP( T* p, Ordinal lowerOffset, Ordinal upperOffset, Dealloc_T dealloc, bool has_ownership );
  // This is a very bad breach of encapsulation that is needed since MS VC++ 5.0 will
  // not allow me to declare template functions as friends.
  ArrayRCP( T* p, Ordinal lowerOffset, Ordinal upperOffset, node_t* node);
  T*&           access_ptr();
  T*            access_ptr() const; // No preconditions
  node_t*&      access_node();
  node_t*       access_node() const;
#endif

};  // end class ArrayRCP<...>

template<typename T>
class TypeNameTraits<ArrayRCP<T> > {
public:
  static std::string name() { return "ArrayRCP<"+TypeNameTraits<T>::name()+">"; }
};

template<class T>
ArrayRCP<T> arcp(
  T* p, typename ArrayRCP<T>::Ordinal lowerOffset
  ,typename ArrayRCP<T>::Ordinal size
  , bool owns_mem = true
  );

template<class T, class Dealloc_T>
ArrayRCP<T> arcp(
  T* p, typename ArrayRCP<T>::Ordinal lowerOffset
  ,typename ArrayRCP<T>::Ordinal size
  , Dealloc_T dealloc, bool owns_mem
  );
 
template<class T>
ArrayRCP<T> arcp( typename ArrayRCP<T>::Ordinal size );

template<class T>
ArrayRCP<T> arcp( const RCP<std::vector<T> > &v );

template<class T>
ArrayRCP<const T> arcp( const RCP<const std::vector<T> > &v );

template<class T>
RCP<std::vector<T> > get_std_vector( const ArrayRCP<T> &ptr );

template<class T>
RCP<const std::vector<T> > get_std_vector( const ArrayRCP<const T> &ptr );

template<class T>
bool is_null( const ArrayRCP<T> &p );

template<class T>
bool operator==( const ArrayRCP<T> &p, ENull );

template<class T>
bool operator!=( const ArrayRCP<T> &p, ENull );

template<class T1, class T2>
bool operator==( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T1, class T2>
bool operator!=( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T1, class T2>
bool operator<( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T1, class T2>
bool operator<=( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T1, class T2>
bool operator>( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T1, class T2>
bool operator>=( const ArrayRCP<T1> &p1, const ArrayRCP<T2> &p2 );

template<class T2, class T1>
ArrayRCP<T2> arcp_reinterpret_cast(const ArrayRCP<T1>& p1);

template<class T2, class T1>
ArrayRCP<T2> arcp_implicit_cast(const ArrayRCP<T1>& p1);

template<class T1, class T2>
void set_extra_data( const T1 &extra_data, const std::string& name, ArrayRCP<T2> *p
                     ,EPrePostDestruction destroy_when
#ifndef __sun
                     = POST_DESTROY
#endif
                     ,bool force_unique
#ifndef __sun
                     = true
#endif
  );
#ifdef __sun
template<class T1, class T2>
inline void set_extra_data( const T1 &extra_data, const std::string& name, ArrayRCP<T2> *p )
{ set_extra_data( extra_data, name, p, POST_DESTROY, true ); }
template<class T1, class T2>
inline void set_extra_data( const T1 &extra_data, const std::string& name, ArrayRCP<T2> *p, EPrePostDestruction destroy_when )
{ set_extra_data( extra_data, name, p, destroy_when, true ); }
#endif

template<class T1, class T2>
T1& get_extra_data( ArrayRCP<T2>& p, const std::string& name );

template<class T1, class T2>
const T1& get_extra_data( const ArrayRCP<T2>& p, const std::string& name );

template<class T1, class T2>
T1* get_optional_extra_data( ArrayRCP<T2>& p, const std::string& name );

template<class T1, class T2>
const T1* get_optional_extra_data( const ArrayRCP<T2>& p, const std::string& name );

template<class Dealloc_T, class T>
Dealloc_T& get_dealloc( ArrayRCP<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T& get_dealloc( const ArrayRCP<T>& p );

template<class Dealloc_T, class T>
Dealloc_T* get_optional_dealloc( ArrayRCP<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T* get_optional_dealloc( const ArrayRCP<T>& p );

template<class T>
std::ostream& operator<<( std::ostream& out, const ArrayRCP<T>& p );

} // end namespace Teuchos

#endif  // TEUCHOS_ARRAY_RCP_DECL_HPP

---