Home > Applications > SpinW > external > mdiagonal.m

iFit/mdiagonal

PURPOSE ^

Returns the diagonal elements along two selected dimensions.

SYNOPSIS ^

function A = mdiag(A,dim)

DESCRIPTION ^

 Returns the diagonal elements along two selected dimensions.

 Input:
 A         Multidimensional input array.
 dim       Contains two number, that selects two dimensions.

 The diagonal is the diagonal of every A(... dim(1)...dim(2)...) matrix.
 The result is contracted along dim(2).

 The default value for dim is dim = [1 2].

 Examples:
 For 2D matrices mmat is identical to the Matlab built-in diag:
 A = [1 2; 3 4];
 C = mdiag(A)

 C will be [1;4].

 For multidimensional arrays:
 A = repmat([1 2; 3 4],[1 1 3]);
 B = mdiag(A,[1 2])
 B will be an array with dimensions of 2x3: [1 1 1;4 4 4].

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 27-Nov-2018 10:56:24 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1