/*****************************************************************************
#   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.
#
#*****************************************************************************/
#ifndef rwtvalsortedvector_included
#define rwtvalsortedvector_included


#include    "rwtvalorderedvector.h"


template <class TP>
class RWTValSortedVector : public RWTValOrderedVector<TP> {
public:


#ifdef USE_USING_IN_PUBLIC_TEMPLATE_CLASSES

   using RWTValOrderedVector<TP>::nCurrentLength_;
   using RWTValOrderedVector<TP>::isEmpty;
   using RWTValOrderedVector<TP>::length;

#endif


   inline void insert( const TP& val ) {
      // find where it goes and use the insertAt from RWTValOrderedVector
      // Find where it goes, meaning either find an exact match and
      // insert it before that, or else find its successor, and insert
      // it before that.

      int nPos = nFindIndexOfMatchOrSuccessor( val );
      
      // if nfindIndexOfMatchOrSuccessor returns RW_NPOS, then either
      // the array is empty (nCurrentLength_ = 0 ), or else the
      // value should go after the array. 
      if ( nPos == RW_NPOS ) 
         nPos = nCurrentLength_;

      insertAt( nPos, val );
   }


   inline int nFindIndexOfMatchOrSuccessor( const TP& val ) const {
      
      // return immediately if empty
      if ( isEmpty() ) 
         return RW_NPOS;

      int nRangeStart = 0;
      int nRangeEnd = length() - 1;

      while( true ) {

         int nRangeLen = nRangeEnd - nRangeStart + 1;
         int nTestIndex = ( nRangeLen / 2 ) + nRangeStart;

         if ( ( (*this)[nTestIndex]) == val ) {
            return nTestIndex;  // exact match
         }
         else if ( val < (*this)[nTestIndex] ) {
            // .  .  .  +  .  .  .  .  . (+ is nTestIndex)
            //         * (pTMatch)
            // This is first case

            //    + . . . . .
            //  * (pTMatch)
            // This is second case

            if ( ( nRangeLen == 1 ) || ( nTestIndex == 0 ) ) {
               return( nTestIndex );
            }
            else {
               // .  .  .  .  +  .  .  (+ is nTestIndex)
               //      * (pTMatch)
               // So overshot.
               nRangeEnd = nTestIndex - 1;
            }
         }
         else { 
            // *((*this)[nTestIndex])  < *pTMatch


            // case of nRangeLen == 1

            // .  l  u(+) .
            //           *

            // l is nRangeStart
            // u is nRangeEnd
            // + is nTestIndex
            // * is pTMatch

            
            if ( nRangeLen == 1 || nTestIndex == nRangeEnd) {

               if ( nTestIndex == ( length() - 1 ) ) {
               // .  .  .  +
               //            * (pTMatch)
               // In this case, there is no match or successor
                  return RW_NPOS;
               }
               else {
                  // .  .  .  .  +  .  .  .
                  //               * (pTMatch)
                  // In this case, we want the "." after the "+"

                  return( nTestIndex + 1);
               }
            }
            else 
            // normal case:  

            // .  .  +  .  .  .  .
            //               * (pTMatch)
               nRangeStart = nTestIndex + 1;
         }
      } //  while( true )
   }
         

   bool bContains( const TP& val ) {
      int n = nFindIndexOfMatchOrSuccessor( val );

      if ( n == RW_NPOS ) return false;

      if ( (*this)[n] == val ) {
         return true;
      }
      else {
         return false;
      }
   }

      
      
      


};


#endif