Home > m > math > ltpda_lincom.m

ltpda_lincom

PURPOSE ^

LTPDA_LINCOM make the linear combination of the input analysis objects.

SYNOPSIS ^

function varargout = ltpda_lincom(varargin)

DESCRIPTION ^

 LTPDA_LINCOM make the linear combination of the input analysis objects.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LTPDA_LINCOM make the linear combination of the
              input analysis objects.

 CALL:        b = lincom(a1,a2,a3,...,pl)
              b = lincom(a1,a2,a3,...,aN)

              If no parameter list is specified, one of the analysis objects
              should contain a cdata type with the coefficients inside.

 INPUTS:      aN - a list of analysis objects of the same type
              pl - a parameter list

 OUTPUTS:     b  - output analysis object

              If the last input argument is a parameter list (plist) it is used.
              The following parameters are recognised.

 PARAMETERS:  'coeffs' - vector of coefficients, same length as number of input AOs

 VERSION:    $Id: ltpda_lincom.m,v 1.15 2008/08/10 20:27:49 hewitson Exp $

 HISTORY:     14-02-07 M Hewitson
                 Creation.
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_LINCOM make the linear combination of the input analysis objects.
0002 %
0003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004 %
0005 % DESCRIPTION: LTPDA_LINCOM make the linear combination of the
0006 %              input analysis objects.
0007 %
0008 % CALL:        b = lincom(a1,a2,a3,...,pl)
0009 %              b = lincom(a1,a2,a3,...,aN)
0010 %
0011 %              If no parameter list is specified, one of the analysis objects
0012 %              should contain a cdata type with the coefficients inside.
0013 %
0014 % INPUTS:      aN - a list of analysis objects of the same type
0015 %              pl - a parameter list
0016 %
0017 % OUTPUTS:     b  - output analysis object
0018 %
0019 %              If the last input argument is a parameter list (plist) it is used.
0020 %              The following parameters are recognised.
0021 %
0022 % PARAMETERS:  'coeffs' - vector of coefficients, same length as number of input AOs
0023 %
0024 % VERSION:    $Id: ltpda_lincom.m,v 1.15 2008/08/10 20:27:49 hewitson Exp $
0025 %
0026 % HISTORY:     14-02-07 M Hewitson
0027 %                 Creation.
0028 %
0029 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0030 
0031 function varargout = ltpda_lincom(varargin)
0032   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/lincom now.');
0033 
0034   % Call ao/lincom
0035   bs =  lincom(varargin{:});
0036 
0037   % set output
0038   varargout{1} = bs;
0039 end
0040 % END

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003