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

#include    <cstdlib>
using namespace std;


class RWCString;

template <class TP>
class RWT2DValVector {
public:
   int nNumberOfConsPos_;
   int nNumberOfThingsAtEachConsPos_;
   int nConsPosStart_;

   RWCString soName_;
   TP* pArray_;
   int nArraySize_;

public:
   RWT2DValVector( const size_t nNumberOfConsPos,
                   const size_t nNumberOfThingsAtEachConsPos,
                   const int nConsPosStart,
                   const RWCString& soName ) :
      nNumberOfConsPos_( nNumberOfConsPos ),
      nNumberOfThingsAtEachConsPos_( nNumberOfThingsAtEachConsPos ),
      nConsPosStart_( nConsPosStart ),
      soName_( soName ) {

      nArraySize_ = nNumberOfConsPos_ * nNumberOfThingsAtEachConsPos_;

      if ( nArraySize_ == 0 ) {
         pArray_ = NULL;
      }
      else {
         pArray_ = (TP*) malloc( nArraySize_ * sizeof( TP ) );

         if ( !pArray_ ) {
            RWCString soError = "RWT2dValVector ";
            soError += soName_;
            soError += " trying to calloc an array of length ";
            soError += RWCString( (long) nArraySize_ );
            soError += " but couldn't get this much memory";
            THROW_ERROR( soError );
         }

         for( int n = 0; n < nArraySize_; ++n ) {
            pArray_[n] = (TP) 0;
         }
      }
   }


   ~RWT2DValVector() {
      free( (void*) pArray_ );
   }

   inline TP& valGet( const int nConsPos,
                           const int nThingAtConsPos ) {

      checkIfInRange( nConsPos, nThingAtConsPos );

      return( pArray_[ nNumberOfThingsAtEachConsPos_ * ( nConsPos - nConsPosStart_ ) +
                        nThingAtConsPos ] );
   }

   inline TP valGet( const int nConsPos,
                            const int nThingAtConsPos ) const {
      
      checkIfInRange( nConsPos, nThingAtConsPos );

      return( pArray_[ nNumberOfThingsAtEachConsPos_ * ( nConsPos - nConsPosStart_ ) +
                        nThingAtConsPos ] );

   }


   void increment( const int nConsPos,
                   const int nThingAtConsPos ) {
      
      checkIfInRange( nConsPos, nThingAtConsPos );

      ++( pArray_[ nNumberOfThingsAtEachConsPos_ * 
                  ( nConsPos - nConsPosStart_ ) +
                    nThingAtConsPos ] );
   }


   void checkIfInRange( const int nConsPos, const int nThingAtConsPos ) const {

      if ( 
          ( nConsPos < nConsPosStart_ ) || 
          ( ( nConsPosStart_ + nNumberOfConsPos_ - 1 ) < nConsPos ) ||
          ( nThingAtConsPos < 0 ) ||
          ( nNumberOfThingsAtEachConsPos_ <= nThingAtConsPos ) 
          ) {

         RWCString soError = "RWT2DValVector " + soName_ + " out of bounds ";
         soError += " nConsPos = ";
         soError += RWCString( (long) nConsPos );
         soError += " nThingAtConsPos = ";
         soError += RWCString( (long) nThingAtConsPos );
         soError += " nNumberOfConsPos_ = ";
         soError += RWCString( (long) nNumberOfConsPos_ );
         soError += " nConsPosStart_ = ";
         soError += RWCString( (long) nConsPosStart_ );
         soError += " nNumberOfThingsAtEachConsPos_ = ";
         soError += RWCString( (long) nNumberOfThingsAtEachConsPos_ );
         THROW_ERROR( soError );
      }
   }


};


#endif