feat: add contains() method to check if index is within array bounds · rust-ndarray/ndarray@424f759 · GitHub

rust-ndarray / ndarray Public

• Notifications You must be signed in to change notification settings
• Fork 390
• Star 4.3k

• Code
• Issues 177
• Pull requests 41
• Discussions
• Actions
• Projects
• Wiki
• Security and quality
• Insights

Additional navigation options

Commit 424f759

Browse filesBrowse the repository at this point in the historyBrowse files

Shankmukh Kiran Sagar

authored and

Shanmukh kiran Sagar

committed

feat: add contains() method to check if index is within array bounds

1 parent 0612fb7 commit 424f759
Copy full SHA for 424f759

1 file changed

+18Lines changed: 18 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• src
  • impl_methods.rs

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎src/impl_methods.rs‎

Copy file name to clipboardExpand all lines: src/impl_methods.rs

+18Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -823,6 +823,24 @@ impl<A, D: Dimension> ArrayRef<A, D>
823	823	{
824	824	unsafe { self.get_ptr(index).map(|ptr| &*ptr) }
825	825	}
	826	+
	827	+ /// Return `true` if the index is within the array bounds.
	828	+ ///
	829	+ /// ```
	830	+ /// use ndarray::arr2;
	831	+ ///
	832	+ /// let a = arr2(&[[1., 2.],
	833	+ /// [3., 4.]]);
	834	+ ///
	835	+ /// assert!(a.contains((0, 1)));
	836	+ /// assert!(!a.contains((2, 0)));
	837	+ /// assert!(!a.contains((0, 2)));
	838	+ /// ```
	839	+ pub fn contains<I>(&self, index: I) -> bool
	840	+ where I: NdIndex<D>
	841	+ {
	842	+ index.index_checked(self._dim(), self._strides()).is_some()
	843	+ }
826	844	}
827	845
828	846	impl<A, D: Dimension> RawRef<A, D>

0 commit comments

Comments

0 (0)