VectorEnumerator.h

Go to the documentation of this file.

// Copyright (C) 2000 Alexander Ushakov
// Contents: Definition of class VectorEnumerator
//
// Principal Authors: Alexander Ushakov
//
// Revision History:
//


#ifndef _VECTORENUMERATOR_H_
#define _VECTORENUMERATOR_H_


#include <vector>
#include <iostream>

using namespace std;


//---------------------------------------------------------------------------//
//--------------------------- VectorEnumerator ------------------------------//
//---------------------------------------------------------------------------//



class VectorEnumerator
{

  //                                                     //
  //  Constructors                                       //
  //                                                     //
  
 public:

  VectorEnumerator( ) : curLength( 0 ) { }
    
    
  // copy constructor, assignment operator and destructor are
  // supplied by compiler
  
  
  //                                                     //
  //  Accessors                                          //
  //                                                     //
  
 public:
  
  VectorEnumerator& operator++( );

  
  vector< int > operator* ( );
  

  bool end( ) { 

    if( curLength==-1 )
      return true;
    
    // if sequence is not completed we need to complete it
    if( !seqComplete( ) )
      ++(*this);        
    
    return (curLength==-1); 
  }
  
  
  //                                                     //
  //  Debug:                                             //
  //                                                     //
  
  ostream& printSeq( ostream& os ) const;
  
  //                                                     //
  //  Internal functions:                                //
  //                                                     //
  
 protected:
  
  virtual bool seqOK            ( ) const = 0;
  virtual bool seqLimit         ( ) const = 0;
  virtual bool seqComplete      ( ) const = 0;

  virtual int  start (         ) const = 0;
  virtual int  next  ( int cur ) const = 0;
  virtual bool finish( int cur ) const = 0;
  
  int                  getLength( ) const { return curLength; }
  const vector< int >& getSeq   ( ) const { return curVector; }


  virtual void stepTo( ) { }

  virtual void stepBack( int cur ) { }
  
  //                                                     //
  //  Data members                                       //
  //                                                     //
  
 private:
  
  int           curLength;
  vector< int > curVector;
  
};



#endif