Skip to content

Commit

Permalink
Update matrix_view.rs documentation
Browse files Browse the repository at this point in the history
Fixed a (presumed) typo in documentation in matrix_view.rs.

Previously it says fixed_view and fixed_slice returns a matrix with `(RView, CView)` consecutive components. As per-input, and after re-reading the documentation and source code. Seems like RView and CView should be used instead of RView::dim() and CViem::dim().
  • Loading branch information
fangs124 committed Apr 23, 2024
1 parent 119d691 commit b7a2ae2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/base/matrix_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -546,17 +546,17 @@ macro_rules! matrix_view_impl (
$me.$generic_view_with_steps(start, shape, steps)
}

/// Slices this matrix starting at its component `(irow, icol)` and with `(RView::dim(),
/// CView::dim())` consecutive components.
/// Slices this matrix starting at its component `(irow, icol)` and with `(RVIEW,CVIEW)`
/// consecutive components.
#[inline]
#[deprecated = slice_deprecation_note!($fixed_view)]
pub fn $fixed_slice<const RVIEW: usize, const CVIEW: usize>($me: $Me, irow: usize, icol: usize)
-> $MatrixView<'_, T, Const<RVIEW>, Const<CVIEW>, S::RStride, S::CStride> {
$me.$fixed_view(irow, icol)
}

/// Return a view of this matrix starting at its component `(irow, icol)` and with `(RView::dim(),
/// CView::dim())` consecutive components.
/// Return a view of this matrix starting at its component `(irow, icol)` and with
/// `(RVIEW,CVIEW)` consecutive components.
#[inline]
pub fn $fixed_view<const RVIEW: usize, const CVIEW: usize>($me: $Me, irow: usize, icol: usize)
-> $MatrixView<'_, T, Const<RVIEW>, Const<CVIEW>, S::RStride, S::CStride> {
Expand Down

0 comments on commit b7a2ae2

Please sign in to comment.