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

.. highlight:: c

.. _gf_legendre: 

Legendre representation
==========================================================

This is a specialisation of :ref:`gf<gf_and_view>` for Legendre polynomial expansion.

Synopsis
------------

.. code::

  gf<legendre, Target, Opt>

The *Target* template parameter can take the following values: 
 
+-------------------------+-----------------------------------------------------+
| Target                  | Meaning                                             |
+=========================+=====================================================+
| scalar_valued           | The function is scalar valued (double, complex...). |
+-------------------------+-----------------------------------------------------+
| matrix_valued [default] | The function is matrix valued.                      |
+-------------------------+-----------------------------------------------------+

Domain & mesh
----------------

TO BE WRITTEN

Singularity
-------------

None


Evaluation method
---------------------

TO BE WRITTEN

Data storage
---------------

TO BE WRITTEN

HDF5 storage convention
---------------------------

h5 tag: `Legendre`

Examples
---------

.. triqs_example:: ./gf_legendre_0.cpp
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			`.. highlight:: c`

			`.. _gf_legendre:`

			`Legendre representation`
			`==========================================================`

			This is a specialisation of :ref:`gf<gf_and_view>` for Legendre polynomial expansion.

			`Synopsis`
			`------------`

			`.. code::`

			`gf<legendre, Target, Opt>`

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 Target template parameter can take the following values:`
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
			`+-------------------------+-----------------------------------------------------+`
			`\| Target \| Meaning \|`
			`+=========================+=====================================================+`
			`\| scalar_valued \| The function is scalar valued (double, complex...). \|`
			`+-------------------------+-----------------------------------------------------+`
			`\| matrix_valued [default] \| The function is matrix valued. \|`
			`+-------------------------+-----------------------------------------------------+`

			`Domain & mesh`
			`----------------`

			`TO BE WRITTEN`

			`Singularity`
			`-------------`

			`None`


			`Evaluation method`
			`---------------------`

			`TO BE WRITTEN`

			`Data storage`
			`---------------`

			`TO BE WRITTEN`

			`HDF5 storage convention`
			`---------------------------`

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			h5 tag: `Legendre`
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
			`Examples`
			`---------`

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:: ./gf_legendre_0.cpp`