Home > classes > @ao > ln.m

ln

PURPOSE ^

LN overloads the log operator for Analysis objects. Natural logarithm.

SYNOPSIS ^

function ao_out = ln (varargin)

DESCRIPTION ^

 LN overloads the log operator for Analysis objects. Natural logarithm.

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

 DESCRIPTION: LN overloads the log operator for Analysis objects.
              Natural logarithm.
              LN(ao) is the natural logarithm of the elements of ao.data.

 CALL: ao_out = ln(ao_in);
       ao_out = ln(ao_in, pl);
       ao_out = ln(ao1, pl1, ao_vector, ao_matrix, pl2);

 POSSIBLE VALUES: ao_in  = [ao2 ao3]
                  ao_in  = ao_vector
                  ao_in  = ao_matrix

 PARAMETER LIST:  <key>           <value>             <description>
                          tsdata  fsdata  xydata
                 'xdata'   't'     'f'      'x'     compute the xdata
                 'ydata'   'x'     'xx'     'y'     compute the ydata

 HISTORY: 23-05-2007 Diepholz
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function ao_out = ln (varargin)
0002 % LN overloads the log operator for Analysis objects. Natural logarithm.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: LN overloads the log operator for Analysis objects.
0007 %              Natural logarithm.
0008 %              LN(ao) is the natural logarithm of the elements of ao.data.
0009 %
0010 % CALL: ao_out = ln(ao_in);
0011 %       ao_out = ln(ao_in, pl);
0012 %       ao_out = ln(ao1, pl1, ao_vector, ao_matrix, pl2);
0013 %
0014 % POSSIBLE VALUES: ao_in  = [ao2 ao3]
0015 %                  ao_in  = ao_vector
0016 %                  ao_in  = ao_matrix
0017 %
0018 % PARAMETER LIST:  <key>           <value>             <description>
0019 %                          tsdata  fsdata  xydata
0020 %                 'xdata'   't'     'f'      'x'     compute the xdata
0021 %                 'ydata'   'x'     'xx'     'y'     compute the ydata
0022 %
0023 % HISTORY: 23-05-2007 Diepholz
0024 %             Creation
0025 %
0026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0027 
0028 ALGONAME = mfilename;
0029 VERSION  = '$Id: ln.html,v 1.1 2007/06/08 14:15:02 hewitson Exp $';
0030 ao_out   = [];
0031 pl       = [];
0032 option   = '';
0033 
0034 %% store the input ao's in the vector: ao_set
0035 ao_set = [];
0036 for i=1:nargin
0037   a = varargin{i};
0038   if isa(a, 'ao')
0039     [m,n] = size(a);
0040     for i = 1:m
0041       for j = 1:n
0042         ao_set  = [ao_set a(i,j)];
0043       end
0044     end
0045   elseif isa(varargin{i}, 'plist')
0046     pl = [pl varargin{i}];
0047   end
0048 end
0049 
0050 ao_out = log(ao_set, pl);
0051 
0052 % END

Generated on Fri 08-Jun-2007 16:09:11 by m2html © 2003