From 3ba574bffd9a5e4d184ac8791097ddc0ad3256c6 Mon Sep 17 00:00:00 2001
From: Stefano <stefano.dafarra@gmail.com>
Date: Fri, 20 Dec 2024 11:13:38 +0100
Subject: [PATCH] Added documentation about the slice operation in the README

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 89079ba..c530c2e 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ It can be used for reading and writing binary MATLAB `.mat` files from C++, with
 
 The depencies are [``CMake``](https://cmake.org/) (minimum version 3.10) and [``matio``](https://github.com/tbeu/matio). While we suggest to follow the build instructions provided in the [``matio`` home page](https://github.com/tbeu/matio), it can also installed from common package managers:
 - Linux: ``sudo apt install libmatio-dev``
-- Linux, macOS, Windows, via [``conda-forge``](https://conda-forge.org/): ``mamba install -c conda-forge libmatio``
+- Linux, macOS, Windows, via [``conda-forge``](https://conda-forge.org/): ``conda install -c conda-forge libmatio``
 
 [`Eigen`](https://eigen.tuxfamily.org/index.php) is an optional dependency. If available, some conversions are defined.
 
@@ -153,6 +153,44 @@ Eigen::Vector3i eigenVec;
 eigenVec << 2, 4, 6;                                                            
 auto toMatioEigenVec = matioCpp::make_variable("testEigen", eigenVec);          
 ```
+It is also possible to slice a ``MultiDimensionalArray`` into an Eigen matrix:
+```c++
+std::vector<float> tensor(12);
+for (size_t i = 0; i < 12; ++i)
+{
+    tensor[i] = i + 1.0;
+}
+
+matioCpp::MultiDimensionalArray<float> matioCppMatrix2("matrix", { 2, 2, 3 }, tensor.data());
+
+/*
+So we have a tensor of the type
+| 1  3 | | 5 6 | |  9 11 |
+| 2  4 | | 7 8 | | 10 12 |
+*/
+
+Eigen::MatrixXf slice1 = matioCpp::to_eigen(matioCppMatrix2, { -1, -1, 0 }; //Equivalent to the Matlab operation matioCppMatrix2(:,:,1)
+/* 
+Obtain
+| 1  3 |
+| 2  4 |
+*/
+
+Eigen::MatrixXf slice2 = matioCpp::to_eigen(matioCppMatrix2, { 1, -1, -1 }; //Equivalent to the Matlab operation matioCppMatrix2(2,:,:)
+/*
+Obtain
+| 2 7 10|
+| 4 8 12|
+*/
+
+Eigen::MatrixXf slice3 = matioCpp::to_eigen(matioCppMatrix2, { -1, 0, 0 }; //Equivalent to the Matlab operation matioCppMatrix2(:,1,1)
+/*
+Obtain
+| 1 |
+| 2 |
+*/
+```
+In the slice, the value `-1` means that the entire dimension is taken.
 
 ``matioCpp`` also exploits [``visit_struct``](https://github.com/garbageslam/visit_struct) to parse C++ structs into ``matioCpp`` structs. Example:
 ```c++