Fix documentation of the tensor part

doc/ublas/tensor.adoc

@@ -292,10 +292,10 @@ elements. If `sizeof...(is)==0`, `tensor::operator[i]` is called.
 |===
 |Member function |Description
 
-|`template<std::size_t I, class ... index_types>  tensor_index operator()(indices::Index<I> p, index_types ... ps)`
-|Returns a link:tensor/tensor_index.html[tensor index] instance with
+|`template<std::size_t I, class ... index_types> decltype(auto) operator()(index::index_type<I> p, index_types ... ps) const`
+|Returns a link:tensor/tensor_index.adoc[tensor index] instance with
 index objects `(p,ps...)` for a tensor contraction where
-`sizeof...(ps)+1` must be equal to `tensor::order()`.
+`sizeof...(ps) + 1` must be equal to `tensor::order()`.
 |===
 
 ===== vi. [#tensor_16]#Iterators#

doc/ublas/tensor/tensor_expression.adoc

@@ -6,7 +6,7 @@
 
 ==== Description
 
-The templated class `tensor_expression<T,E>` is required to be a public
+The templated class `tensor_expression<T, E>` is required to be a public
 base of all classes. There is no Tensor Expression concept defined.
 
 ==== Definition

doc/ublas/tensor/tensor_index.adoc

@@ -2,32 +2,32 @@
 
 [[toc]]
 
-=== [#tensor index]#tensor_index<value_t, storage_t, array_t, N>#
+=== [#tensor index]#Tensor Index#
 
 ==== Description
 
-The template class `tensor_index` decorates the
-link:../tensor.html#tensor[tensor] template class with indices for
+The template class `index_type` decorates the
+link:../tensor.adoc[tensor] template class with indices for
 tensor contraction.
 
 ==== Example
 
 [source, cpp]
 ....
-#include <boost/numeric/ublas/tensor/einstein.hpp>
+#include <boost/numeric/ublas/tensor.hpp>
 
 int main () {
     using namespace boost::numeric::ublas;
-    shape s{4,3,2};
-    for (auto i = 0u; i < s.size(); ++i) {
-        std::cout << s.at(i) << std::endl;
-    }
+    using namespace boost::numeric::ublas::index;
+    tensor<double> A = tensor<double>{4, 3, 2};
+    tensor<double> B = A(_i, _j, _) * A(_, _j, _k);
+    std::cout << B << '\n';
 }
 ....
 
 ==== Definition
 
-Defined in the header tensor/tensor_einstein.hpp.
+Defined in the header tensor/index.hpp.
 
 ==== Public base classes
 
@@ -38,10 +38,7 @@ None.
 [cols=",,",]
 |===
 |Parameter |Description |
-|`value_t` |The type of object stored in the tensor. |
-|`format_t` |Storage organization of the tensor. |
-|`storage_t` |The type of the storage array of the tensor. |
-|`N` |Number of indices provided. |
+|`I` |Integer for einstein summation notation. |
 |===
 
 '''''

include/boost/numeric/ublas/tensor/index.hpp

@@ -21,7 +21,7 @@ namespace boost::numeric::ublas::index {
 
 /** @brief Proxy template class for the einstein summation notation
  *
- * @note index::index_type<K> for 0<=K<=16 is used in tensor::operator()
+ * @note index::index_type<K> for 0<=K<=26 is used in tensor::operator()
  *
  * @tparam I wrapped integer
 */

include/boost/numeric/ublas/tensor/tensor/tensor_dynamic.hpp

@@ -398,7 +398,7 @@ template<class V, class L>
   /** @brief Generates a tensor_core index for tensor_core contraction
      *
      *
-     *  @code auto Ai = A(_i,_j,k); @endcode
+     *  @code auto Ai = A(_i,_j,_k); @endcode
      *
      *  @param i placeholder
      *  @param is zero-based indices where 0 <= is[r] < this->size(r) where  0 < r < this->rank()

include/boost/numeric/ublas/tensor/tensor/tensor_static.hpp

@@ -367,7 +367,7 @@ class tensor_core<detail::engine_tensor_static<V,L,ns...>>
   /** @brief Generates a tensor_core index for tensor_core contraction
      *
      *
-     *  @code auto Ai = A(_i,_j,k); @endcode
+     *  @code auto Ai = A(_i,_j,_k); @endcode
      *
      *  @param i placeholder
      *  @param is zero-based indices where 0 <= is[r] < this->size(r) where  0 < r < this->rank()

include/boost/numeric/ublas/tensor/tensor/tensor_static_rank.hpp

@@ -382,7 +382,7 @@ template<class V, class L, std::size_t N>
   /** @brief Generates a tensor_core index for tensor_core contraction
      *
      *
-     *  @code auto Ai = A(_i,_j,k); @endcode
+     *  @code auto Ai = A(_i,_j,_k); @endcode
      *
      *  @param i placeholder
      *  @param is zero-based indices where 0 <= is[r] < this->size(r) where  0 < r < this->rank()