From b996a6f0ce3de25ab41b1621fc1ebf67d2668fa4 Mon Sep 17 00:00:00 2001
From: Chia-Sheng Chen <chiache@microsoft.com>
Date: Fri, 3 Apr 2020 17:39:49 +0800
Subject: [PATCH] Supplement the document of fn vector_to_matrix_index

---
 src/base/matrix.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/base/matrix.rs b/src/base/matrix.rs
index b1e0653c..1fb93fea 100644
--- a/src/base/matrix.rs
+++ b/src/base/matrix.rs
@@ -279,6 +279,16 @@ impl<N: Scalar, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
 
     /// Computes the row and column coordinates of the i-th element of this matrix seen as a
     /// vector.
+    ///
+    /// # Example
+    /// ```
+    /// # use nalgebra::Matrix2;
+    /// let m = Matrix2::new(1, 2,
+    ///                      3, 4);
+    /// let i = m.vector_to_matrix_index(3);
+    /// assert_eq!(i, (1, 1));
+    /// assert_eq!(m[i], m[3]);
+    /// ```
     #[inline]
     pub fn vector_to_matrix_index(&self, i: usize) -> (usize, usize) {
         let (nrows, ncols) = self.shape();