Home > classes > @pole > eq.m

eq

PURPOSE ^

EQ overloads the == operator for pole objects.

SYNOPSIS ^

function result = eq(p1,p2)

DESCRIPTION ^

 EQ overloads the == operator for pole objects.

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

 DESCRIPTION: EQ overloads the == operator for pole objects.

              Checks that the poles have identical values.
 
 CALL:        result = eq(p1,p2)

 INPUTS:      p1,p2 - input pole objects

 OUTPUTS:     If the two pole objects are considered equal, result == 1,
              otherwise, result == 0.
 
 VERSION:     $Id: param.m,v 1.7 2007/08/17 11:22:11 ingo Exp $

 HISTORY:     29-08-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function result = eq(p1,p2)
0002 
0003 % EQ overloads the == operator for pole objects.
0004 %
0005 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0006 %
0007 % DESCRIPTION: EQ overloads the == operator for pole objects.
0008 %
0009 %              Checks that the poles have identical values.
0010 %
0011 % CALL:        result = eq(p1,p2)
0012 %
0013 % INPUTS:      p1,p2 - input pole objects
0014 %
0015 % OUTPUTS:     If the two pole objects are considered equal, result == 1,
0016 %              otherwise, result == 0.
0017 %
0018 % VERSION:     $Id: param.m,v 1.7 2007/08/17 11:22:11 ingo Exp $
0019 %
0020 % HISTORY:     29-08-2007 M Hewitson
0021 %                 Creation
0022 %
0023 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0024 
0025 % Assume they are equal
0026 result = 1;
0027 
0028 %% Check ri
0029 if p1.ri ~= p2.ri
0030   result = 0;
0031   return
0032 end

Generated on Mon 03-Sep-2007 12:12:34 by m2html © 2003