Skip to content

Commit 4896a94

Browse files
committed
Improve docs introduction
1 parent 88ed635 commit 4896a94

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/src/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
A Julia package for efficient storage and handling of nested arrays. ArraysOfArrays provides two different types of nested arrays: [`ArrayOfSimilarArrays`](@ref section_ArrayOfSimilarArrays) and [`VectorOfArrays`](@ref section_VectorOfArrays).
44

5-
This package also exports the following new functions that are applicable to nested arrays in general:
6-
[`flatview`](@ref), [`nestedview`](@ref), [`innersize`](@ref), [`deepgetindex`](@ref), [`deepsetindex!`](@ref), [`deepview`](@ref), [`deepmap`](@ref) and [`innermap`](@ref).
5+
This package also defines and exports the following new functions applicable to nested arrays in general:
6+
7+
* [`nestedview`](@ref) and [`flatview`](@ref) switch between a flat and a nested view of the same data.
8+
* [`innersize`](@ref) returns the size of the elements of an array, provided they all have equal size.
9+
* [`deepgetindex`](@ref), [`deepsetindex!`](@ref) and [`deepview`](@ref) provide index-based access across multiple layers of nested arrays
10+
* [`innermap`](@ref) and [`deepmap`](@ref) apply a function to the elements of the inner (resp. innermost) arrays.
711

812

913
## [ArrayOfSimilarArrays](@id section_ArrayOfSimilarArrays)

0 commit comments

Comments
 (0)