Difference between revisions of "Appendix H: Matlab object overloads"

From Spinach Documentation Wiki
Jump to: navigation, search
(Link orphaned function-description pages from summary pages)
(Normalise sequential blank lines)
Line 70: Line 70:
  
 
[[double/inflate.m]] - polyadic inflation, skips when it sees a double
 
[[double/inflate.m]] - polyadic inflation, skips when it sees a double
−
 
  
 
''Version 2.9, authors: [[Ilya Kuprov]]''
 
''Version 2.9, authors: [[Ilya Kuprov]]''

Revision as of 12:22, 25 April 2026

Spinach overloads a few operations in Matlab and offers replacements for a few functions. This section contains a list of those overloads and operations.

Structures

struct/plus.m - field-wise addition.

struct/mtimes.m - field-wise multiplication by a matrix.

Cell arrays

cell/blkdiag.m - block-diagonal cell array from two cell arrays.

cell/complex.m - make cell array elements complex.

cell/inflate.m - inflates every polyadic in a cell array.

cell/minus.m - element-wise subtraction.

cell/mtimes.m - element-wise multiplication by a matrix.

cell/times.m - element-wise multiplication by a scalar.

cell/plus.m - element-wise addition.

cell/totsum.m - a sum across all dimensions of a cell array.

Function replacements

kcolourbar.m - LaTeX ticks and label on the standard colour bar.

kgrid.m - grey (rather than black-and-transparent) coordinate system grid.

kfigure.m - figure window creation with Spinach plotting defaults.

klegend.m - LaTeX legend.

ktitle.m - bold LaTeX title.

ksgtitle.m - LaTeX title for a grid of plots

ksubplot.m - subplots with narrower margins.

kxlabel.m - LaTeX ticks and label on the standard X axis.

kylabel.m - LaTeX ticks and label on the standard Y axis.

kzlabel.m - LaTeX ticks and label on the standard Z axis.

RCV sparse matrices

rcv/ctranspose.m - conjugate transpose of an RCV sparse matrix.

rcv/gather.m - gathers an RCV sparse matrix from GPU.

rcv/gpuArray.m - transfers an RCV sparse matrix to GPU.

rcv/horzcat.m - horizontal concatenation for RCV sparse matrices.

rcv/kron.m - Kronecker product between two RCV sparse matrices.

rcv/nnz.m - number of non-zero elements in an RCV sparse matrix.

rcv/size.m - size of an RCV sparse matrix.

rcv/spy.m - sparsity pattern plot for an RCV sparse matrix.

rcv/vertcat.m - vertical concatenation for RCV sparse matrices.

Miscellaneous

double/inflate.m - polyadic inflation, skips when it sees a double

Version 2.9, authors: Ilya Kuprov