dft_tools/doc/reference/gfs/c++/clef.rst

.. highlight:: c

.. _gf_clef:

Interaction with CLEF expressions 
============================================

The gf containers and their view classes can be used with the :doc:`../clef/contents` library: 

* They can be called with CLEF expressions.
* :doc:`Automatic assignment<../clef/assign>` has been set up.

Using the CLEF library offers a quick and efficient way to fill an array with multiple advantages: 

* It is simpler and more readeable than a series of for loops.
* It is more optimal since the loops are automatically written in the best order for memory traversal.

**Example**: 

.. triqs_example:: ./clef_0.cpp
.. note:: 

   The LHS uses () and not brackets, even though it is on the mesh, because of the strange C++ limitation 
   that [] cannot be overloaded for several variables...
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00			`.. highlight:: c`

			`.. _gf_clef:`

			`Interaction with CLEF expressions`
			`============================================`

Restructuring documentation. A first general restructuration of the doc according to the pattern [tour\|tutorial\|reference]. In the reference part, objects are documented per topic. In each topic, [definition\|c++\|python\|hdf5] (not yet implemented) 2014-10-17 18:15:19 +02:00			The gf containers and their view classes can be used with the :doc:`../clef/contents` library:
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00
work on doc for gf, and details. - little details : code cleaning, clang formatting, along with documentation writing for c++ gf. - separated the mesh in small class for better doc. - work on documentation : reorganize specialisation, ... 2013-12-30 22:31:36 +01:00			`* They can be called with CLEF expressions.`
			* :doc:`Automatic assignment<../clef/assign>` has been set up.
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour\|tutorial\|reference]. In the reference part, objects are documented per topic. In each topic, [definition\|c++\|python\|hdf5] (not yet implemented) 2014-10-17 18:15:19 +02:00			`Using the CLEF library offers a quick and efficient way to fill an array with multiple advantages:`
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00
work on doc for gf, and details. - little details : code cleaning, clang formatting, along with documentation writing for c++ gf. - separated the mesh in small class for better doc. - work on documentation : reorganize specialisation, ... 2013-12-30 22:31:36 +01:00			`* It is simpler and more readeable than a series of for loops.`
			`* It is more optimal since the loops are automatically written in the best order for memory traversal.`
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00
Restructuring documentation. A first general restructuration of the doc according to the pattern [tour\|tutorial\|reference]. In the reference part, objects are documented per topic. In each topic, [definition\|c++\|python\|hdf5] (not yet implemented) 2014-10-17 18:15:19 +02:00			`Example:`
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00
doc : split c++ code from rst - examples split from the rst file using a python script (split_code). - Final result for the doc is unchanged. - examples are compiled and tested with the other tests. - examples' code have been clang-formatted, with triqs style. - doc compiles much faster, and with the same options as the rest of the test. - examples are added as tests, so they are run by make test, as simple C tests. - done for the tutorials and the reference. - autocompile removed (changed into triqs_example directive). - add triqs_example : - make a literal include of the source code. - runs the compiled example - add, as before, the result to the source code in the doc. - added the script split_code, used to make the changes automatically, maybe for later reuse. (in _tools) 2014-05-31 19:12:21 +02:00			`.. triqs_example:: ./clef_0.cpp`
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00			`.. note::`

			`The LHS uses () and not brackets, even though it is on the mesh, because of the strange C++ limitation`
More prettification: can not --> cannot 2014-07-08 14:39:16 +02:00			`that [] cannot be overloaded for several variables...`
gf. Clean Fourier - lazy_fourier and co --> fourier - ex fourier --> make_gf_from_fourier to make a new gf - = fourier (g) works only iif lhs is a view, like scalar. - updated python (commented fourier method). 2013-10-23 15:51:51 +02:00