/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``AS IS'' and any express or implied
#   warranties, including, but not limited to, the implied warranties of
#   merchantability and fitness for a particular purpose, are disclaimed.
#   In no event shall the authors or the University of Washington be
#   liable for any direct, indirect, incidental, special, exemplary, or
#   consequential damages (including, but not limited to, procurement of
#   substitute goods or services; loss of use, data, or profits; or
#   business interruption) however caused and on any theory of liability,
#   whether in contract, strict liability, or tort (including negligence
#   or otherwise) arising in any way out of the use of this software, even
#   if advised of the possibility of such damage.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
#include    "nFindScoreOfSelfMatch.h"
#include    "nNumberFromBase.h"
#include    "nPrimerFalseMatchScoreArray.h"


#define nPenaltyForNotStartingAt3PrimeEnd -2


int nFindScoreOfSelfMatch( const int nZeroBasedStartPosition, 
                           const int nZeroBasedEndPosition,
                           const int nUncovered3PrimeBases,
                           char* szComplementedPrimer,
                           const int nCompPrimerStart,
                           int& nPosOfMaxCumulativeScore ) {

   // szComplementedPrimer address is set so that, however it is positioned,
   // 


   
   // Create sub-oligos that start at the most 3' end of the primer
   // (hence start at nZeroBasedEndPosition) and find the one that has
   // the highest score.

   int nCumulativeScore = nUncovered3PrimeBases * nPenaltyForNotStartingAt3PrimeEnd;
   // the purpose of this is to penalize matches that don't start at 
   // the 3' end of the primer.  The further the match from the 3' end,
   // the more the penalty

   int nMaxCumulativeScore = -10000; // something absurd
   
   for( int nSubOligo5PrimeEnd = nZeroBasedEndPosition;
           nSubOligo5PrimeEnd >= nZeroBasedStartPosition;
           --nSubOligo5PrimeEnd ) {

      char cBaseInComplementedPrimer = 
         szComplementedPrimer[ nSubOligo5PrimeEnd - nCompPrimerStart ];

      nCumulativeScore += 
         nPrimerFalseMatchScoreArray[ nSubOligo5PrimeEnd ][
                     nNumberFromBase[ cBaseInComplementedPrimer ]
                                                   ];

      if (nCumulativeScore > nMaxCumulativeScore ) {
         nMaxCumulativeScore = nCumulativeScore;
         nPosOfMaxCumulativeScore = nSubOligo5PrimeEnd;
      }
   }

   return( nMaxCumulativeScore );
}