From 65bc037b5d7c5ad9811a90fd60ac27094fb6a0eb Mon Sep 17 00:00:00 2001 From: Chia-Sheng Chen Date: Fri, 3 Apr 2020 17:56:08 +0800 Subject: [PATCH] Supplement the document of fn as_ptr --- src/base/matrix.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/base/matrix.rs b/src/base/matrix.rs index 1fb93fea..9004b331 100644 --- a/src/base/matrix.rs +++ b/src/base/matrix.rs @@ -308,6 +308,15 @@ impl> Matrix { /// /// If the matrix is not empty, this pointer is guaranteed to be aligned /// and non-null. + /// + /// # Example + /// ``` + /// # use nalgebra::Matrix2; + /// let m = Matrix2::new(1, 2, + /// 3, 4); + /// let ptr = m.as_ptr(); + /// assert_eq!(unsafe { *ptr }, m[0]); + /// ``` #[inline] pub fn as_ptr(&self) -> *const N { self.data.ptr()