Method ao/norm


  NORM overloads the norm operator for analysis objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: NORM overloads the norm operator for analysis objects.
 
  CALL:        b = norm(a,pl)       % only with cdata AOs
               b = norm(a)          % only with cdata AOs
 
  INPUTS:      pl   - a parameter list
               a    - input analysis object
 
  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
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 '' none A string or value that can be submited, e.g. 'inf' for
the infinity norm of the input ao, the largest row
sum. Options are the same as for MATLAB's norm.
back to top back to top

2D

no description
Key Default Value Options Description
AXIS 'y'
  • 'x'
  • 'y'
  • 'xy'
The axis on which to apply the method.
OPTION '' none A string or value that can be submited, e.g. 'inf' for
the infinity norm of the input ao, the largest row
sum. Options are the same as for MATLAB's norm.
back to top back to top

3D

no description
Key Default Value Options Description
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 '' none A string or value that can be submited, e.g. 'inf' for
the infinity norm of the input ao, the largest row
sum. Options are the same as for MATLAB's norm.
back to top back to top

Some information of the method ao/norm are listed below:
Class name ao
Method name norm
Category Operator
Package name ltpda
VCS Version 3f8d61c792503a5b5ec8a0a153efb23b65da24a9
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team