Method ao/diag


  DIAG overloads the diagonal operator for analysis objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: DIAG overloads the diagonal operator for analysis objects.
 
  CALL:        b = diag (a)       % only with cdata AOs
               b = diag (a, pl)   % only with cdata AOs
 
  INPUTS:      a  -  input analysis object
               pl - parameter list
 
  OUTPUTS:     b  - output analysis object
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

1D

no description
Key Default Value Options Description
diag
AXIS 'y' none The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in cdata objects. For tsdata, fsdata or xydata, this option has no effect.
OPTION 0 none See help on MATLAB's diag.

Example

plist('AXIS', 'y', 'DIM', [[]], 'OPTION', [0])

back to top back to top

2D

no description
Key Default Value Options Description
diag
AXIS 'y'
  • 'x'
  • 'y'
  • 'xy'
The axis on which to apply the method.
OPTION 0 none See help on MATLAB's diag.

Example

plist('AXIS', 'y', 'OPTION', [0])

back to top back to top

3D

no description
Key Default Value Options Description
diag
AXIS 'z'
  • 'x'
  • 'y'
  • 'z'
  • 'xyz'
The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in the z field of xyzdata objects.
OPTION 0 none See help on MATLAB's diag.

Example

plist('AXIS', 'z', 'DIM', [[]], 'OPTION', [0])

back to top back to top

Some information of the method ao/diag are listed below:
Class name ao
Method name diag
Category Operator
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team