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

#include    "mbt_exception.h"
#include    "assert.h"
#include    "min.h"
#include    "soEmptyString.h"



const int nInitialRWTValVectorCapacity = 0;

template <class TP>
class RWTValVector {
public:
   int nCurrentLength_;
   int nMaxLength_;
   TP* pArray_;
   RWCString soName_;
public:
   RWTValVector( const size_t nCapacity = nInitialRWTValVectorCapacity )
      : nCurrentLength_( nCapacity ), nMaxLength_( nCapacity ) {
      if ( nCapacity == 0 ) {
         pArray_ = 0;
      }
      else {
         pArray_ = new TP[ nCapacity ];
         if ( !pArray_ ) {
            PANIC_OST( ost ) <<
               "in RWTValVector ctor.  failed to get memory for " <<
               nCapacity << " objects" << ends;

            throw RWInternalError( ost.str().c_str() );
         }
      }
   }


   RWTValVector( const size_t nCapacity,
                 const TP& valInitial,
                 const RWCString& soName = soEmptyString ) : nCurrentLength_( nCapacity ), nMaxLength_( nCapacity ), soName_( soName ) {

      if ( nCapacity == 0 ) {
         pArray_ = 0;
      }
      else {
         pArray_ = new TP[ nCapacity ];
         if ( !pArray_ ) {
            PANIC_OST( ost ) <<
               "in RWTValVector ctor, failed to get memory for " <<
               nCapacity << " objects" << ends;
            throw RWInternalError( ost.str().c_str() );
         }

         for( register int n = 0; n < nCurrentLength_; ++n )
            pArray_[n] = valInitial;
      }
   }

   ~RWTValVector() {
      delete [] pArray_;
   }

   bool operator==( const RWTValVector<TP>& rwRef ) {
      return( this == &rwRef );
   }

   size_t nGetEndIndex() { return( nCurrentLength_ - 1 ); }

   size_t length() const { return( nCurrentLength_ ); }


   void reshape( const size_t nNewSize, const TP& valInitial ) {

      TP* pTemp = new TP[ nNewSize ];

      // looking at consed code, there is no place where existing
      // values are supposed to be preserved during a reshape
//       int nMin = MIN( nNewSize, nCurrentLength_ );

//       for( int n = 0; n < nMin; ++n )
//          pTemp[n] = pArray_[n];

      delete [] pArray_;

      pArray_ = pTemp;

      nCurrentLength_ = nNewSize;
      nMaxLength_ = nNewSize;

      // wipe out all entries--initialize
      for( register int n = 0; n < nCurrentLength_; ++n )
         pArray_[n] = valInitial;

   }


   // new function (Nov 2006) to not initialize the values
   // useful in which this array is very long and will be
   // set to different values anyway

   void reshape( const size_t nNewSize ) {
      TP* pTemp = new TP[ nNewSize ];

      // looking at consed code, there is no place where existing
      // values are supposed to be preserved during a reshape
//       int nMin = MIN( nNewSize, nCurrentLength_ );

//       for( int n = 0; n < nMin; ++n )
//          pTemp[n] = pArray_[n];

      delete [] pArray_;

      pArray_ = pTemp;

      nCurrentLength_ = nNewSize;
      nMaxLength_ = nNewSize;

   }

   void reshapeIfNotLargeEnough( const size_t nNewSize ) {

     if ( nNewSize <= nMaxLength_ ) {
       nCurrentLength_ = nNewSize;
       return;
     }
     
      TP* pTemp = new TP[ nNewSize ];

      // looking at consed code, there is no place where existing
      // values are supposed to be preserved during a reshape
//       int nMin = MIN( nNewSize, nCurrentLength_ );

//       for( int n = 0; n < nMin; ++n )
//          pTemp[n] = pArray_[n];

      delete [] pArray_;

      pArray_ = pTemp;

      nCurrentLength_ = nNewSize;
      nMaxLength_ = nNewSize;

   }

   void setAllValues( const TP& valInitial ) {
      for( register int n = 0; n < nCurrentLength_; ++n )
         pArray_[n] = valInitial;
   }


   inline TP& operator[]( const size_t nIndex ) {
      if ( nIndex >= nCurrentLength_ ) {
         PANIC_OST( ost ) << "In RWTValVector::operator[] ( " << nIndex 
                          << " ) out of bounds with nCurrentLength_ = " 
                          << nCurrentLength_ << " " 
                          << soName_ << ends;

         throw RWInternalError( ost.str().c_str() );
      }

      return( pArray_[ nIndex ] );
   }

   inline TP operator[]( const size_t nIndex ) const {
      if ( nIndex >= nCurrentLength_ ) {
         PANIC_OST( ost ) << "In RWTValVector::operator[] ( " << nIndex 
                          << " ) const out of bounds with nCurrentLength_ = " 
                          << nCurrentLength_ 
                          << " " << soName_ << ends;

         throw RWInternalError( ost.str().c_str() );
      }

      return( pArray_[ nIndex ] );
   }


   void operator=( const RWTValVector<TP>& rwRef ) {
      assert( nCurrentLength_ == rwRef.nCurrentLength_ );

      for( int n = 0; n < nCurrentLength_; ++n ) 
         pArray_[ n ] = rwRef.pArray_[ n ];
   }


};




#endif