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

template <class TP>
class RWT2DPtrVector {
public:
   int nNumberOfColumns_;
   int nNumberOfRows_;
   RWCString soName_;
   TP** ppArray_;

public:
   RWT2DPtrVector( const size_t nNumberOfColumns,
                   const size_t nNumberOfRows,
                   const RWCString& soName ) :
      nNumberOfColumns_( nNumberOfColumns ),
      nNumberOfRows_( nNumberOfRows ),
      soName_( soName ) {

      int nArraySize = 
         nNumberOfColumns_ * nNumberOfRows_;

      if ( nArraySize == 0 ) {
         ppArray_ = NULL;
      }
      else {
         ppArray_ = 
            (TP**) malloc( nArraySize * sizeof( TP* ) );
         if ( !ppArray_ ) {
            RWCString soError = "RWT2DPtrVector ";
            soError += soName_;
            soError += " trying to malloc an array of size ";
            soError += RWCString( (long) nArraySize );
            soError += " but couldn't get this much memory";
            THROW_ERROR( soError );
         }

         for( register int nIndex = 0; 
              nIndex < nArraySize; ++nIndex ) {
            ppArray_[ nIndex ] = NULL;
         }
      }
         
   } // RWT2DPtrVector( const size_t nNumberOfColumns,


   ~RWT2DPtrVector() {
      free( (void*) ppArray_ );
   }


   bool bIsSubscriptInBounds( const int nX, const int nY ) {
      if ( 0 <= nX && nX < nNumberOfColumns_ && 0 <= nY && nY < nNumberOfRows_ )
         return( true );
      else
         return( false );
   }


   inline TP*& pGetElement( const int nX,
                            const int nY ) {

      if ( nX < 0 || nNumberOfColumns_ <= nX ||
           nY < 0 || nNumberOfRows_ <= nY ) {
         RWCString soError = "subscript nX must be within 0 to ";
         soError += RWCString( (long) nNumberOfColumns_ - 1 );
         soError += " and subscript nY must be within 0 to ";
         soError += RWCString( (long) nNumberOfRows_ - 1 );
         soError += " but (nX, nY) = (";
         soError += RWCString( (long) nX );
         soError += ", ";
         soError += RWCString( (long) nY );
         soError += ") in ";
         soError += soName_;
         THROW_ERROR( soError );
      }

      return( ppArray_[ nY * nNumberOfColumns_ + nX ] );
   }


   inline TP* pGetElement( const int nX,
                           const int nY ) const {

      if ( nX < 0 || nNumberOfColumns_ <= nX ||
           nY < 0 || nNumberOfRows_ <= nY ) {
         RWCString soError = "subscript nX must be within 0 to ";
         soError += RWCString( (long) nNumberOfColumns_ );
         soError += " and subscript nY must be within 0 to ";
         soError += RWCString( (long) nNumberOfRows_ );
         soError += " but (nX, nY) = (";
         soError += RWCString( (long) nX );
         soError += ", ";
         soError += RWCString( (long) nY );
         soError += ") in ";
         soError += soName_;
         THROW_ERROR( soError );
      }

      return( ppArray_[ nY * nNumberOfColumns_ + nX ] );
   }

   void clearAndDestroy() {
      for( int nX = 0; nX < nNumberOfColumns_; ++nX ) {
         for( int nY = 0; nY < nNumberOfRows_; ++nY ) {
            TP* pTP = ppArray_[ nY * nNumberOfColumns_ + nX ];
            if ( pTP ) delete pTP;
         }
      }
   }

   // so that RWT2DPtrVector can be put into a RWTPtrOrderedVector
   // such as in assembly3.h
   bool operator==( const RWT2DPtrVector& myRWT2DPtrVector ) const {
      return( this == &myRWT2DPtrVector );
   }

      
};


#endif