herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
exsample::cell Class Reference

the general cell class More...

#include <cell.h>

Public Member Functions

 cell ()
 default constructor
 
 cell (const std::vector< double > &ll, const std::vector< double > &ur, const adaption_info &ainfo)
 construct from boundaries and adaption info
 
 cell (const std::vector< double > &ll, const std::vector< double > &ur, const std::vector< bool > &sampled_variables, const adaption_info &ainfo)
 construct from boundaries, flags for variables to be sampled, and adaption info
 
 cell (const cell &x)
 copy constructor
 
celloperator= (const cell &x)
 assignment
 
template<class Random , class Function >
std::pair< cell, cellsplit (std::pair< std::size_t, double > split_d, Random &rnd_gen, Function *f, const adaption_info &ainfo, const std::vector< bool > &sampled=std::vector< bool >())
 split this cell, exploring the child not containing the current overestimate
 
std::size_t split_dimension () const
 return the split dimension
 
double split_point () const
 return the split value
 
double integral () const
 return the integral
 
double & integral ()
 access the integral
 
void integral (double v)
 set the integral
 
int & missing_events ()
 access the number of missing events
 
int missing_events () const
 return the number of missing events
 
void missing_events (int n)
 set the number of missing events
 
cell_infoinfo ()
 access the cell_info object
 
const cell_infoinfo () const
 return the cell_info object
 
template<class OStream >
void put (OStream &os) const
 put to ostream
 
template<class IStream >
void get (IStream &is)
 get from istream
 

Private Attributes

std::size_t split_dimension_
 the dimension along this cell was split
 
double split_point_
 the value, where this cell was split
 
double integral_
 the integral of the absolute value of the overestimate over all the children cells
 
int missing_events_
 the number of missing events in this cell
 
std::unique_ptr< cell_infocell_info_
 a pointer to the cell info object, if this is a leaf cell
 

Detailed Description

the general cell class

Definition at line 197 of file cell.h.

Member Function Documentation

◆ info() [1/2]

cell_info & exsample::cell::info ( )
inline

access the cell_info object

Definition at line 261 of file cell.h.

References cell_info_.

Referenced by exsample::parametric_missing_accessor::get().

◆ info() [2/2]

const cell_info & exsample::cell::info ( ) const
inline

return the cell_info object

Definition at line 264 of file cell.h.

References cell_info_.

◆ integral() [1/3]

double & exsample::cell::integral ( )
inline

access the integral

Definition at line 246 of file cell.h.

References integral_.

◆ integral() [2/3]

double exsample::cell::integral ( ) const
inline

return the integral

Definition at line 243 of file cell.h.

References integral_.

Referenced by exsample::integral_accessor::get(), and exsample::integral_accessor::set().

◆ integral() [3/3]

void exsample::cell::integral ( double  v)
inline

set the integral

Definition at line 249 of file cell.h.

References integral_, and v.

◆ missing_events() [1/3]

int & exsample::cell::missing_events ( )
inline

◆ missing_events() [2/3]

int exsample::cell::missing_events ( ) const
inline

return the number of missing events

Definition at line 255 of file cell.h.

References missing_events_.

◆ missing_events() [3/3]

void exsample::cell::missing_events ( int  n)
inline

set the number of missing events

Definition at line 258 of file cell.h.

References missing_events_.

◆ split_dimension()

std::size_t exsample::cell::split_dimension ( ) const
inline

return the split dimension

Definition at line 237 of file cell.h.

References split_dimension_.

◆ split_point()

double exsample::cell::split_point ( ) const
inline

return the split value

Definition at line 240 of file cell.h.

References split_point_.

Member Data Documentation

◆ cell_info_

std::unique_ptr<cell_info> exsample::cell::cell_info_
private

a pointer to the cell info object, if this is a leaf cell

Definition at line 295 of file cell.h.

Referenced by info().

◆ integral_

double exsample::cell::integral_
private

the integral of the absolute value of the overestimate over all the children cells

Definition at line 288 of file cell.h.

Referenced by integral().

◆ missing_events_

int exsample::cell::missing_events_
private

the number of missing events in this cell

Definition at line 291 of file cell.h.

Referenced by missing_events().

◆ split_dimension_

std::size_t exsample::cell::split_dimension_
private

the dimension along this cell was split

Definition at line 280 of file cell.h.

Referenced by split_dimension().

◆ split_point_

double exsample::cell::split_point_
private

the value, where this cell was split

Definition at line 283 of file cell.h.

Referenced by split_point().


The documentation for this class was generated from the following file: