sparse_node_array.h

Go to the documentation of this file.

/*
 *  sparse_node_array.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef SPARSE_NODE_ARRAY_H
#define SPARSE_NODE_ARRAY_H
 
// C++ includes:
#include <cassert>
#include <map>
 
// Includes from nestkernel:
#include "exceptions.h"
#include "nest_types.h"
 
// Includes from libnestutil
#include "block_vector.h"
 
 
namespace nest
{
class Node;
 
class SparseNodeArray
{
public:
  class NodeEntry
  {
    friend class SparseNodeArray;
 
  public:
    NodeEntry()
      : node_( nullptr )
      , node_id_( 0 )
    {
    }
 
    NodeEntry( Node&, size_t );
 
    Node* get_node() const;      
    size_t get_node_id() const;  
 
  private:
    Node* node_;      
    size_t node_id_;  
  };
 
  typedef BlockVector< SparseNodeArray::NodeEntry >::const_iterator const_iterator;
 
  SparseNodeArray();
 
  size_t size() const;
 
  void clear();
 
  void add_local_node( Node& );
 
  void set_max_node_id( size_t );
 
  size_t get_max_node_id() const;
 
  Node* get_node_by_node_id( size_t ) const;
 
  Node* get_node_by_index( size_t ) const;
 
  const_iterator begin() const;
  const_iterator end() const;
 
private:
  bool is_consistent_() const;
 
  BlockVector< NodeEntry > nodes_;  
  size_t global_max_node_id_;       
  size_t local_min_node_id_;        
  size_t local_max_node_id_;        
 
  double left_scale_;   
  double right_scale_;  
 
  size_t split_node_id_;
 
  size_t split_idx_;
 
  bool have_split_;
 
  bool left_side_has_proxies_;
};
 
inline SparseNodeArray::const_iterator
SparseNodeArray::begin() const
{
  return nodes_.begin();
}
 
inline SparseNodeArray::const_iterator
SparseNodeArray::end() const
{
  return nodes_.end();
}
 
inline size_t
SparseNodeArray::size() const
{
  return nodes_.size();
}
 
inline Node*
SparseNodeArray::get_node_by_index( size_t idx ) const
{
  assert( idx < nodes_.size() );
  return nodes_[ idx ].node_;
}
 
inline size_t
SparseNodeArray::get_max_node_id() const
{
  return global_max_node_id_;
}
 
inline bool
SparseNodeArray::is_consistent_() const
{
  return nodes_.size() == 0 or global_max_node_id_ > 0;
}
 
inline Node*
SparseNodeArray::NodeEntry::get_node() const
{
  assert( node_ );
  return node_;
}
 
inline size_t
SparseNodeArray::NodeEntry::get_node_id() const
{
  assert( node_id_ > 0 );
  return node_id_;
}
 
}  // namespace nest
 
#endif /* SPARSE_NODE_ARRAY_H */