numir.core.utility

rank

Declaration

template rank(R)

Returns the number of dimensions of type R.

Examples

      static assert(rank!(int[2]) == 1);
static assert(rank!(int[2][3]) == 2);

NestedElementType

Declaration

template NestedElementType(T)

Returns the ElementType of a nested type T.

Examples

static assert(is(NestedElementType!(int[][]) == int));

shapeNested

Declaration

pure nothrow size_t[rank!T] shapeNested(T)(T array);

Returns the shape of a nested array length. Note that the array should have compile-time nested lengths. Dynamic arrays get compile errors.

Parameters


    T array

input array

Return Value

shape

Examples

      assert([1].shapeNested == [1]);
assert([1, 2].shapeNested == [2]);
assert([[1,2],[3,4],[5,6]].shapeNested == [3, 2]);

    

dtype

Declaration

pure auto dtype(S)(S s);

Returns the typeid of the element type of S.

Examples

      import mir.ndslice.topology : iota, as;

auto e = iota([2, 3, 1, 3]).as!double;
assert(e.dtype == typeid(double));
assert(e.dtype != typeid(float));

byteStrides

Declaration

pure size_t[] byteStrides(S)(S s);

Return the number of bytes to step in each dimension when traversing a slice.

Parameters

S s

n-dimensional slice

Return Value

array of byte strides

Examples

      import mir.ndslice.topology : iota, as;

auto e = iota(2, 3, 1, 3);
assert(e.as!int.byteStrides == [36, 12, 12, 4]);
assert(e.as!double.byteStrides == [72, 24, 24, 8]);

size

Declaration

pure auto size(S)(S s);

Returns the total number of elements in a slice

Parameters

S s

array

Return Value

total number of elements in a slice

Examples

      import mir.ndslice.topology : iota;

auto e = iota(2, 3, 1, 3);
assert(e.size == (2 * 3 * 1 * 3));

view

Declaration

pure auto view(S, size_t N)(S sl, ptrdiff_t[N] lengths...);

Returns a new view of a slice with the same data, but reshaped to have shape equal to lengths.

Parameters

`S sl`	n-dimensional slice
`ptrdiff_t[N] lengths`	A list of `lengths` for each dimension

Return Value

new view of a slice with the same data

Examples

      import std.string : split;
import mir.ndslice.topology : universal, iota;
import mir.ndslice.allocation : slice;
import mir.ndslice.dynamic : transposed;

assert(iota(3, 4).slice.view(-1, 1).shape == [12, 1]);
assert(iota(3, 4).slice.universal.transposed.view(-1, 6).shape == [2, 6]);

    

Examples

Invalid views generate ReshapeError

      import std.string : split;
import mir.ndslice.topology : iota;
import mir.ndslice.allocation : slice;

try {
    iota(3, 4).slice.view(2, 1);
} catch (Exception e) {
    assert(e.msg.split(":")[0] == "ReshapeError");
}
try {
    iota(0).slice.view(2, 1);
} catch (Exception e) {
    assert(e.msg.split(":")[0] == "ReshapeError");
}

    

ndim

Declaration

size_t ndim(S)(S s) if (isSlice!S);

Returns the number of dimensions of a slice.

Parameters

S s

n-dimensional slice

Return Value

number of dimensions

Examples

      import mir.ndslice.topology : iota;

auto e = iota(2, 3, 1, 3);
assert(e.ndim == 4);