Skip to content

Commit 6b5c29d

Browse files
committed
Update the docs regarding RingArray
1 parent a3bd8d1 commit 6b5c29d

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/User/Tutorials/performance-considerations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ arrays store data without an additional heap pointer wrapper
107107

108108
* Streamly.Data.Array
109109
* Streamly.Data.MutArray
110-
* Streamly.Internal.Data.Ring
110+
* Streamly.Internal.Data.RingArray
111111

112112
For storing boxed heap objects, boxed arrays are provided in the following
113113
modules:
114114

115115
* Streamly.Data.Array.Generic
116116
* Streamly.Data.MutArray.Generic
117-
* Streamly.Internal.Data.Ring.Generic
117+
* Streamly.Internal.Data.RingArray.Generic
118118

119119
Unboxed arrays can be pinned (cannot be moved by GC) or
120120
unpinned. However, pinned or unpinned nature of the memory is not

docs/User/Tutorials/replacing-other-packages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ The relevant modules in streamly are:
113113
* `Streamly.Data.Array.Generic`: immutable, boxed arrays
114114
* `Streamly.Data.MutArray`: mutable, unboxed, pinned, unpinned arrays
115115
* `Streamly.Data.MutArray.Generic`: mutable, boxed arrays
116-
* `Streamly.Internal.Data.Ring`: unboxed ring buffer
117-
* `Streamly.Internal.Data.Ring.Generic`: boxed ring buffer
116+
* `Streamly.Internal.Data.RingArray`: unboxed ring buffer
117+
* `Streamly.Internal.Data.RingArray.Generic`: boxed ring buffer
118118

119119
| Package | Streamly Type |
120120
|-------------------|-------------------------|

docs/User/Tutorials/types-and-modules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ The following table lists the modules and types for monadic stream producers
1717

1818
## Arrays
1919

20-
| Module | Type | Description |
21-
|-------------------------------------|--------------|------------------------------------------------|
22-
| Streamly.Data.Array | Array a | Immutable, unboxed, pinned and unpinned arrays |
23-
| Streamly.Data.MutArray | MutArray a | Mutable, unboxed, pinned and unpinned arrays |
24-
| Streamly.Data.Array.Generic | Array a | Immutable, boxed arrays |
25-
| Streamly.Data.MutArray.Generic | MutArray a | Mutable, boxed arrays |
26-
| Streamly.Data.MutByteArray | MutByteArray | Mutable byte arrays |
27-
| Streamly.Data.MutByteArray | Unbox a | Fixed length data serialization |
28-
| Streamly.Data.MutByteArray | Serialize a | Variable length data serialization |
29-
| Streamly.Internal.Data.Ring | Ring a | Unboxed ring buffer |
30-
| Streamly.Internal.Data.Ring.Generic | Ring a | Boxed ring buffer |
20+
| Module | Type | Description |
21+
|------------------------------------------|--------------|------------------------------------------------|
22+
| Streamly.Data.Array | Array a | Immutable, unboxed, pinned and unpinned arrays |
23+
| Streamly.Data.MutArray | MutArray a | Mutable, unboxed, pinned and unpinned arrays |
24+
| Streamly.Data.Array.Generic | Array a | Immutable, boxed arrays |
25+
| Streamly.Data.MutArray.Generic | MutArray a | Mutable, boxed arrays |
26+
| Streamly.Data.MutByteArray | MutByteArray | Mutable byte arrays |
27+
| Streamly.Data.MutByteArray | Unbox a | Fixed length data serialization |
28+
| Streamly.Data.MutByteArray | Serialize a | Variable length data serialization |
29+
| Streamly.Internal.Data.RingArray | RingArray a | Unboxed ring buffer |
30+
| Streamly.Internal.Data.RingArray.Generic | RingArray a | Boxed ring buffer |
3131

3232
## Unicode Operations
3333

0 commit comments

Comments
 (0)