christopherh@1: %
christopherh@1: % CHECKOMISSIONS
christopherh@1: % 
christopherh@1: % [success, errormessage] = checkomissions(shortints, intervals, {verbose})
christopherh@1: % 
christopherh@1: % Checks that any omitted intervals are actually present in the interval
christopherh@1: % list that makes up a shorthand definition. For example C:maj(*4) is an
christopherh@1: % incorrect chord because the shorthand does not contain interval 4 so
christopherh@1: % there is no reason to omit it.
christopherh@1: %
christopherh@1: % Arguments 'shortints' and 'intervals' should either be interval lists
christopherh@1: % (characters) or arrays of [degree, modifier, present] triples of the type
christopherh@1: % produced by the function 'parseintervals'.
christopherh@1: % 
christopherh@1: % Success = 1 if the interval list does not contain an omitted interval
christopherh@1: % that is not present in the shorthand list.
christopherh@1: % 
christopherh@1: % If optional argument 'verbose' is 1, function prints any errormessage to 
christopherh@1: % the screen.
christopherh@1: % 
christopherh@1: % returns:  success (boolean)
christopherh@1: %           errormessage (string)
christopherh@1: %
christopherh@1: %
christopherh@1: % Author: Christopher Harte, December 2009
christopherh@1: % 
christopherh@1: % Copyright: Centre for Digital Music, Queen Mary University of London 2005 
christopherh@1: %
christopherh@1: % This file is part of the C4DM Chord Toolkit V2.0  
christopherh@1: %
christopherh@1: % The C4DM Chord Toolkit is free software; you can redistribute it and/or 
christopherh@1: % modify it under the terms of the GNU General Public License as published 
christopherh@1: % by the Free Software Foundation; either version 2 of the License, or
christopherh@1: % (at your option) any later version.
christopherh@1: %
christopherh@1: % The C4DM Chord Toolkit is distributed in the hope that it will be useful,
christopherh@1: % but WITHOUT ANY WARRANTY; without even the implied warranty of
christopherh@1: % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
christopherh@1: % GNU General Public License for more details.
christopherh@1: %
christopherh@1: % You should have received a copy of the GNU General Public License
christopherh@1: % along with the C4DM Toolkit; if not, write to the Free Software
christopherh@1: % Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
christopherh@1: % USA
christopherh@1: 
christopherh@1: function [success, errormessage] = checkomissions(shortints,intervals,verbose)
christopherh@1: 
christopherh@1: if nargin < 3
christopherh@1:     verbose = 0;
christopherh@1: end
christopherh@1: 
christopherh@1: errormessage = '';
christopherh@1: 
christopherh@1: success = 1;
christopherh@1: 
christopherh@1: % if 'shortints' is a character string interval list, convert it to
christopherh@1: % [degree,modifier,present] triples
christopherh@1: if ischar(shortints)
christopherh@1:     [shortints,success,errormessage] = parseintervals(shortints);
christopherh@1: end
christopherh@1: 
christopherh@1: % if 'intervals' is a character string interval list, convert it to
christopherh@1: % [degree,modifier,present] triples
christopherh@1: if success && ischar(intervals)
christopherh@1:     [intervals, success, errormessage] = parseintervals(intervals);
christopherh@1: end
christopherh@1: 
christopherh@1: % if everything is ok so far, check any omissions
christopherh@1: if success 
christopherh@1: 
christopherh@1:     [sizey,sizex] = size(intervals);
christopherh@1:     [sizey2,sizex2] = size(shortints);
christopherh@1: 
christopherh@1:     success = 1;
christopherh@1: 
christopherh@1:     % for each interval in the intervals list
christopherh@1:     for indexa = 1:sizey
christopherh@1: 
christopherh@1:         % if it is an omitted interval
christopherh@1:         if intervals(indexa,3) == 0
christopherh@1: 
christopherh@1:             % check that the shorthand list contains that interval to omit
christopherh@1:             success = 0;
christopherh@1: 
christopherh@1:             for indexb = 1:sizey2
christopherh@1: 
christopherh@1:                 if shortints(indexb,1:2) == intervals(indexa,1:2)
christopherh@1:                     % if the omitted interval is found in the shorthand
christopherh@1:                     % list then the omission is valid
christopherh@1:                     success = 1;
christopherh@1:                 end
christopherh@1:             end
christopherh@1:         end 
christopherh@1:     end
christopherh@1: end 
christopherh@1: 
christopherh@1:     
christopherh@1: % if there was an error, format the error message appropriately:
christopherh@1: if success == 0
christopherh@1:         if isempty(errormessage)
christopherh@1:             errormessage = sprintf(['Error in checkommisions: ommitted interval not present in shorthand. \n']);
christopherh@1:         else
christopherh@1:             errormessage = [sprintf(['Error in checkommisions: badly formatted argument \n']) errormessage];
christopherh@1:         end
christopherh@1:         
christopherh@1:         if verbose == 1
christopherh@1:             fprintf(1,errormessage);
christopherh@1:         end
christopherh@1: 
christopherh@1: end