# hypermat

initializes an N dimensional matrix

## Calling Sequence

    M = hypermat(dims [,v])

## Arguments

dims

  a vector of hypermatrix dimensions.

v

  a vector of hypermatrix entries (default value `zeros(prod(dims),1)`).

## Description

The `hypermat` function initializes a hypermatrix whose dimensions are given in the vector `dims` and entries are given in optional argument `v`.

`M` data structure contains the vector of matrix dimensions `M('dims')` and the vector of entries `M('entries')` such as the leftmost subcripts vary first `[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]`

If you build your own `hypermat`, you must be careful. The `M('dims')` entry must be a row vector whereas the `M('entries')` must be a column vector.

## Examples

    M = hypermat([2 3 2 2],1:24)
    disp(size(M('dims')))
    disp(size(M('entries')))

    M_own            = mlist(['hm','dims','entries']);
    M_own('dims')    = [2 3 2 2];
    M_own('entries') = [1:24]';
    disp(size(M_own('dims')))
    disp(size(M_own('entries')))

## See Also

- hypermatrices
- zeros
- ones
- grand
- matrix