3
0
mirror of https://github.com/triqs/dft_tools synced 2024-11-01 19:53:45 +01:00
dft_tools/doc/reference/c++/arrays/containers/swap.rst

41 lines
978 B
ReStructuredText
Raw Normal View History

2013-08-22 16:55:51 +02:00
swap & deep_swap
==================================
2013-08-22 16:55:51 +02:00
There are two possible interpretation of "swapping two arrays" :
either use 3 moves like std::swap, i.e. swapping the pointer to the data in memory,
or making a deep swap, i.e. really swapping all the elements in memeory.
2013-08-22 16:55:51 +02:00
.. _arr_swap:
2013-08-22 16:55:51 +02:00
swap
--------
* swap just exchange the (shared) pointer to the data in memory,
it does not affect the data them self.
This distinction of importance for views in particular.
2013-08-22 16:55:51 +02:00
* For the regular type, std::swap and swap are equivalent.
For the views, std::swap is explicitely deleted, since it is incorrect
due to the lack of move constructor for a view.
Use `swap` instead.
* **Example** :
.. triqs_example:: ./swap_0.cpp
2013-08-22 16:55:51 +02:00
.. _arr_deep_swap:
deep_swap
--------------
2013-08-22 16:55:51 +02:00
.. warning::
Currently implemented only for triqs::vector and triqs::vector_view.
* deep_swap swaps the data in memory.
* **Example** (compare with swap) :
.. triqs_example:: ./swap_1.cpp