123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- ++++++++++++++++++++++++++++++++++
- |Boost| Pointer Container Library
- ++++++++++++++++++++++++++++++++++
-
- .. |Boost| image:: boost.png
- Class ``ptr_deque``
- --------------------
- A ``ptr_deque<T>`` is a pointer container that uses an underlying ``std:deque<void*>``
- to store the pointers.
- **Hierarchy:**
- - `reversible_ptr_container <reversible_ptr_container.html>`_
- - `ptr_sequence_adapter <ptr_sequence_adapter.html>`_
- - `ptr_vector <ptr_vector.html>`_
- - `ptr_list <ptr_list.html>`_
- - ``ptr_deque``
- - `ptr_array <ptr_array.html>`_
- **Navigate:**
- - `home <ptr_container.html>`_
- - `reference <reference.html>`_
- **Synopsis:**
- .. parsed-literal::
-
- namespace boost
- {
-
- template
- <
- class T,
- class CloneAllocator = heap_clone_allocator
- class Allocator = std::allocator<void*>
- >
- class ptr_deque : public ptr_sequence_adapter
- <
- T,
- std::deque<void*,Allocator>,
- CloneAllocator
- >
- {
- public: // `element access`_
- T& operator[]( size_type n );
- const T& operator[]( size_type n ) const;
- T& at( size_type n );
- const T& at( size_type n ) const;
-
- public: // modifiers_
- void push_front( T* x );
- template< class U >
- void push_front( compatible-smart-ptr<U> x );
- auto_type pop_front();
- public: // `pointer container requirements`_
- auto_type replace( size_type idx, T* x );
- template< class U >
- auto_type replace( size_type idx, compatible-smart-ptr<U> x );
- bool is_null( size_type idx ) const;
-
- };
- } // namespace 'boost'
- .. _`reversible_ptr_container`: reversible_ptr_container.html
- .. _`ptr_sequence_adapter`: ptr_sequence_adapter.html
- Semantics
- ---------
- .. _modifiers:
-
- Semantics: modifiers
- ^^^^^^^^^^^^^^^^^^^^
- - ``void push_front( T* x );``
- - Requirements: ``x != 0``
- - Effects: Inserts the pointer into container and takes ownership of it
-
- - Throws: ``bad_pointer`` if ``x == 0``
- - Exception safety: Strong guarantee
- - ``template< class U > void push_front( compatible-smart-ptr<U> x );``
- - Effects: ``push_front( x.release() );``
- ..
- - ``void push_front( const T& x );``
-
- - Effects: push_front( allocate_clone( x ) );
-
- - Exception safety: Strong guarantee
- - ``auto_type pop_front():``
- - Requirements:``not empty()``
-
- - Effects: Removes the first element in the container
- - Postconditions: ``size()`` is one less
- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``
-
- - Exception safety: Strong guarantee
- .. _`element access`:
- Semantics: element access
- ^^^^^^^^^^^^^^^^^^^^^^^^^
- - ``T& operator[]( size_type n );``
- - ``const T& operator[]( size_type n ) const;``
- - Requirements: ``n < size()``
- - Effects: Returns a reference to the ``n``'th element
- - Throws: Nothing
- - ``T& at( size_type n );``
- - ``const T& at( size_type n ) const;``
- - Requirements: ``n < size()``
- - Effects: Returns a reference to the ``n``'th element
- - Throws: ``bad_index`` if ``n >=size()``
- .. _`pointer container requirements`:
- Semantics: pointer container requirements
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- - ``auto_type replace( size_type idx, T* x );``
- - Requirements: `` x != 0 and idx < size()``
- - Effects: returns the object indexed by ``idx`` and replaces it with ``x``.
- - Throws: ``bad_index`` if ``idx >= size()`` and ``bad_pointer`` if ``x == 0``.
- - Exception safety: Strong guarantee
-
- - ``template< class U > auto_type replace( size_type idx, compatible-smart-ptr<U> x );``
- - Effects: ``return replace( idx, x.release() );``
- - ``bool is_null( size_type idx ) const;``
- - Requirements: ``idx < size()``
- - Effects: returns whether the pointer at index ``idx`` is null
- - Exception safety: Nothrow guarantee
- .. raw:: html
- <hr>
- :Copyright: Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see LICENSE_1_0.txt__).
- __ http://www.boost.org/LICENSE_1_0.txt
|