hash_box.h

Go to the documentation of this file.

//Copyright 2008,2009 Thomas A Caswell
//tcaswell@uchicago.edu
//http://jfi.uchicago.edu/~tcaswell
//
//This program 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 3 of the License, or (at
//your option) any later version.
//
//This program 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 this program; if not, see <http://www.gnu.org/licenses>.
//
//Additional permission under GNU GPL version 3 section 7
//
//If you modify this Program, or any covered work, by linking or
//combining it with MATLAB (or a modified version of that library),
//containing parts covered by the terms of MATLAB User License, the
//licensors of this Program grant you additional permission to convey
//the resulting work.



#ifndef HASH_BOX
#define HASH_BOX
#include <vector>
#include <list>

#include "part_def.h"
#include "enum_utils.h"
#include "part_def.h"

namespace utilities
{
class Wrapper_out;


}


namespace tracking{

class Corr;
class Accumulator;
class Hash_shelf;

class hash_box{
protected:
  std::vector<particle*> contents_;
  
  const Hash_shelf  * shelf_;
  
  int hash_indx_;
  
  bool owns_particles_;
  
public:
  


  hash_box(const Hash_shelf* in,int hash_indx,bool own_part):
    contents_(),shelf_(in),hash_indx_(hash_indx),owns_particles_(own_part){

  }
  hash_box():contents_(),shelf_(NULL),hash_indx_(-1),owns_particles_(false)
  {}

  ~hash_box();
  
  void clear(){contents_.clear();}


  
  

  void push(particle* next){
    contents_.push_back(next);
  };


  void append(hash_box* next);
  
  
  void print();



  int get_size(){return contents_.size(); }
  
  void get_val_vec(std::vector<float> & vec, utilities::D_TYPE type);

  std::vector<particle*>::iterator begin(){
    return contents_.begin();
  }
  std::vector<particle*>::const_iterator begin()const{
    return contents_.begin();
  }
  std::vector<particle*>::iterator end(){
    return contents_.end();
  }

  /*
     Returns a pointer to a new list of the pa rticle_track* pointers
     for dealing with tracking.  This always returns a valid pointer
     to a list.  If the box is empty then a pointer to an empty list
     is returned.  This function allocates heap that needs to be cleaned
     up!
   */
  //  std::list<par ticle_track*>* box_to_list() const;

  /*
     A safer version of converting a hash_box to a list
   */
  //void  box_to_list(std::list<part icle_track*>& p_list) const;
  void  box_to_list(std::list<particle*>& p_list) const;
  
  //lots more of these along different components, likely reason to extend
  //these critters, however I haven't decided the most effective method of
  //returning this data, and it may very well depend on exactly what I am going
  //to do with it because I haven't addressed how to handle the IPP
  //junk

  
  

  void pass_fun_to_part(void(particle::*fun)());
  void pass_fun_to_part(void(particle::*fun)()const)const;

  void output_to_wrapper(utilities::Wrapper_out & wrapper) const;

    
  void compute_corr(tracking::Corr &) const ;

  void compute_accum(Accumulator & in)const;
  
};
}
#endif

  //random ideas
  /*
    Implement a g(r) struct that will hold the the count and r for
    each bin
   */