/*****************************************************************************
#   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 mbtPtrOrderedVector_included
#define mbtPtrOrderedVector_included


#include    "rwtptrorderedvector.h"
#include    "bool.h"
#include    <stdlib.h>
#include    "mbt_exception.h"
#include    <iostream.h>



template <class TP>
class mbtPtrOrderedVector : public RWTPtrOrderedVector<TP> {

public:
   mbtPtrOrderedVector( 
                       size_t nCapacity = nInitialRWTPtrOrderedVectorCapacity,
                       const RWCString& soName = soEmptyString ) :
      RWTPtrOrderedVector<TP>( nCapacity, soName ) {}

   mbtPtrOrderedVector( const RWTPtrOrderedVector<TP>& aArray,
                        const RWCString& soName ) :
      RWTPtrOrderedVector<TP>( aArray ) {
      RWTPtrOrderedVector<TP>::soName_ = soName; }

#ifdef USE_USING_IN_PUBLIC_TEMPLATE_CLASSES   
    using RWTPtrOrderedVector<TP>::nCurrentLength_;
    using RWTPtrOrderedVector<TP>::data;
    using RWTPtrOrderedVector<TP>::entries;
    using RWTPtrOrderedVector<TP>::operator[];
    using RWTPtrOrderedVector<TP>::isEmpty;
    using RWTPtrOrderedVector<TP>::length;
#endif

   void insertSorted( TP* pVal ) {
      
      int nInsertBeforeIndex = nFindIndexOfMatchOrSuccessor( pVal );

      if ( nInsertBeforeIndex == RW_NPOS )
         nInsertBeforeIndex = nCurrentLength_;

      insertAt( nInsertBeforeIndex, pVal );
   }
   
   void resort() {
     void* pArray = (void*) data();
     size_t nNumberOfElementsInArray = entries();
     size_t nSizeOfAnElement = sizeof( TP* );

     
     qsort( pArray, nNumberOfElementsInArray, nSizeOfAnElement,
          ( ( int(*) ( const void*, const void*) ) cmp ));


     if ( ! bIsSorted() ) {
       PANIC_OST( ost ) 
          << "mbtPtrOrderedVector::resort didn't work" << endl << ends;
       throw ProgramLogicError( ost.str() );
     }



   };



   static int cmp( const TP** ppT1, const TP** ppT2 ) {
     if ( **ppT1 < **ppT2 )
       return( -1 );
     else if (**ppT2 < **ppT1 )
       return( 1 );
     else 
       return( 0 );
   };



   bool bIsSorted() {

     int nNumberOfEntries = entries();

     bool bSorted = true;
     if ( nNumberOfEntries >= 2 ) {
       for( int nElement = 0; nElement <= nNumberOfEntries - 2; ++nElement ) {
         if ( 
	     *operator[]( nElement + 1 ) < *operator[]( nElement )
	     ) {
	   bSorted = false;
	   cout << "Elements " << nElement << " and " << nElement + 1 <<
	     " are out of order " << endl;
         }
       }
     }
     return( bSorted );
   }


   // code borrowed from mbt_ptr_sorted_vector.h
   int nFindIndexOfMatchOrSuccessor( const TP* pTMatch) 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]) == *pTMatch ) {
            return nTestIndex;  // exact match
         }
         else if ( *pTMatch < *((*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 )
   }


   int indexFast( const TP* pVal ) {

      int nFirst = nFindIndexOfMatchOrSuccessor( pVal );

      if ( nFirst != RW_NPOS ) {
         if ( *( (*this)[ nFirst ]) == *pVal )
            return( nFirst );
         else
            return( RW_NPOS );
      }
      else
         return( RW_NPOS );
   }


   TP* pFindFast( const TP* pVal ) {
      int nIndex = indexFast( pVal );
      if ( nIndex == RW_NPOS )
         return NULL;
      else {
         return( (*this)[ nIndex ] );
      }
   }

 
   // copied from mbtValOrderedVectorOfRWCString.h

   int nFindIndexOfMatchOrPredecessor( const TP* pTMatch ) const {
 
      if ( isEmpty() ) 
         return( RW_NPOS );
 
      // region A
      // ----------- nMinIndex
      // region B
      // ----------- nTestIndex
      // region C
      // ----------- nTooLargeIndex 
      // region D
 
      // an index becomes nTooLargeIndex if it is greater than soMatch
      // an index becomes nMinIndex if it is less than soMatch
 
      if ( *pTMatch < *(operator[]( 0 )) )
         return( RW_NPOS );
 
      int nMinIndex = 0;
      int nTooBigIndex = length() - 1;
 
      if ( *( operator[]( nTooBigIndex ) ) < *pTMatch ||
           *( operator[]( nTooBigIndex ) ) == *pTMatch )
         return( nTooBigIndex );
 
      // if reached here, soMatch < operator[]( nTooBigIndex )
      // and operator[](0) <= soMatch
      // Thus nTooBigIndex != 0  and the correct index is somewhere
      // less than nTooBigIndex and correct index >= 0 so 
      // correct index >= 0.
      // Thus bisect this range over and over, making it smaller
      // and smaller until it is 0.
 
      while( true ) {
         if ( nTooBigIndex - nMinIndex <= 1 )
            return( nMinIndex );
         else {
            int nTestIndex = ( nTooBigIndex + nMinIndex ) / 2;
            if ( *pTMatch < *( operator[]( nTestIndex ) ) )
               nTooBigIndex = nTestIndex;
            else
               nMinIndex = nTestIndex;
         }
      }
   }
    


};

#endif