Skip to content

Better shape: Deprecate reshape, into_shape #1310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bluss merged 10 commits into from
Mar 10, 2024
Merged

Better shape: Deprecate reshape, into_shape #1310

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fa9fb4a
shape: Deprecate .reshape()
bluss Jan 15, 2021
0504347
shape: Remove usages of deprecated .reshape()
bluss May 4, 2021
7d61342
shape: Add .into_shape_clone()
bluss May 6, 2021
3f02ac2
shape: Convert format tests to use into_shape_clone
bluss May 6, 2021
8501d7b
shape: Deprecate into_shape, add into_shape_with_order
bluss Jul 25, 2023
e16dc45
shape: Use into_shape_with_order, not into_shape
bluss Aug 3, 2023
49f5870
shape: Replace reshape with into_shape_with_order in tests
bluss Mar 9, 2024
a5a4b98
shape: More explicit examples for to_shape and into_shape
bluss Mar 9, 2024
ee7f435
shape: Add test for into_shape_clone
bluss Mar 9, 2024
d32248d
Apply examples changes from code review
bluss Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply examples changes from code review 
Co-authored-by: Adam Reichold <[email protected]>
  • Loading branch information
@bluss @adamreichold
bluss and adamreichold authored Mar 10, 2024
commit d32248df363590190452a1c70491bca357ae772b
3 changes: 1 addition & 2 deletions README-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,7 @@ row: [[100, 101, 102],
## Shape Manipulation

### Changing the shape of an array
The shape of an array can be changed with `into_shape_with_order` method.
(One can also use `to_shape` for this.)
The shape of an array can be changed with the `into_shape_with_order` or `to_shape` method.

````rust
use ndarray::prelude::*;
Expand Down
5 changes: 2 additions & 3 deletions src/impl_methods.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1978,7 +1978,7 @@ where
/// elements is accepted, but the source array or view must be in standard
/// or column-major (Fortran) layout.
///
/// **Note** that `.into_shape_with_order()` "moves" elements differently depending on if the input array
/// **Note** that `.into_shape()` "moves" elements differently depending on if the input array
/// is C-contig or F-contig, it follows the index order that corresponds to the memory order.
/// Prefer to use `.to_shape()` or `.into_shape_with_order()`.
///
Expand All @@ -1992,7 +1992,7 @@ where
/// use ndarray::{aview1, aview2};
///
/// assert!(
/// aview1(&[1., 2., 3., 4.]).into_shape_with_order((2, 2)).unwrap()
/// aview1(&[1., 2., 3., 4.]).into_shape((2, 2)).unwrap()
/// == aview2(&[[1., 2.],
/// [3., 4.]])
/// );
Expand Down Expand Up @@ -2117,7 +2117,6 @@ where
A: Clone,
E: IntoDimension,
{
//return self.clone().into_shape_clone(shape).unwrap();
let shape = shape.into_dimension();
if size_of_shape_checked(&shape) != Ok(self.dim.size()) {
panic!(
Expand Down