index_iterator.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class index_iterator

#ifndef INDEX_ITERATOR_H
#define INDEX_ITERATOR_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

namespace sheaf
{

class zn_to_bool; 

class SHEAF_DLL_SPEC index_iterator
{

public:

  index_iterator();

  index_iterator(const zn_to_bool* xhost, const index_space_handle& xid_space, bool xdelete_host = false);

  virtual ~index_iterator();

  const zn_to_bool* host() const;

  int item();

  const scoped_index& index() const;

  bool is_done() const;

  bool is_last() const;

  void next();

  void reset();

  virtual void reset(const zn_to_bool* xhost, const index_space_handle& xid_space, bool xdelete_host = false);

protected:

  const zn_to_bool* _host;

  bool _delete_host;

  int _word_index;

  int _word_ub;

  unsigned int _word;

  int _bit_index;

  int _bit_ub;

  int _item;

  int _next_item;

  int _item_ub;

  void find_next_item();

  mutable scoped_index _index;
};
 
} // namespace sheaf

#endif // ifndef INDEX_ITERATOR_H