Skip to content

Commit

Permalink
Closes Bears-R-Us#2978: Strip out ArrayView (Bears-R-Us#3752)
Browse files Browse the repository at this point in the history
Co-authored-by: Amanda Potts <ajpotts@users.noreply.github.com>
  • Loading branch information
ajpotts and ajpotts committed Sep 10, 2024
1 parent 4db3469 commit 95cbb1b
Show file tree
Hide file tree
Showing 6 changed files with 139 additions and 657 deletions.
6 changes: 4 additions & 2 deletions arkouda/numeric.py
Original file line number Diff line number Diff line change
Expand Up @@ -1827,7 +1827,8 @@ def histogram2d(
Returns
-------
hist : ArrayView, shape(nx, ny)
hist : pdarray
shape(nx, ny)
The bi-dimensional histogram of samples x and y.
Values in x are histogrammed along the first dimension and
values in y are histogrammed along the second dimension.
Expand Down Expand Up @@ -1909,7 +1910,8 @@ def histogramdd(
Returns
-------
hist : ArrayView, shape(nx, ny, ..., nd)
hist : pdarray
shape(nx, ny, ..., nd)
The multidimensional histogram of pdarrays in sample.
Values in first pdarray are histogrammed along the first dimension.
Values in second pdarray are histogrammed along the second dimension and so on.
Expand Down
24 changes: 1 addition & 23 deletions pydoc/file_io/HDF5.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ While most objects in Arkouda can be saved, there are 3 main datatypes currently

- pdarray
- Strings
- ArrayView
- DataFrame
- Index
- Categorical
Expand All @@ -37,7 +36,7 @@ All data within the HDF5 file is expected to contain several attributes that aid
`ObjType`: `int`
> Integer representing the type of object stored in the group/dataset. This corresponds to the Chapel `enum ObjType`. Required to properly read each object.
>
- 0 = `ArrayView`
- 0 = `ArrayView` (Deprecated)
- 1 = `pdarray`
- 2 = `Strings`
- 3 = `SegArray`
Expand All @@ -63,27 +62,6 @@ This section provides an outline of the expected data schema for each object typ

When reading array values, the data type of the values is automatically detected and is therefore not required to be included in the metadata.

### ArrayView

`ArrayView` objects require additional attributes to be read properly.

`Rank`: `int`
> Integer representing the number of dimensions in the dataset. This should be stored as the rank of the *unflattened* data, even when storing as a flattened array.
`Shape`: `int array`
>Integer array storing the size of each dimension. The array should be of length equal to the `Rank`.
Providing these attributes allows for the ArrayView object to be reconstructed from its values.

> 1. Dataset (will have a user provided name. Defaults to 'ArrayView')
> 1. Attributes
> 1. ObjType: 0
> 2. isBool: 0 or 1
> 3. Rank: `number_of_dimensions`
> 4. Shape: `array_of_size_rank`
> 5. file_version: 2.0 (Optional)
> 6. arkouda_version: 'current_arkouda_version' (Optional)
> 2. Data - values of the ArrayView.

### pdarray

Expand Down
72 changes: 0 additions & 72 deletions pydoc/usage/arrayview.rst

This file was deleted.

Loading

0 comments on commit 95cbb1b

Please sign in to comment.