Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
std::auto_ptr(3)	      C++ Standard Libary	      std::auto_ptr(3)

NAME
       std::auto_ptr - std::auto_ptr

Synopsis
	  Defined in header <memory>
	  template< class T > class auto_ptr; (1) (deprecated in C++11)
						  (removed in C++17)
	  template<> class auto_ptr<void>;    (2) (deprecated in C++11)
						  (removed in C++17)

	  auto_ptr  is a smart pointer that manages an object obtained via new
       expression and
	  deletes that object when auto_ptr itself is  destroyed.  It  may  be
       used to provide
	  exception safety for dynamically allocated objects, for passing own-
       ership of
	  dynamically  allocated  objects into functions and for returning dy-
       namically allocated
	  objects from functions.

	  Copying an auto_ptr copies the pointer and  transfers	 ownership  to
       the destination:
	  both	copy construction and copy assignment of auto_ptr modify their
       right-hand
	  arguments, and the "copy" is not equal to the	original.  Because  of
       these unusual
	  copy semantics, auto_ptr may not be placed in	standard containers.
	  std::unique_ptr is preferred for this	and other uses.
	  (since C++11)

	  2) Specialization for	type void is provided, it declares the typedef
       element_type,
	  but no member	functions.

	  An  additional class template	auto_ptr_ref is	referred to throughout
       the
	  documentation. It is an implementation-defined  type	that  holds  a
       reference to
	  auto_ptr. The	implementation is allowed to provide the template with
       a different
	  name	or implement the functions returning it	or accepting it	as pa-
       rameter in other
	  ways.

Member types
	  Member type  Definition
	  element_type T

Member functions
	  constructor		   creates a new auto_ptr
				   (public member function)
	  destructor		   destroys an auto_ptr	and the	managed	object
				   (public member function)
	  operator=		   transfers ownership from another auto_ptr
				   (public member function)
	  operator auto_ptr<Y>	   converts the	managed	pointer	to  a  pointer
       to different type
	  operator auto_ptr_ref<Y> (public member function)

Observers
	  get			   returns a pointer to	the managed object
				   (public member function)
	  operator*		   accesses the	managed	object
	  operator->		   (public member function)

Modifiers
	  reset			   replaces the	managed	object
				   (public member function)
	  release		   releases ownership of the managed object
				   (public member function)

http://cppreference.com		  2022.07.31		      std::auto_ptr(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::auto_ptr&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help