From 67a1a7c079d104b909a59d58bd0bbb18eb1665c3 Mon Sep 17 00:00:00 2001 From: Laura Messio Date: Wed, 18 Dec 2013 15:50:18 +0100 Subject: [PATCH] doc: cookbooks from det_manip and arrays harmonized --- doc/reference/c++/arrays/contents.rst | 3 +-- doc/reference/c++/det_manip/contents.rst | 2 +- .../c++/det_manip/cookbook/contents.rst | 9 --------- doc/tutorials/c++/array_tutorial.rst | 13 +++++++++---- doc/tutorials/c++/contents.rst | 2 +- .../c++/det_manip_tutorial.rst} | 17 ++++++++++++++++- 6 files changed, 28 insertions(+), 18 deletions(-) delete mode 100644 doc/reference/c++/det_manip/cookbook/contents.rst rename doc/{reference/c++/det_manip/cookbook/basic.rst => tutorials/c++/det_manip_tutorial.rst} (93%) diff --git a/doc/reference/c++/arrays/contents.rst b/doc/reference/c++/arrays/contents.rst index 2fd565b8..1ee2476f 100644 --- a/doc/reference/c++/arrays/contents.rst +++ b/doc/reference/c++/arrays/contents.rst @@ -10,7 +10,6 @@ Multidimensional arrays .. toctree:: :maxdepth: 1 - :numbered: introduction concepts @@ -35,4 +34,4 @@ Multidimensional arrays multithreading FAQ implementation_notes/contents - + ./../../../tutorials/c++/array_tutorial diff --git a/doc/reference/c++/det_manip/contents.rst b/doc/reference/c++/det_manip/contents.rst index 85f9acf0..5075cb50 100644 --- a/doc/reference/c++/det_manip/contents.rst +++ b/doc/reference/c++/det_manip/contents.rst @@ -39,4 +39,4 @@ This class implements these general operations. It contains : det_manip behind - cookbook/contents + ./../../../tutorials/c++/det_manip_tutorial diff --git a/doc/reference/c++/det_manip/cookbook/contents.rst b/doc/reference/c++/det_manip/cookbook/contents.rst deleted file mode 100644 index 4e7d8482..00000000 --- a/doc/reference/c++/det_manip/cookbook/contents.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. highlight:: c - -Det_manip cookbook -=================== - -.. toctree:: - :maxdepth: 2 - - basic diff --git a/doc/tutorials/c++/array_tutorial.rst b/doc/tutorials/c++/array_tutorial.rst index 12f8cd5c..fcc3e91c 100644 --- a/doc/tutorials/c++/array_tutorial.rst +++ b/doc/tutorials/c++/array_tutorial.rst @@ -1,9 +1,14 @@ -Using arrays -=============== +Examples of use of arrays +========================== .. highlight:: c -TRIQS comes with a library of multidimensional arrays. This library, among others, allows for easy slicing, archiving and algebraic manipulations of multidimensional arrays. Here are a couple of simple examples showing the basic use of this class. +.. toctree:: + :maxdepth: 1 + +TRIQS comes with a library of multidimensional arrays. +This library, among others, allows for easy slicing, archiving and algebraic manipulations of multidimensional arrays. +Here are a couple of simple examples showing the basic use of this class. Declaring and printing an array @@ -173,4 +178,4 @@ Map and fold std::cout << "F(2*A) = "<` +The full reference of the array library can be found :doc:`here <../../reference/c++/arrays/contents>` diff --git a/doc/tutorials/c++/contents.rst b/doc/tutorials/c++/contents.rst index debc413c..62823cd9 100644 --- a/doc/tutorials/c++/contents.rst +++ b/doc/tutorials/c++/contents.rst @@ -9,6 +9,6 @@ C++ libraries :maxdepth: 1 array_tutorial - + det_manip_tutorial .. diff --git a/doc/reference/c++/det_manip/cookbook/basic.rst b/doc/tutorials/c++/det_manip_tutorial.rst similarity index 93% rename from doc/reference/c++/det_manip/cookbook/basic.rst rename to doc/tutorials/c++/det_manip_tutorial.rst index 91d41d38..d01b71e1 100644 --- a/doc/reference/c++/det_manip/cookbook/basic.rst +++ b/doc/tutorials/c++/det_manip_tutorial.rst @@ -1,3 +1,18 @@ +Det_manip cookbook +=================== + +.. highlight:: c + +.. toctree:: + :maxdepth: 1 + +TRIQS comes with a class called det_manip to easily perform operations on a special type of matrices +(see :doc:`here <../../reference/c++/det_manip/contents>`). +This library, among others, allows to easily add or remove lines or columns to the matrix, to calculate the determinant and the inverse. +Here are a couple of simple examples showing the basic use of this class. + + + Creation of an empty det_manip class ------------------------------------- @@ -108,7 +123,7 @@ Add a line and a column double x0 = 2.1, y0 = 7; int i = 2, j = 0; // number of the added line and column std::cout<<"We want to add a line and a column for i="<