@@ -3,20 +3,34 @@ This is a submodule of $(MREF mir,ndslice).
33
44It contains allocation utilities.
55
6- $(BOOKTABLE $(H2 Transpose operators),
6+ $(BOOKTABLE $(H2 GC Allocation utilities),
7+ $(TR $(TH Function Name) $(TH Description))
8+ $(T2 slice, Allocates a slice using GC.)
9+ $(T2 shape, Returns a shape of a common n-dimensional array. )
10+ $(T2 ndarray, Allocates a common n-dimensional array from a slice. )
11+ $(T2 uninitSlice, Allocates an uninitialized slice using GC. )
12+ )
13+
14+ $(BOOKTABLE $(H2 Custom allocation utilities),
715$(TR $(TH Function Name) $(TH Description))
816$(T2 makeNdarray, Allocates a common n-dimensional array from a slice using an allocator. )
917$(T2 makeSlice, Allocates a slice using an allocator. )
1018$(T2 makeUninitSlice, Allocates an uninitialized slice using an allocator. )
11- $(T2 ndarray, Allocates a common n-dimensional array from a slice. )
12- $(T2 shape, Returns a shape of a common n-dimensional array. )
13- $(T2 slice, Allocates a slice using GC.)
14- $(T2 uninitSlice, Allocates an uninitialized slice using GC. )
19+ )
20+
21+ $(BOOKTABLE $(H2 CRuntime allocation utilities),
22+ $(TR $(TH Function Name) $(TH Description) )
1523$(T2 stdcSlice, Allocates a slice copy using `core.stdc.stdlib.malloc`)
16- $(T2 stdcFreeSlice, Frees memory using `core.stdc.stdlib.free`)
1724$(T2 stdcUninitSlice, Allocates an uninitialized slice using `core.stdc.stdlib.malloc`.)
25+ $(T2 stdcFreeSlice, Frees memory using `core.stdc.stdlib.free`)
1826)
1927
28+ $(BOOKTABLE $(H2 Aligned allocation utilities),
29+ $(TR $(TH Function Name) $(TH Description))
30+ $(T2 uninitAlignedSlice, Allocates an uninitialized aligned slice using GC. )
31+ $(T2 stdcUninitAlignedSlice, Allocates an uninitialized aligned slice using CRuntime.)
32+ $(T2 stdcFreeSlice, Frees memory using CRuntime)
33+ )
2034
2135License: $(HTTP boost.org/LICENSE_1_0.txt, Boost License 1.0).
2236Copyright: Copyright © 2016-, Ilya Yaroshenko
@@ -39,7 +53,7 @@ import mir.ndslice.field: BitwiseField;
3953@optmath:
4054
4155/+ +
42- Allocates an array and creates an n-dimensional slice over it .
56+ Allocates an an n-dimensional slice.
4357Params:
4458 lengths = List of lengths for each dimension.
4559 init = Value to initialize with (optional).
@@ -178,7 +192,7 @@ Slice!(Contiguous, [N], FieldIterator!(BitwiseField!(size_t*))) bitSlice(size_t
178192}
179193
180194/+ +
181- Allocates an uninitialized array and creates an n-dimensional slice over it .
195+ Allocates an uninitialized an n-dimensional slice.
182196Params:
183197 lengths = list of lengths for each dimension
184198Returns:
@@ -203,7 +217,7 @@ version(mir_test)
203217}
204218
205219/+ +
206- Allocates an uninitialized aligned array and creates an n-dimensional slice over it .
220+ Allocates an uninitialized aligned an n-dimensional slice.
207221Params:
208222 lengths = list of lengths for each dimension
209223 alignment = memory alignment (bytes)
0 commit comments